一.什么是Attribute
先看下面的三段代碼:
1.自定義Attribute類(lèi):VersionAttribute
- [AttributeUsage(AttributeTargets.Class)]
- public class VersionAttribute : Attribute
- {
- public string Name { get; set; }
- public string Date { get; set; }
- public string Describtion { get; set; }
- }
2.使用自定義Attribute的Class:
- [Version(Name = "hyddd", Date = "2009-07-20", Describtion = "hyddd's class")]
- public class MyCode
- {
- //...
- }
3.上面這個(gè)Class中的Attribute一般會(huì )被如何使用呢?
- class Program
- {
- static void Main(string[] args)
- {
- var info = typeof(MyCode);
- var classAttribute = (VersionAttribute)Attribute.GetCustomAttribute(info, typeof(VersionAttribute));
- Console.WriteLine(classAttribute.Name);
- Console.WriteLine(classAttribute.Date);
- Console.WriteLine(classAttribute.Describtion);
- }
- }
示例完畢!上面三段代碼相信已經(jīng)說(shuō)明了Attribute大概是一個(gè)什么東西和怎么去用。
二.深入討論Attribute
1.Attribute的概念定義
關(guān)于A(yíng)ttribute概念的定義,我直接引用《你必須知道的.NET之特性和屬性》中的一段來(lái)說(shuō)明:
MADN的定義為:公共語(yǔ)言運行時(shí)允許添加類(lèi)似關(guān)鍵字的描述聲明,叫做attributes, 它對程序中的元素進(jìn)行標注,如類(lèi)型、字段、方法和屬性等。Attributes和Microsoft .NET Framework文件的元數據(metadata)保存在一起,可以用來(lái)向運行時(shí)描述你的代碼,或者在程序運行的時(shí)候影響應用程序的行為。
我們簡(jiǎn)單的總結為:定制特性attribute,本質(zhì)上是一個(gè)類(lèi),其為目標元素提供關(guān)聯(lián)附加信息,并在運行期以反射的方式來(lái)獲取附加信息。
噢,原來(lái)Attribute的目的是為元素提供關(guān)聯(lián)附加信息。其中,上面第一段代碼中“[AttributeUsage(AttributeTargets.Class)] ”說(shuō)明了Attribute提供附加信息的元素是Class,所以如果上面第二段的代碼改為:
- public class MyCode
- {
- [Version(Name = "hyddd", Date = "2009-07-20", Describtion = "hyddd's class")]
- public void Test() { }
- }
會(huì )出現編譯錯誤。
2.Attribute作為編譯指令
Attribute類(lèi)是在編譯的時(shí)候被實(shí)例化的,而不是像通常的類(lèi)那樣在運行時(shí)候才實(shí)例化。所以在第三段代碼中,你可以在沒(méi)有實(shí)例化MyCode對象的情況下取到MyCode的Attribute信息。由于A(yíng)ttribute類(lèi)是在編譯的時(shí)候被實(shí)例化的,所以你還可以用外部工具維護這些Attribute信息。
3.Attribute與Property
從中文來(lái)說(shuō),Attribute和Property的中文都叫“屬性”,很容易讓人混淆?,F在的文章,Attribute一般翻譯為”特性”,而Property稱(chēng)為“屬性”。
或許你會(huì )問(wèn),我用靜態(tài)的Property/Field一樣可以做到在不實(shí)例化的時(shí)候拿到一些信息,如果這樣的話(huà),Attribute又有什么存在意義呢?
1.Property:
Property可以說(shuō)是一個(gè)面向對象的概念,提供了對私有字段的訪(fǎng)問(wèn)封裝,在C#中以get和set訪(fǎng)問(wèn)器方法實(shí)現對可讀可寫(xiě)屬性的操作,提供了安全和靈活的數據訪(fǎng)問(wèn)封裝。比如:
- public class Robot
- {
- private string name = ""; //字段:Field
- public string Name //屬性:Property,對Field進(jìn)行封裝。
- {
- get { return name; }
- set { name = value; }
- }
- }
2.Attribute:
Attribute的目標是:為元素提供附加信息。它的作用更類(lèi)似于注釋。
可以說(shuō),Property/Field和Attribute是兩個(gè)完全不同的概念,雖然他們有些時(shí)候能做一樣的事,但請記住,他們是從本質(zhì)上就不同的兩個(gè)東西。
三.實(shí)現自己的Attribute時(shí)需要注意的一些問(wèn)題
1.自定義的Attribute必須直接或者間接繼承System.Attribute。
2.這里有一個(gè)約定:所有自定義的特性名稱(chēng)都應該有個(gè)Attribute后綴。因為當你的Attribute施加到一個(gè)程序的元素上的時(shí)候,編譯器先查找你的Attribute的定義,如果沒(méi)有找到,那么它就會(huì )查找“Attribute名稱(chēng)"+Attribute的定義。如果都沒(méi)有找到,那么編譯器就報錯。這就是為什么我可以再上面第一段代碼中,定義一個(gè)VersionAttribute,但在第二段代碼中,我使用卻是Version這個(gè)Attribute。:>
下面是一些開(kāi)發(fā)自定義Attribute時(shí),可能需要用到的資料:
【1】Attribute可以關(guān)聯(lián)的元素包括:
程序集(assembly)、模塊(module)、類(lèi)型(type)、屬性(property)、事件(event)、字段(field)、方法(method)、參數(param)、返回值(return)。例如:
- [assembly: Version(Name = "hyddd", Date = "2009-07-20", Describtion = "hyddd's class")]
- public class MyCode
- {
- //......
- }
用指定的前綴來(lái)表示特性所應用的目標元素,建議這樣來(lái)處理,因為顯式處理可以消除可能帶來(lái)的二義性。
【2】AttributeTargets目標包括:
【3】AttributeUsageAttribute中的3個(gè)屬性(Property)說(shuō)明:
四.參考資料
【1】Msdn
【2】《你必須知道的.NET之特性和屬性》,博主嚴重推薦!
【3】《Attribute在.net編程中的應用》系列文章
聯(lián)系客服