在给定支持字段的情况下获取C#auto属性的PropertyInfo

时间:2011-12-02 19:51:17

标签: c# c#-3.0

我正在实现一个自定义IFormatter,将对象序列化为我们的遗留系统所需的自定义格式。

如果我声明一个C#auto属性:

[StringLength(15)]
public MyProperty { get; set; }

然后在我的自定义序列化方法中,我通过以下方式获取序列化字段:

MemberInfo[] members = 
    FormatterServices.GetSerializableMembers(graph.GetType(), Context);

如何访问装饰auto属性的StringLength属性?

我目前正在利用<PropertyName>k_backingfield命名约定获取属性信息。我宁愿不依赖它,因为它似乎是C#编译器实现的具体细节。还有更好的方法吗?

1 个答案:

答案 0 :(得分:4)

更好的方法是停止依赖私有字段进行序列化(如FormatterServices.GetSerializableMembers返回)并仅使用公共属性。

这是一个 LOT 清洁工,适用于这种特殊情况。

但由于遗留代码,您可能希望继续使用FormatterServices.GetSerializableMembers,在这种情况下,除了使用命名约定(或一点IL分析)之外,没有其他选项可供选择可能会破坏每个新的编译器版本。

只是为了好玩,这里有一些代码可以做一些IL分析(它缺少NOOP和其他细节但是应该适用于大多数当前的编译器。如果你真的采用这样的解决方案,请检查Cecil库(由Jb Evain编写,因为它包含一个完整的反编译器,它比手工操作更好。

它的用法是这样的:

void Main()
{
    var members = FormatterServices.GetSerializableMembers(typeof(Foo));
    var propertyFieldAssoc = new PropertyFieldAssociation(typeof(Foo));

    foreach(var member in members)
    {
        var attributes = member.GetCustomAttributes(false).ToList();
        if (member is FieldInfo)
        {
            var property = propertyFieldAssoc.GetProperty((FieldInfo)member);
            if (property != null)
            {
                attributes.AddRange(property.GetCustomAttributes(false));
            }
        }

        Console.WriteLine(member.Name);
        foreach(var attribute in attributes)
        {
            Console.WriteLine(" * {0}", attribute.GetType().FullName);
        }
        Console.WriteLine();
    }
}

代码:

class PropertyFieldAssociation
{
    const byte LDARG_0 = 0x2;
    const byte LDARG_1 = 0x3;
    const byte STFLD = 0x7D;
    const byte LDFLD = 0x7B;
    const byte RET = 0x2A;

    static FieldInfo GetFieldFromGetMethod(MethodInfo getMethod)
    {
        if (getMethod == null) throw new ArgumentNullException("getMethod");

        var body = getMethod.GetMethodBody();
        if (body.LocalVariables.Count > 0) return null;
        var il = body.GetILAsByteArray();
        if (il.Length != 7) return null;

        var ilStream = new BinaryReader(new MemoryStream(il));

        if (ilStream.ReadByte() != LDARG_0) return null;
        if (ilStream.ReadByte() != LDFLD) return null;
        var fieldToken = ilStream.ReadInt32();
        var field = getMethod.Module.ResolveField(fieldToken);
        if (ilStream.ReadByte() != RET) return null;

        return field;
    }

    static FieldInfo GetFieldFromSetMethod(MethodInfo setMethod)
    {
        if (setMethod == null) throw new ArgumentNullException("setMethod");

        var body = setMethod.GetMethodBody();
        if (body.LocalVariables.Count > 0) return null;
        var il = body.GetILAsByteArray();
        if (il.Length != 8) return null;

        var ilStream = new BinaryReader(new MemoryStream(il));

        if (ilStream.ReadByte() != LDARG_0) return null;
        if (ilStream.ReadByte() != LDARG_1) return null;
        if (ilStream.ReadByte() != STFLD) return null;
        var fieldToken = ilStream.ReadInt32();
        var field = setMethod.Module.ResolveField(fieldToken);
        if (ilStream.ReadByte() != RET) return null;

        return field;
    }

    public static FieldInfo GetFieldFromProperty(PropertyInfo property)
    {
        if (property == null) throw new ArgumentNullException("property");

        var get = GetFieldFromGetMethod(property.GetGetMethod());
        var set = GetFieldFromSetMethod(property.GetSetMethod());

        if (get == set) return get;
        else return null;
    }

    Dictionary<PropertyInfo, FieldInfo> propertyToField = new Dictionary<PropertyInfo, FieldInfo>();
    Dictionary<FieldInfo, PropertyInfo> fieldToProperty = new Dictionary<FieldInfo, PropertyInfo>();

    public PropertyInfo GetProperty(FieldInfo field)
    {
        PropertyInfo result;
        fieldToProperty.TryGetValue(field, out result);
        return result;
    }

    public FieldInfo GetField(PropertyInfo property)
    {
        FieldInfo result;
        propertyToField.TryGetValue(property, out result);
        return result;
    }

    public PropertyFieldAssociation(Type t)
    {
        if (t == null) throw new ArgumentNullException("t");

        foreach(var property in t.GetProperties())
        {
            Add(property);
        }
    }

    void Add(PropertyInfo property)
    {
        if (property == null) throw new ArgumentNullException("property");

        var field = GetFieldFromProperty(property);
        if (field == null) return;
        propertyToField.Add(property, field);
        fieldToProperty.Add(field, property);
    }
}

class StringLengthAttribute : Attribute
{
    public StringLengthAttribute(int l)
    {
    }
}

[Serializable]
class Foo
{
    [StringLength(15)]
    public string MyProperty { get; set; }

    string myField;
    [StringLength(20)]
    public string OtherProperty { get { return myField; } set { myField = value; } }
}