C# 特性（Attribute）詳細介紹

一、什麼是Atrribute
首先，咱們確定Attribute是一個類，下面是msdn文檔對它的描述：
公共語言運行時容許你添加相似關鍵字的描述聲明，叫作attributes, 它對程序中的元素進行標註，如類型、字段、方法和屬性等。Attributes和Microsoft .NET Framework文件的元數據保存在一塊兒，能夠用來向運行時描述你的代碼，或者在程序運行的時候影響應用程序的行爲。

在.NET中,Attribute被用來處理多種問題，好比序列化、程序的安全特徵、防止即時編譯器對程序代碼進行優化從而代碼容易調試等等。下面，咱們先來看幾個在.NET中標準的屬性的使用，稍後咱們再回過頭來討論Attribute這個類自己。（文中的代碼使用C#編寫，但一樣適用全部基於.NET的全部語言）

 

三、Attribute類
除了.NET提供的那些Attribute派生類以外，咱們能夠自定義咱們本身的Attribute，全部自定義的Attribute必須從Attribute類派生。如今咱們來看一下Attribute 類的細節：

protected Attribute(): 保護的構造器，只能被Attribute的派生類調用。

三個靜態方法：

static Attribute GetCustomAttribute():這個方法有8種重載的版本，它被用來取出施加在類成員上指定類型的Attribute。

static Attribute[] GetCustomAttributes(): 這個方法有16種重載版本，用來取出施加在類成員上指定類型的Attribute數組。

static bool IsDefined():由八種重載版本，看是否指定類型的定製attribute被施加到類的成員上面。

 

實例方法：

bool IsDefaultAttribute(): 若是Attribute的值是默認的值，那麼返回true。

bool Match():代表這個Attribute實例是否等於一個指定的對象。

 

公共屬性： TypeId: 獲得一個惟一的標識，這個標識被用來區分同一個Attribute的不一樣實例。

咱們簡單地介紹了Attribute類的方法和屬性，還有一些是從object繼承來的。這裏就不列出來了。

下面介紹如何自定義一個Attribute: 自定義一個Attribute並不須要特別的知識，其實就和編寫一個類差很少。自定義的Attribute必須直接或者間接地從Attribute這個類派生，如：

public MyCustomAttribute : Attribute { ... }

這裏須要指出的是Attribute的命名規範，也就是你的Attribute的類名+"Attribute",當你的Attribute施加到一個程序的元素上的時候，編譯器先查找你的Attribute的定義，若是沒有找到，那麼它就會查找「Attribute名稱"+Attribute的定義。若是都沒有找到，那麼編譯器就報錯。

 

四、定義或控制特性的使用

對於一個自定義的Attribute，你能夠經過AttributeUsage的Attribute來限定你的Attribute 所施加的元素的類型。代碼形式以下：
[AttriubteUsage(參數設置)] public 自定義Attribute : Attribute { ... }

 

做爲參數的AttributeTarges的值容許經過「或」操做來進行多個值得組合，若是你沒有指定參數，那麼默認參數就是All 。 AttributeUsage除了繼承Attribute 的方法和屬性以外，還定義瞭如下三個屬性：

AllowMultiple: 讀取或者設置這個屬性，表示是否能夠對一個程序元素施加多個Attribute 。

Inherited:讀取或者設置這個屬性，表示是否施加的Attribute 能夠被派生類繼承或者重載。

ValidOn: 讀取或者設置這個屬性，指明Attribute 能夠被施加的元素的類型。

 

下面讓咱們來作一些實際的東西。咱們將會在Help特性前放置AttributeUsage特性以期待在它的幫助下控制Help特性的使用。

隱藏行號 複製代碼 ？ 這是一段程序代碼。

1. [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
   

2. public class HelpAttribute : Attribute
   

3. {
   

4.     public HelpAttribute(String Description_in)
   

5.     {
   

6.         this.description = Description_in;
   

7.     }
   

9.     protected String description;
   

11.     public String Description
    

12.     {
    

13.         get
    

14. {
    

15.             return this.description;
    

16.         }
    

17.     }
    

18. }
    

 

 

代碼討論

• 屬性 AttributeUsage 指定該屬性能夠應用於的語言元素。
• 屬性類是從 System.Attribute 派生的公共類，至少有一個公共構造函數。
• 屬性類有兩種類型的參數：
  •       「定位參數」，每次使用屬性時都必須指定這些參數。定位參數被指定爲屬性類的構造函數參數。在上面的示例中，url 即是一個定位參數。
  •      「命名參數」，可選。若是使用屬性時指定了命名參數，則必須使用參數的名稱。經過包含非靜態字段或屬性來定義命名參數。在上面的示例中，Topic 即是一個命名參數。

 

先讓咱們來看一下AttributeTargets.Class。它規定了Help特性只能被放在class的前面。這也就意味着下面的代碼將會產生錯誤：

隱藏行號 複製代碼 ？ 這是一段程序代碼。

1. [Help("this is a do-nothing class")]
   

2. public class AnyClass
   

3. {
   

4.     [Help("this is a do-nothing method")] //error 
   

5. public void AnyMethod()
   

6.     {
   

7.     }
   

8. }
   

 

 

 

編譯器報告錯誤以下：

AnyClass.cs: Attribute 'Help' is not valid on this declaration type.

It is valid on 'class' declarations only.

咱們可使用AttributeTargets.All來容許Help特性被放置在任何程序實體前。可能的值是：

Assembly,Module,Class,Struct,Enum,Constructor,Method,Property,Field,Event,Interface,
Parameter,Delegate。

All = Assembly | Module | Class | Struct | Enum | Constructor | Method | Property | Field | Event | Interface | Parameter | Delegate,

ClassMembers = Class | Struct | Enum | Constructor | Method | Property | Field | Event | Delegate | Interface )

下面考慮一下AllowMultiple = false。它規定了特性不能被重複放置屢次。

隱藏行號 複製代碼 ？ 這是一段程序代碼。

1. [Help("this is a do-nothing class")]
   

2. [Help("it contains a do-nothing method")]
   

3. public class AnyClass
   

4. {
   

5.     [Help("this is a do-nothing method")] //error 
   

6. public void AnyMethod()
   

7.     {
   

8.     }
   

9. }
   

 

 

它產生了一個編譯期錯誤。

AnyClass.cs: Duplicate 'Help' attribute

Ok,如今咱們來討論一下最後的這個屬性。Inherited, 代表當特性被放置在一個基類上時，它可否被派生類所繼承。

隱藏行號 複製代碼 ？ 這是一段程序代碼。

1. [Help("BaseClass")]
   

2. public class Base
   

3. {
   

4. }
   

6. public class Derive : Base
   

7. {
   

8. }
   

 

 

 

 

這裏會有四種可能的組合：

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false ]

[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false ]

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true ]

[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true ]

第一種狀況：

若是咱們查詢（Query）（稍後咱們會看到如何在運行期查詢一個類的特性）Derive類，咱們將會發現Help特性並不存在，由於inherited屬性被設置爲false。

第二種狀況：

和第一種狀況相同，由於inherited也被設置爲false。

第三種狀況：

爲了解釋第三種和第四種狀況，咱們先來給派生類添加點代碼：

隱藏行號 複製代碼 ？ 這是一段程序代碼。

1. [Help("BaseClass")]
   

2. public class Base
   

3. {
   

4. }
   

6. [Help("DeriveClass")]
   

7. public class Derive : Base
   

8. {
   

9. }
   

如今咱們來查詢一下Help特性，咱們只能獲得派生類的屬性，由於inherited被設置爲true，可是AllowMultiple卻被設置爲false。所以基類的Help特性被派生類Help特性覆蓋了。

第四種狀況：

在這裏，咱們將會發現派生類既有基類的Help特性，也有本身的Help特性，由於AllowMultiple被設置爲true。

• • 經過反射訪問屬性

屬性與程序元素關聯後，可使用反射查詢屬性存在及其值。查詢屬性的主要反射方法包含在 System.Reflection.MemberInfo 類（GetCustomAttributes 方法族）中。下面的示例演示使用反射獲取對屬性的訪問的基本方法：

隱藏行號 複製代碼 ？ 這是一段程序代碼。

1. System.Reflection.MemberInfo info = typeof(Help);
   

2. object[] attributes = info.GetCustomAttributes(true);
   

3. for (int i = 0; i < attributes.Length; i++)
   

4. {
   

5.     System.Console.WriteLine(attributes[i]);
   

6. }
   

 

做者： luckdv

本文系本人轉載博客園中的文章（略有修改），未能給出原文鏈接，若侵犯文章原做者的權益，請聯繫本人，本人將立刻刪除!

 

出處：http://www.cnblogs.com/luckdv/articles/Atrribute.html