在前面介紹的代碼中有使用特性，這些特性都是Microsoft定義好的，作為.NET Framework類庫的一部分，許多特性都得到了C#編譯器的支持。
.NET Frmework也允許定義自己的特性。自定義特性允許把自定義元數(shù)據(jù)與程序元素關(guān)聯(lián)起來。這些元數(shù)據(jù)是在編譯過程中創(chuàng)建的，并嵌入到程序集中。這些特性不會(huì)影響編譯過程，因?yàn)榫幾g器不能識(shí)別它們，但這些特性在應(yīng)用于程序元素時(shí)，可以在編譯好的程序集中用作元數(shù)據(jù)。這些元數(shù)據(jù)在文檔說明中很有用。使自定義特性起很大作用的是反射（http://chabaoo.cn/article/244259.htm）技術(shù)，代碼可以讀取這些元數(shù)據(jù)，使用它們?cè)谶\(yùn)行期間作決策。

編寫自定義特性

[FieldName("Social")]
        public string SocialNumber
        {
            ...
        }

當(dāng)C#編譯器發(fā)現(xiàn)SocialNumber屬性應(yīng)用了一個(gè)FieldName特性時(shí)，首先會(huì)把字符串Attribute追加到FieldName這個(gè)名稱后面，形成一個(gè)組合名稱FieldNameAttribute，然后在其搜索路徑的所有名稱空間（即在using語句中提及的名稱空間）中搜索FieldNameAttribute類。但如果該特性的名稱以字符串Attribute結(jié)尾，編譯器就不會(huì)把這個(gè)字符串加到組合名稱中。
因此上面的代碼等價(jià)于：

[FieldNameAttribute("Social")]
        public string SocialNumber
        {
            ...
        }

1.AttributeUsage特性

自定義的特性類需要直接或間接派生自System.Attribute。這個(gè)類還應(yīng)包含控制用法的信息：

• *特性可以應(yīng)用到哪些類型的程序元素上（類，結(jié)構(gòu)，屬性和方法等）
• *特性是否可以多次應(yīng)用到同一個(gè)程序元素上
• *特性在應(yīng)用到類或接口上時(shí)，是否由派生類和接口繼承
• *這個(gè)特性有哪些必選和可選參數(shù)

如果編譯器找不到對(duì)應(yīng)的特性類，或者找到一個(gè)這樣的特性類，但使用特性的方式與特性類中的信息不匹配，編譯器就會(huì)產(chǎn)生一個(gè)編譯錯(cuò)誤。
定義FieldNameAttribute特性

[AttributeUsage(AttributeTargets.Property, AllowMultiple=false, Inherited=false)]
        public class FieldNameAttribute:Attribute
        {
            private string name;
            public FieldNameAttribute(string name)
            {
                this.name = name;
            }
        }

特性類FieldNameAttribute本身用了一個(gè)特性System.AttributeUsage來標(biāo)記。這是Microsoft定義的一個(gè)特性，C#編譯器為它提供了特殊的支持。AttributeUsage主要用于標(biāo)識(shí)自定義特性可以應(yīng)用到哪些類型的程序元素上。這些信息由它的第一個(gè)參數(shù)AttributeTargets給出，該參數(shù)是必選的，其類型是枚舉類型AttributeTargets。上面的例子，指定FieldNameAttribute特性只能應(yīng)用到屬性上。
AttributeTargets枚舉的成員如下：

上面列出了可以應(yīng)用該特性的所有程序元素。在把特性應(yīng)用到程序元素上時(shí)，應(yīng)把特性放在元素前面的方括號(hào)中：

　　[FieldName("Social")]
　　public string SocialNumber
　　{
　　　　...
　　}

但在應(yīng)用到Assembly和Module時(shí)，特性可以應(yīng)用到整個(gè)程序集或模塊中，而不是應(yīng)用到代碼中的一個(gè)元素上，在這種情況下，這個(gè)特性可以放在源代碼的任何地方，但需要使用關(guān)鍵字Assembly和Module作為前綴：

　　[assembly:FieldName("Social")]
　　[module:FieldName("Social")]

在指定自定義特性的有效目標(biāo)元素時(shí)，可以使用OR運(yùn)算符（｜）把這些值組合起來：

　　[AttributeUsage(AttributeTargets.Property ｜AttributeTargets.Field,
　　　　AllowMultiple=false, Inherited=false)]
　　public class FieldNameAttribute:Attribute
　　{
　　　　private string name;
　　　　public FieldNameAttribute(string name)
　　　　{
　　　　　　this.name = name;
　　　　}
　　}

也可以使用AttributeTargets.All指定自定義特性可以應(yīng)用到所有類型的程序元素上。
AttributeUsage特性還包含另外兩個(gè)參數(shù)：AllowMultiple和Inherited。它們用不同的語法來指定：參數(shù)名 = 參數(shù)值，而不是只給出這些參數(shù)的值。這些參數(shù)是可選的。

• AllowMultiple參數(shù)表示一個(gè)特性是否可以多次應(yīng)用到同一項(xiàng)上。
• Inherited參數(shù)表示應(yīng)用到類或接口上的特性是否自動(dòng)應(yīng)用到所以派生的類或接口上。如果特性應(yīng)用到方法或?qū)傩陨?，它就自?dòng)應(yīng)用到它們的重寫版本上。

2.指定特性參數(shù)

　　[FieldName("Social")]
　　public string SocialNumber
　　{
　　　　...
　　}

編譯器會(huì)檢查傳遞給特性的參數(shù)（在本例中，是一個(gè)字符串），并產(chǎn)兆該特性類中帶這些參數(shù)的構(gòu)造函數(shù)。如果找到匹配的構(gòu)造函數(shù)，編譯器就會(huì)把指定的元數(shù)據(jù)傳遞給程序集。如果找不到，就會(huì)生成一個(gè)編譯錯(cuò)誤。反射（）會(huì)從程序集中讀取元數(shù)據(jù)，并實(shí)例化它們表示的特性類。因此，編譯器需要確保存在這樣的構(gòu)造函數(shù)，才能在運(yùn)行期間實(shí)例化指定的特性。

3.特性的可選參數(shù)

在AttributeUsage特性中，使用參數(shù)名 = 參數(shù)值語法把可選參數(shù)添加到特性中。這種語法指定可選參數(shù)的名稱和值，它通過特性類中的公共屬性或字段起作用：

[AttributeUsage(AttributeTargets.Property, AllowMultiple=false, Inherited=false)]
        public class FieldNameAttribute:Attribute
        {
            private string name;
            public FieldNameAttribute(string name)
            {
                this.name = name;
            }
            
            public string Comment
            {
                get;set;
            }
        }
        
        
        [FieldName("Social",Comment="可選參數(shù)值")]
        public string SocialNumber
        {
            ...
        }

到此這篇關(guān)于C#自定義特性(Attribute)的文章就介紹到這了。希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論