`Type.GetProperties` 属性顺序

Question

简短版本

Type.GetProperties 的 MSDN 文档 声明它返回的集合不保证按字母顺序或声明顺序排列，尽管运行一个简单的测试表明通常它是按声明顺序返回的。您是否知道有哪些具体情况并非如此？除此之外，建议的替代方案是什么？

详细版本

我了解Type的MSDN文档.GetProperties 指出：

GetProperties 方法不返回特定属性 顺序，例如字母顺序或声明顺序。你的代码一定不能 取决于返回属性的顺序，因为 顺序各不相同。

因此不能保证该方法返回的集合将以任何特定方式排序。根据一些测试，我发现相反，返回的属性按照它们在类型中定义的顺序出现。

示例：

class Simple
{
    public int FieldB { get; set; }
    public string FieldA { get; set; }
    public byte FieldC { get; set; }
}
class Program
{
    static void Main(string[] args)
    {
        Console.WriteLine("Simple Properties:");
        foreach (var propInfo in typeof(Simple).GetProperties())
            Console.WriteLine("\t{0}", propInfo.Name);
    }
}

输出：

Simple Properties:
        FieldB
        FieldA
        FieldC

一种仅略有不同的情况是，当相关类型的父级也具有属性时：

class Parent
{
    public int ParentFieldB { get; set; }
    public string ParentFieldA { get; set; }
    public byte ParentFieldC { get; set; }
}

class Child : Parent
{
    public int ChildFieldB { get; set; }
    public string ChildFieldA { get; set; }
    public byte ChildFieldC { get; set; }
}

class Program
{
    static void Main(string[] args)
    {
        Console.WriteLine("Parent Properties:");
        foreach (var propInfo in typeof(Parent).GetProperties())
            Console.WriteLine("\t{0}", propInfo.Name);

        Console.WriteLine("Child Properties:");
        foreach (var propInfo in typeof(Child).GetProperties())
            Console.WriteLine("\t{0}", propInfo.Name);

    }
}

输出：

Parent Properties:
        ParentFieldB
        ParentFieldA
        ParentFieldC
Child Properties:
        ChildFieldB
        ChildFieldA
        ChildFieldC
        ParentFieldB
        ParentFieldA
        ParentFieldC

这意味着 GetProperties 方法在发现时自下而上沿着继承链向上走的属性。这很好，可以这样处理。

问题：

1. 是否存在我所错过的所描述的行为有所不同的特定情况？
2. 如果不建议依赖于顺序，那么推荐的方法是什么？？

一种看似显而易见的解决方案是定义一个自定义属性，该属性指示属性应该出现的顺序（类似于DataMember上的Order属性> 属性）。类似于：

public class PropOrderAttribute : Attribute
{
    public int SeqNbr { get; set; }
}

然后实现诸如：

class Simple
{
    [PropOrder(SeqNbr = 0)]
    public int FieldB { get; set; }
    [PropOrder(SeqNbr = 1)]
    public string FieldA { get; set; }
    [PropOrder(SeqNbr = 2)]
    public byte FieldC { get; set; }
}

但正如许多人发现的那样，如果您的类型有 100 个属性并且您需要在前 2 个属性之间添加一个属性，这将成为一个严重的维护问题。

更新

此处显示的示例仅用于演示目的。在我的特定场景中，我使用类定义消息格式，然后迭代该类的属性并获取它们的属性以查看应如何对消息中的特定字段进行解组。消息中字段的顺序很重要，因此我的类中属性的顺序也必须很重要。

目前，它仅通过迭代 GetProperties 的返回集合来工作，但由于文档声明不建议这样做，所以我想了解为什么以及我还有什么其他选择？

Answer 1

根本无法保证订单；无论发生什么......都会发生。

它可能会改变的明显情况：

• 任何实现 ICustomTypeDescriptor 的
• 任何内容，或者带有 TypeDescriptionProvider 的任何内容

，但更微妙的情况是：部分类。如果一个类分为多个文件，则根本没有定义它们的使用顺序。请参阅跨部分类的“文本顺序”是否正式定义？< /a>

当然，即使是单个（非部分）定义也没有定义；p

但是想象一下

File 1

partial class Foo {
     public int A {get;set;}
}

File 2

partial class Foo {
    public int B {get;set:}
}

A 和 B 之间没有正式的声明顺序。请参阅链接的帖子以了解它是如何实现的不过，往往会发生。

---

重新编辑；最好的方法是单独指定元帅信息；一种常见的方法是使用采用数字顺序的自定义属性，并用它来装饰成员。然后您可以根据这个数字进行订购。 protobuf-net 做了非常相似的事情，坦率地说，我建议在这里使用现有的序列化库：

[ProtoMember(n)]
public int Foo {get;set;}

其中“n”是一个整数。特别是在 protobuf-net 的情况下，还有一个 API 可以单独指定这些数字，这在类型不受您直接控制时非常有用。

Answer 2

就其价值而言，按 MetadataToken 排序似乎对我有用。

GetType().GetProperties().OrderBy(x => x.MetadataToken)

原始文章（链接已损坏，仅在此处列出以供归属）：
http://www.sebastienmahe.com/v3/seb.blog/2010/03/08/c-reflection-getproperties-kept-in-declaration-order/

Answer 3

我使用自定义属性自己添加必要的元数据（它与类似 REST 的服务一起使用，该服务使用并返回 CRLF 分隔的 Key=Value 对。

首先，自定义属性：

class ParameterOrderAttribute : Attribute
{
    public int Order { get; private set; }
    public ParameterOrderAttribute(int order)
    {
        Order = order;
    }
}

然后，装饰您的类：

class Response : Message
{
    [ParameterOrder(0)]
    public int Code { get; set; }
}

class RegionsResponse : Response 
{
    [ParameterOrder(1)]
    public string Regions { get; set; }
}

class HousesResponse : Response
{
    public string Houses { get; set; }
}

将 PropertyInfo 转换为sortable int：

    private int PropertyOrder(PropertyInfo propInfo)
    {
        int output;
        var orderAttr = (ParameterOrderAttribute)propInfo.GetCustomAttributes(typeof(ParameterOrderAttribute), true).SingleOrDefault();
        output = orderAttr != null ? orderAttr.Order : Int32.MaxValue;
        return output;
    }

更好的是，write 是一个扩展：

static class PropertyInfoExtensions
{
    private static int PropertyOrder(this PropertyInfo propInfo)
    {
        int output;
        var orderAttr = (ParameterOrderAttribute)propInfo.GetCustomAttributes(typeof(ParameterOrderAttribute), true).SingleOrDefault();
        output = orderAttr != null ? orderAttr.Order : Int32.MaxValue;
        return output;
    }
}

最后，您现在可以使用以下方式查询您的 Type 对象：

        var props = from p in type.GetProperties()
                    where p.CanWrite
                    orderby p.PropertyOrder() ascending
                    select p;

Answer 4

1：

我花了最后一天时间对 MVC 3 项目中的一个问题进行故障排除，这一切都归结为这个特定问题。它基本上依赖于整个会话期间属性顺序相同，但在某些情况下，一些属性交换了位置，从而弄乱了站点。

首先，调用 Type.GetProperties() 的代码在动态 jqGrid 表中定义列名称，在本例中，每个 page_load 都会发生一次。随后调用 Type.GetProperties() 方法是为了填充表的实际数据，在极少数情况下，属性会交换位置并完全搞乱了演示。在某些情况下，站点依赖于分层子网格的其他属性被切换，即您无法再看到子数据，因为 ID 列包含错误数据。换句话说：是的，这肯定会发生。提防。

2：

如果您需要整个系统会话的顺序一致，但所有会话的顺序不一定完全相同，解决方法非常简单：存储PropertyInfo[]< /code> 数组，您从 Type.GetProperties() 获取，作为网络缓存中或以类型（或类型名称）作为缓存/字典键的字典中的值。随后，每当您要执行 Type.GetProperties() 时，请将其替换为 HttpRuntime.Cache.Get(Type/Typename) 或 Dictionary。 TryGetValue(类型/类型名称，out PropertyInfo[])。这样，您就可以保证始终收到您第一次遇到的订单。

如果您总是需要相同的顺序（即对于所有系统会话），我建议您将上述方法与某种类型的配置机制结合起来，即在 web.config/app.config 中指定顺序，对 PropertyInfo[] 进行排序 你按照指定的顺序从Type.GetProperties()获取的数组，然后将其存储在缓存/静态字典中。

Answer 5

依赖明确记录为无法保证的实现细节会导致灾难。

“推荐的方法”会根据您拥有这些属性后想要对它们执行的操作而有所不同。只是将它们显示在屏幕上？ MSDN 文档按成员类型（属性、字段、函数）进行分组，然后在组内按字母顺序排列。

如果您的消息格式依赖于字段的顺序，那么您需要：

1. 在某种消息定义中指定预期的顺序。如果我记得的话，Google 协议缓冲区就是这样工作的 - 在这种情况下，消息定义是从.proto 文件转换为代码文件，以便在您使用的任何语言中使用。

2. 依赖于可以独立生成的顺序，例如字母顺序。