C#特性詳解

特性（attribute）是被指定給某一聲明的一則附加的聲明性信息。

在C#中，有一個小的預約義特性集合。在學習如何創建咱們本身的定製特性（custom attributes）以前，咱們先來看看在咱們的代碼中如何使用預約義特性。

 　　　　

　　　　　　

 1 using System;
 2 public class AnyClass
 3 {
 4     [Obsolete("Don't use Old method, use New method", true)]
 5     static void Old( ) { } 
 6     static void New( ) { }
 7     public static void Main( )
 8     {
 9         Old( );
10     }
11 }

 

　　咱們先來看一下上面這個例子，在這個例子中咱們使用了Obsolete特性，它標記了一個不該該再被使用的程序實體。第一個參數是一個字符串，它解釋了爲何該實體是過期的以及應該用什麼實體來代替它。實際上，你能夠在這裏寫任何文本。第二個參數告訴編譯器應該把使用這個過期的程序實體看成一種錯誤。它的默認值是false，也就是說編譯器對此會產生一個警告。 

　　當咱們嘗試編譯上面這段程序的時候，咱們將會獲得一個錯誤： 
　　AnyClass.Old()' is obsolete: 'Don't use Old method, use New method' 

　　開發定製特性（custom attributes） 

　　如今讓咱們來看看如何開發咱們本身的特性。 
　　首先咱們要從System.Attribute派生出咱們本身的特性類（一個從System.Attribute抽象類繼承而來的類，無論是直接仍是間接繼承，都會成爲一個特性類。特性類的聲明定義了一種能夠被放置在聲明之上新的特性）。

  1 using System; 2 public class HelpAttribute : Attribute 3 { 4 } 

　　無論你是否相信，咱們已經創建了一個定製特性，如今咱們能夠用它來裝飾現有的類就好像上面咱們使用Obsolete attribute同樣。

 

　　

1 [Help()]
2 public class AnyClass
3 {
4 }

 

　　注意：對一個特性類名使用Attribute後綴是一個慣例。然而，當咱們把特性添加到一個程序實體，是否包括 Attribute後綴是咱們的自由。編譯器會首先在System.Attribute的派生類中查找被添加的特性類。若是沒有找到，那麼編譯器會添加 Attribute後綴繼續查找。 

    到目前爲止，這個特性尚未起到什麼做用。下面咱們來添加些東西給它使它更有用些。

 

 1 using System;
 2 public class HelpAttribute : Attribute
 3 {
 4     public HelpAttribute(String Descrition_in)
 5     {
 6         this.description = Description_in;
 7     }
 8     protected String description;
 9     public String Description
10     {
11         get
12         {
13             return this.description;
14         }
15     }
16 }
17 [Help("this is a do-nothing class")]
18 public class AnyClass
19 {
20 }

 

    在上面的例子中，咱們給HelpAttribute特性類添加了一個屬性而且在後續的部分中咱們會在運行時環境中查尋它。 

　　定義或控制特性的使用 

　　AttributeUsage類是另一個預約義特性類，它幫助咱們控制咱們本身的定製特性的使用。它描述了一個定製特性如和被使用。 
　　AttributeUsage有三個屬性，咱們能夠把它放置在定製屬性前面。第一個屬性是： 

　　ValidOn 
　　經過這個屬性，咱們可以定義定製特性應該在何種程序實體前放置。一個屬性能夠被放置的全部程序實體在AttributeTargets enumerator中列出。經過OR操做咱們能夠把若干個AttributeTargets值組合起來。 

　　AllowMultiple 
　　這個屬性標記了咱們的定製特性可否被重複放置在同一個程序實體前屢次。 

　　Inherited 
　　咱們可使用這個屬性來控制定製特性的繼承規則。它標記了咱們的特性可否被繼承。 

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

 

 1 using System;
 2 [AttributeUsage(AttributeTargets.Class), AllowMultiple = false,
 3 Inherited = false ]
 4 public class HelpAttribute : Attribute
 5 {
 6     public HelpAttribute(String Description_in)
 7     {
 8         this.description = Description_in;
 9     }
10     protected String description;
11     public String Description
12     {
13         get
14         {
15             return this.description;
16         }
17     }
18 }

 

 

　　先讓咱們來看一下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 }
5 public class Derive : Base
6 {
7 }

 

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

1 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false ]
2 [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false ]
3 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true ]
4 [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true ] 

 

　　第一種狀況： 

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

　　第二種狀況： 

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

　　第三種狀況： 

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

 

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

 

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

　　第四種狀況： 

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

 

    定義或控制特性的使用AttributeUsage類是另一個預約義特性類，它幫助咱們控制咱們本身的定製特性的使用。它描述了一個定製特性如何被使用。

 

屬性和特性的區別能夠參考一下： http://developer.51cto.com/art/200908/147097.htm