C# 教程
特性(Attribute)是用于在運(yùn)行時(shí)傳遞程序中各種元素(比如類、方法、結(jié)構(gòu)、枚舉、組件等)的行為信息的聲明性標(biāo)簽。您可以通過使用特性向程序添加聲明性信息。一個(gè)聲明性標(biāo)簽是通過放置在它所應(yīng)用的元素前面的方括號([ ])來描述的。
特性(Attribute)用于添加元數(shù)據(jù),如編譯器指令和注釋、描述、方法、類等其他信息。.Net 框架提供了兩種類型的特性:預(yù)定義特性和自定義特性。
規(guī)定特性(Attribute)的語法如下:
[attribute(positional_parameters, name_parameter = value, ...)] element
特性(Attribute)的名稱和值是在方括號內(nèi)規(guī)定的,放置在它所應(yīng)用的元素之前。positional_parameters 規(guī)定必需的信息,name_parameter 規(guī)定可選的信息。
.Net 框架提供了三種預(yù)定義特性:
預(yù)定義特性 AttributeUsage 描述了如何使用一個(gè)自定義特性類。它規(guī)定了特性可應(yīng)用到的項(xiàng)目的類型。
規(guī)定該特性的語法如下:
[AttributeUsage( validon, AllowMultiple=allowmultiple, Inherited=inherited )]
其中:
例如:
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Constructor | AttributeTargets.Field | AttributeTargets.Method | AttributeTargets.Property, AllowMultiple = true)]
這個(gè)預(yù)定義特性標(biāo)記了一個(gè)條件方法,其執(zhí)行依賴于指定的預(yù)處理標(biāo)識符。
它會引起方法調(diào)用的條件編譯,取決于指定的值,比如 Debug 或 Trace。例如,當(dāng)調(diào)試代碼時(shí)顯示變量的值。
規(guī)定該特性的語法如下:
[Conditional( conditionalSymbol )]
例如:
[Conditional("DEBUG")]
下面的實(shí)例演示了該特性:
當(dāng)上面的代碼被編譯和執(zhí)行時(shí),它會產(chǎn)生下列結(jié)果:
In Main function In Function 1 In Function 2
這個(gè)預(yù)定義特性標(biāo)記了不應(yīng)被使用的程序?qū)嶓w。它可以讓您通知編譯器丟棄某個(gè)特定的目標(biāo)元素。例如,當(dāng)一個(gè)新方法被用在一個(gè)類中,但是您仍然想要保持類中的舊方法,您可以通過顯示一個(gè)應(yīng)該使用新方法,而不是舊方法的消息,來把它標(biāo)記為 obsolete(過時(shí)的)。
規(guī)定該特性的語法如下:
[Obsolete( message )] [Obsolete( message, iserror )]
其中:
下面的實(shí)例演示了該特性:
當(dāng)您嘗試編譯該程序時(shí),編譯器會給出一個(gè)錯(cuò)誤消息說明:
Don't use OldMethod, use NewMethod instead
.Net 框架允許創(chuàng)建自定義特性,用于存儲聲明性的信息,且可在運(yùn)行時(shí)被檢索。該信息根據(jù)設(shè)計(jì)標(biāo)準(zhǔn)和應(yīng)用程序需要,可與任何目標(biāo)元素相關(guān)。
創(chuàng)建并使用自定義特性包含四個(gè)步驟:
最后一個(gè)步驟包含編寫一個(gè)簡單的程序來讀取元數(shù)據(jù)以便查找各種符號。元數(shù)據(jù)是用于描述其他數(shù)據(jù)的數(shù)據(jù)和信息。該程序應(yīng)使用反射來在運(yùn)行時(shí)訪問特性。我們將在下一章詳細(xì)討論這點(diǎn)。
一個(gè)新的自定義特性應(yīng)派生自 System.Attribute 類。例如:
// 一個(gè)自定義特性 BugFix 被賦給類及其成員 [AttributeUsage(AttributeTargets.Class | AttributeTargets.Constructor | AttributeTargets.Field | AttributeTargets.Method | AttributeTargets.Property, AllowMultiple = true)] public class DeBugInfo : System.Attribute
在上面的代碼中,我們已經(jīng)聲明了一個(gè)名為 DeBugInfo 的自定義特性。
讓我們構(gòu)建一個(gè)名為 DeBugInfo 的自定義特性,該特性將存儲調(diào)試程序獲得的信息。它存儲下面的信息:
我們的 DeBugInfo 類將帶有三個(gè)用于存儲前三個(gè)信息的私有屬性(property)和一個(gè)用于存儲消息的公有屬性(property)。所以 bug 編號、開發(fā)人員名字和審查日期將是 DeBugInfo 類的必需的定位( positional)參數(shù),消息將是一個(gè)可選的命名(named)參數(shù)。
每個(gè)特性必須至少有一個(gè)構(gòu)造函數(shù)。必需的定位( positional)參數(shù)應(yīng)通過構(gòu)造函數(shù)傳遞。下面的代碼演示了 DeBugInfo 類:
通過把特性放置在緊接著它的目標(biāo)之前,來應(yīng)用該特性:
在下一章中,我們將使用 Reflection 類對象來檢索這些信息。