再次深入 C# Attribute

• 了解attribute

Attribute 只是將一些附加信息與某個目標元素關聯起來的方式。

Attribute 是一個類，這個類可以提供一些字段和屬性，不應提供公共方法，事件等。在定義attribute類的構造方法，字段和屬性時，對數據類型有嚴格的要求，一般要求為： Boolean, Char, Byte, Sbyte, Int16, UInt16, Int32, Int64,Single, Double, String, Type, Object, Enum, 可以使用數組，但是並不提倡使用。

 

• 使用attribute

[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, Inherited = false)]
    [Conditional("Specify")]
    public class DisplayNameAttribute : Attribute
    {
        public string PropertyName { get; set; }

        public DisplayNameAttribute()
        { }

        public DisplayNameAttribute(string propertyName)
        {
            this.PropertyName = propertyName;
        }
    }

 

 

• 檢測attribute

1.  attribute定義和應用之后還沒有任何意義，只有在運行的時候去檢測，然后根據對應的attribute做一些不同事情才讓attribute變得有意義，那么如何檢測attribute呢？

方法名稱	說明
IsDefined	如果至少有一個指定的Attribute派生類的實例與目標關聯，就返回true。這個方法效率很高，因為他不構造（反序列化）attribute類的任何實例
GetCustomAttributes	返回一個數組，其中每個元素都是應用於目標的指定attribute類的一個實例。 如果不為這個方法指定具體的attribute類，數組中包含的就是已應用的所有attribute的實例，不管他們是什么類。每個實例都使用編譯時指定的參數、字段和屬性來構造（反序列化）。如果目標沒有應用任何attribute類的實例，就返回一個空數組。該方法通常用於已將AllowMultiple 設為true的attribute
GetCustomAttribute	返回應用於目標的指定attribute類的一個實例。實例使用編譯是指定的參數、字段和屬性來構造（反序列化）。如果目標沒有應用任何attribute類的實例，就返回null。如果目標應用了制定attribute的多個實例，拋出異常AmbiguousMatchException. 因此該方法通常用於AllowMultiple=false的attribute

　　　　 最后的例子中展示了如何使用這些方法。

2.   上面的方法在檢測時進行了attribute對象的構造（需要反序列化），這樣有可能調用set訪問器和構造方法，可能出現安全風險（未知代碼在AppDomain中運行）。因此可以使用CustomAttributeData類中定的靜態方法進行檢測

public override string ToString()
        {
            //在子類中對父類中的方法進行重寫，使用不創建attribute對象不執行代碼（反序列化）的方法
            StringBuilder value = new StringBuilder();
            if (!this.GetType().IsClass)
                return value.ToString();
            PropertyInfo[] properties = this.GetType().GetProperties();

            foreach (var property in properties)
            {
                string propertyName = property.Name;
                IList<CustomAttributeData> list = CustomAttributeData.GetCustomAttributes(property);
                foreach (var item in list)
                {
                    if (item.Constructor.DeclaringType == typeof(DisplayNameAttribute))
                    {
                        Console.Write("This property applies DisplayNameAttribute.");
                    }
                }
            }
            return base.ToString();
        }

 

 

• 條件attribute

應用attribute時生成元數據，如果想讓attribute在編譯是不生成元數據可以使用條件編譯，下面是例子

#define Specify
//#define UnSpecify

namespace Attribute
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using System.Reflection;
    using System.Diagnostics;

    public class Pepople
    {
        [DisplayName("姓名")]
        [TestDemoAttribute]
        public string Name { get; set; }
     }

    public class Man : Pepople
    {
        [DisplayName("年齡")]
        public int Age { get; set; }

        public float Height { get; set; }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, Inherited = false)]
    [Conditional("Specify")]
    public class DisplayNameAttribute : Attribute
    {
        public string PropertyName { get; set; }

        public DisplayNameAttribute()
        { }

        public DisplayNameAttribute(string propertyName)
        {
            this.PropertyName = propertyName;
        }
    }

    [Conditional("UnSpecify")]
    public class TestDemoAttribute : Attribute
    { }
}
條件attribute

 注意：贅述一句，在C#中進行預定義時，必須在文件在最前面

 我們用ildasm查看元數據得知，TestDemoAttribute 沒有被編譯成員數據，而DisplayNameAttribute被編譯成了元數據

 

• 實例

對上面提到的知識寫了個例子，以便加強知識的理解運用。

#define Specify
//#define UnSpecify

namespace Attribute
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using System.Reflection;
    using System.Diagnostics;

    public class Pepople
    {
        [DisplayName("姓名")]
        [TestDemoAttribute]
        public string Name { get; set; }

        public override string ToString()
        {
            StringBuilder value = new StringBuilder();
            if (!this.GetType().IsClass)
                return value.ToString();
            PropertyInfo[] properties = this.GetType().GetProperties();

            foreach (var property in properties)
            {
                string propertyName = property.Name;
                if (property.IsDefined(typeof(DisplayNameAttribute), false))
                {
                    DisplayNameAttribute attr = (DisplayNameAttribute)Attribute.GetCustomAttribute(property, typeof(DisplayNameAttribute));
                    if (attr != null)
                    {
                        propertyName = attr.PropertyName;
                    }
                }
                value.Append(propertyName);
                value.Append("\t");
                value.Append(property.GetValue(this, null));
                value.Append("\n\r");
            }

            return value.ToString();
        }
    }

    public class Man : Pepople
    {
        [DisplayName("年齡")]
        public int Age { get; set; }

        public float Height { get; set; }
    }

    public static class OutputerClass
    {
        public static string StringClass(object obj)
        {
            StringBuilder value = new StringBuilder();
            if (!obj.GetType().IsClass)
                return value.ToString();
            PropertyInfo[] properties = obj.GetType().GetProperties();

            foreach (var property in properties)
            {
                DisplayNameAttribute attr = (DisplayNameAttribute)Attribute.GetCustomAttribute(property, typeof(DisplayNameAttribute));
                if (attr != null)
                {
                    value.Append(attr.PropertyName);
                    value.Append("\t");
                    value.Append(property.GetValue(obj, null));
                    value.Append("\n\r");
                }
            }

            return value.ToString();
        }
    }

    //可以用attributeUsage聲明屬性應用的范圍，可以多選，多選的時候|運算即可
    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, Inherited = false)]
    [Conditional("Specify")]
    public class DisplayNameAttribute : Attribute
    {
        public string PropertyName { get; set; }

        public DisplayNameAttribute()
        { }

        public DisplayNameAttribute(string propertyName)
        {
            this.PropertyName = propertyName;
        }
    }

    [Conditional("UnSpecify")]
    public class TestDemoAttribute : Attribute
    { }
}