C# 特性（Attribute）詳細介紹

轉自:http://www.cnblogs.com/luckboy/archive/2009/07/18/1526083.html

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

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

2、Attribute作爲編譯器的指令
在C#中存在着一定數量的編譯器指令，如：#define DEBUG, #undefine DEBUG, #if等。這些指令專屬於C#,而且在數量上是固定的。而Attribute用作編譯器指令則不受數量限制。比如下面的三個Attribute:

   Conditional：起條件編譯的作用，只有滿足條件，才允許編譯器對它的代碼進行編譯。一般在程序調試的時候使用。 
   DllImport：用來標記非.NET的函數，表明該方法在一個外部的DLL中定義。 
   Obsolete：這個屬性用來標記當前的方法已經被廢棄，不再使用了。
下面的代碼演示了上述三個屬性的使用：

 

 1#define DEBUG //這裏定義條件
 2    
 3using System;
 4using System.Runtime.InteropServices;
 5using System.Diagnostics;
 6    
 7namespace AttributeDemo
 8{
 9   class MainProgramClass
10   {
11 
12      [DllImport("User32.dll")]
13      public static extern int MessageBox(int hParent, string Message, string Caption, int Type);
14     
15      static void Main(string[] args)
16      {
17         DisplayRunningMessage();
18         DisplayDebugMessage();
19     
20         MessageBox(0,"Hello","Message",0);
21     
22         Console.ReadLine();
23      }
24     
25      [Conditional("DEBUG")]
26      private static void DisplayRunningMessage()
27      {
28         Console.WriteLine("開始運行Main子程序。當前時間是"+DateTime.Now);
29      }
30  
31      [Conditional("DEBUG")]
32      //[Obsolete("Don't use Old method, use New method", true)] 
33      [Obsolete]
34      private static void DisplayDebugMessage()
35      {
36         Console.WriteLine("開始Main子程序");
37      }
38   }
39}  

如果在一個程序元素前面聲明一個Attribute,那麼就表示這個Attribute被施加到該元素上，前面的代碼，[DllImport]施加到MessageBox函數上, [Conditional]施加到DisplayRuntimeMessage方法和DisplayDebugMessage方法，[Obsolete]施加到DisplayDebugMessage方法上。

根據上面涉及到的三個Attribute的說明，我們可以猜到程序運行的時候產生的輸出：DllImport Attribute表明了MessageBox是User32.DLL中的函數，這樣我們就可以像內部方法一樣調用這個函數。

重要的一點就是Attribute就是一個類，所以DllImport也是一個類，Attribute類是在編譯的時候被實例化的，而不是像通常的類那樣在運行時候才實例化。Attribute實例化的時候根據該Attribute類的設計可以帶參數，也可以不帶參數，比如DllImport就帶有"User32.dll"的參數。Conditional對滿足參數的定義條件的代碼進行編譯，如果沒有定義DEBUG,那麼該方法將不被編譯，讀者可以把#define DEBUG一行註釋掉看看輸出的結果（release版本，在Debug版本中Conditional的debug總是成立的）。Obsolete表明了DispalyDebugMessage方法已經過時了，它有一個更好的方法來代替它，當我們的程序調用一個聲明瞭Obsolete的方法時，那麼編譯器會給出信息，Obsolete還有其他兩個重載的版本。大家可以參考msdn中關於的ObsoleteAttribute 類的描述。

3、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的定義。如果都沒有找到，那麼編譯器就報錯。

 

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

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

 非常有意思的是，AttributeUsage本身也是一個Attribute，這是專門施加在Attribute類的Attribute. AttributeUsage自然也是從Attribute派生，它有一個帶參數的構造器，這個參數是AttributeTargets的枚舉類型。下面是AttributeTargets 的定義：

 1public enum AttributeTargets
 2{
 3   All=16383,
 4   Assembly=1,
 5   Module=2,
 6   Class=4,
 7   Struct=8,
 8   Enum=16,
 9   Constructor=32,
10   Method=64,
11   Property=128,
12   Field=256,
13   Event=512,
14   Interface=1024,
15   Parameter=2048,
16   Delegate=4096,
17   ReturnValue=8192
18}     

作爲參數的AttributeTarges的值允許通過“或”操作來進行多個值得組合，如果你沒有指定參數，那麼默認參數就是All 。 AttributeUsage除了繼承Attribute 的方法和屬性之外，還定義了以下三個屬性：

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

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

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

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

 1using System; 
 2[AttributeUsage(AttributeTargets.Class), AllowMultiple = false, 
 3Inherited = false ] (轉者注:這個寫法是錯誤的,應改爲> [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false) ] )
 4public class HelpAttribute : Attribute 
 5{ 
 6public HelpAttribute(String Description_in) 
 7{ 
 8this.description = Description_in; 
 9} 
10protected String description; 
11public String Description 
12{ 
13get 
14{ 
15return this.description; 
16} 
17} 
18}

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

1[Help("this is a do-nothing class")] 
2public class AnyClass 
3{ 
4[Help("this is a do-nothing method")] //error 
5public 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")] 
3public class AnyClass 
4{ 
5[Help("this is a do-nothing method")] //error 
6public void AnyMethod() 
7{ 
8} 
9}

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

　　AnyClass.cs: Duplicate 'Help' attribute

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

1[Help("BaseClass")] 
2public class Base 
3{ 
4} 
5
6public class Derive : Base 
7{ 
8}
9

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

　　[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")] 
2public class Base 
3{ 
4} 
5[Help("DeriveClass")] 
6public class Derive : Base 
7{ 
8}

　　現在我們來查詢一下Help特性，我們只能得到派生類的屬性，因爲inherited被設置爲true，但是AllowMultiple卻被設置爲false。因此基類的Help特性被派生類Help特性覆蓋了。

　　第四種情況：

　　在這裏，我們將會發現派生類既有基類的Help特性，也有自己的Help特性，因爲AllowMultiple被設置爲true。

 

至此，我們介紹了有關Attribute類和它們的代碼格式。你一定想知道到底如何在你的應用程序中使用Attribute，如果僅僅是前面介紹的內容，還是不足以說明Attribute有什麼實用價值的話，那麼從後面的章節開始我們將介紹幾個Attribute的不同用法，相信你一定會對Attribute有一個新的瞭解。