深入淺出Attribute（中）——Attribute本質(zhì)論
2007-06-04
小序：
上篇里，我們把Attribute“粘”在類的成員方法上show了一把，讓Attribute跟大家混了個(gè)臉兒熟。中篇里，我們將探討“究竟什么是Attribute”和“如何創(chuàng)建及使用Attribute”這兩個(gè)問(wèn)題。
準(zhǔn)備好了嗎？Let’s go!
正文：
從上篇里我們可以看到，Attribute似乎總跟public、static這些關(guān)鍵字（Keyword）出現(xiàn)在一起。莫非使用了Attribute就相當(dāng)于定義了新的修飾符（Modifier）嗎？讓我們來(lái)一窺究竟！
先把下面這個(gè)例子編譯出來(lái)：
#define
OK
using System;
using System.Diagnostics;
namespace Sample
{
class
Program
{
[Conditional("OK")]
publicstaticvoid TargetMethod()
{
Console.ForegroundColor = ConsoleColor.Green;
Console.WriteLine("\t=<
水之真諦>=\nhttp://blog.csdn.net/FantasiaX\n\n"
);
}
staticvoid Main(string[] args)
{
TargetMethod();
}
}
}
毋庸置疑，它的運(yùn)行結(jié)果會(huì)是這樣：
接下來(lái)，讓我們把編譯出的結(jié)果（.EXE文件）用“微軟中間語(yǔ)言反編譯器”打開(kāi)，查看存儲(chǔ)在程序集（Assembly，這在個(gè)例子中就是這個(gè).EXE文件）中的中間語(yǔ)言代碼（中間語(yǔ)言也就是我們常說(shuō)的通用語(yǔ)言）。
如果你認(rèn)為反匯編是件很神秘的事情，那你可就錯(cuò)了！比起x86匯編語(yǔ)言來(lái)，對(duì).NET程序集的反匯編要簡(jiǎn)單得多——甚至可以說(shuō)是與C#語(yǔ)言一一對(duì)應(yīng)：
嚴(yán)格地來(lái)說(shuō)，用來(lái)形成上圖中樹(shù)狀結(jié)構(gòu)的代碼并不是程序集中的中間語(yǔ)言，而主要是元數(shù)據(jù)（Metadata）的功勞。包含在程序集中的元數(shù)據(jù)記錄了這個(gè)程序集里有多少個(gè)namespace、多少個(gè)類、類里有什么成員、成員的訪問(wèn)級(jí)別是什么……而且，元數(shù)據(jù)是以文本（也就是Unicode字符）形式存在的，使用.NET的反射（Reflection）技術(shù)，很容易就能把它們讀取出來(lái)并形成各種各樣的漂亮視圖——上面的樹(shù)狀圖、VS里的Object Browser視圖和自動(dòng)代碼提示功能，都是元數(shù)據(jù)與反射技術(shù)結(jié)合的產(chǎn)物。一個(gè)程序集（.EXE或.DLL）能夠使用包含在自己體內(nèi)的元數(shù)據(jù)來(lái)完整地說(shuō)明自己，而不必像C/C++那樣帶著一大捆頭文件，這就叫作“自包含性”或“自描述性”。
扯的有點(diǎn)兒遠(yuǎn)了——讓我們回到正題，雙擊反編譯器中的TargetMethod:void()。這回彈出窗口里顯示的內(nèi)容是真正的微軟中間語(yǔ)言代碼了。這些代碼也都是文本形式的，需要經(jīng)過(guò).NET的“虛擬機(jī)”再編譯后才能被CPU所執(zhí)行。順便說(shuō)一句：VB.NET代碼也會(huì)編譯成這樣的中間代碼，所以，.NET平臺(tái)上所有語(yǔ)言的編譯結(jié)果都是通用的。換句話說(shuō)，你用C#編寫了一個(gè)組件，把它編譯成一個(gè)DLL文件并交給VB.NET程序員，VB.NET程序員可以直接使用，絲毫不必有任何擔(dān)心J
今天我們不打算研究中間語(yǔ)言的編譯和執(zhí)行，主要是打算通過(guò)中間語(yǔ)言對(duì)一些被C#語(yǔ)言所掩蓋的事實(shí)一窺究竟。
仔細(xì)觀察中間代碼之后，Attribute變得了無(wú)秘密！圖中藍(lán)色箭頭所指處是兩個(gè)“真正的”修飾符——Attribute并沒(méi)有出現(xiàn)在這里。而在紅色箭頭所標(biāo)識(shí)的位置，我們可以清楚地看出——這分明是在調(diào)用mscorlib.dll程序集System.Diagnostics名稱空間中ConditionalAttribute類的構(gòu)造函數(shù)。可見(jiàn)，Attribute并不是修飾符，而是一個(gè)有著獨(dú)特實(shí)例化形式的類！
Attribute實(shí)例化有什么獨(dú)特之處呢？還是讓我們?cè)俅斡^察中間語(yǔ)言代碼——它有兩個(gè)獨(dú)特之處。
1.它的實(shí)例是使用.custom聲明的。查看中間語(yǔ)言語(yǔ)法，你會(huì)發(fā)現(xiàn).custom是專門用來(lái)聲明自定義特性的。
2.聲明的位置是在函數(shù)真正的代碼（IL_0000:至IL_0014）之前。
God,我懷疑是不是講的太深了。沒(méi)關(guān)系，上面關(guān)于中間語(yǔ)言的東西你都可以不care，只需要記住一個(gè)結(jié)論就可以了——我們已經(jīng)從“底層”證明了Attribute不是什么“修飾符”，而是一種實(shí)例化方式比較特殊的類。
Attribute的實(shí)例化
就像牡蠣天生就要吸附在礁石或船底上一樣，Attribute的實(shí)例一構(gòu)造出來(lái)就必需“粘”在一個(gè)什么目標(biāo)上。
Attribute實(shí)例話的語(yǔ)法是相當(dāng)怪異的，主要體現(xiàn)在以下三點(diǎn)上：
1.不使用new操作符來(lái)產(chǎn)生實(shí)例，而是使用在方括號(hào)里調(diào)用構(gòu)造函數(shù)的來(lái)產(chǎn)生實(shí)例。
2.方括號(hào)必需緊挨著放置在被附著目標(biāo)的前面。
3.因?yàn)榉嚼ㄌ?hào)里空間有限，不能像使用new那樣先構(gòu)造對(duì)象后再對(duì)對(duì)象的屬性（Property）一一賦值。因此，對(duì)Attribute實(shí)例的屬性的賦值也都擠在了構(gòu)造函數(shù)的圓括號(hào)里L(fēng)
說(shuō)實(shí)話，寫代碼的時(shí)候?qū)τ诘?、第2兩條適應(yīng)起來(lái)還算容易，第3條寫出來(lái)怎么看怎么別扭……而且尤其要記著的是：
1.構(gòu)造函數(shù)的參數(shù)是一定要寫的——有幾個(gè)就得寫幾個(gè)——因?yàn)槟悴粚懙脑拰?shí)例就無(wú)法構(gòu)造出來(lái)。
2.構(gòu)造函數(shù)參數(shù)的順序不能錯(cuò)，這個(gè)很容易理解——調(diào)用任何一個(gè)函數(shù)你都不能改變參數(shù)的順序——除非它有相應(yīng)的重載（Overload）。因?yàn)檫@個(gè)順序的固定的，所以有些書里管這些參數(shù)稱為“定位參數(shù)”，意即“個(gè)數(shù)和位置固定的參數(shù)”。
3.對(duì)Attribute實(shí)例的屬性的賦值可有可無(wú)——反正它會(huì)有一個(gè)默認(rèn)值。而且，先對(duì)哪個(gè)屬性賦值、后對(duì)哪個(gè)屬性賦值不受限制。有些書管這些為屬性賦值的參數(shù)叫“具名參數(shù)”——令人匪夷所思。
OK，百聞不如一見(jiàn)，還是讓我們自己寫一個(gè)Attribute類來(lái)體驗(yàn)一下吧！
自己動(dòng)手寫Attribute
這回我們拋棄.NET Framework給我們準(zhǔn)備好的各種Attribute，從頭寫一個(gè)全新的Attribute——Oyster。
下面我給出一個(gè)完整的小例子：
//======水之真諦
=======//
//上善若水,潤(rùn)物無(wú)聲
//
/*[url]http://blog.csdn.net/FantasiaX[/url]*/
using
System;
namespace OysterAttributeSample
{
classOyster: System.Attribute// 必需以System.Attribute類為基類
{
// Kind屬性，默認(rèn)值為
null
privatestring kind;
publicstring Kind
{
get { return kind; }
set { kind = value; }
}
// Age屬性，默認(rèn)值為
privateuint age;
publicuint Age
{
get { return age; }
set { age = value; }
}
// 值為null的string是危險(xiǎn)的，所以必需在構(gòu)造函數(shù)中賦值
public Oyster(string arg)// 定位參數(shù)
{
this.Kind = arg;
}
}
[Oyster("Thorny ", Age=3)]// 3年的多刺牡蠣附著在輪船（這是一個(gè)類）上。注意：對(duì)屬性的賦值是在圓括號(hào)里完成的！
classShip
{
[Oyster("Saddle")]// 0
年的鞍形牡蠣附著在船舵（這是一個(gè)數(shù)據(jù)成員）上，Age使用的是默認(rèn)值，構(gòu)造函數(shù)的參數(shù)必需完整
publicstring Rudder;
}
classProgram
{
staticvoid Main(string[] args)
{
// ...
使用反射來(lái)讀取
Attribute
}
}
}
為了不把代碼拖的太長(zhǎng)，上面這個(gè)例子中Oyster類的構(gòu)造函數(shù)只有一個(gè)參數(shù)，所以對(duì)“定位參數(shù)”體現(xiàn)的還不夠淋漓盡致。大家可以再為Oyster類添加幾個(gè)屬性，并在構(gòu)造函數(shù)里多設(shè)置幾個(gè)參數(shù)，體驗(yàn)一下Attribute實(shí)例化時(shí)對(duì)參數(shù)個(gè)數(shù)及參數(shù)位置的敏感性。
能被Attribute所附著的目標(biāo)
讓我們思考這樣一個(gè)問(wèn)題：牡蠣可以附著在船底、礁石上、橋墩上……甚至是別的牡蠣身上，那么Attribute呢？都可以將自己的實(shí)例附著在什么目標(biāo)上呢？
這個(gè)問(wèn)題的答案隱藏在AttributeTargets這個(gè)枚舉類型里——這個(gè)類型的可取值集合為：
=============================================================================
AllAssemblyClassConstructor
DelegateEnumEventField
GenericParameterInterfaceMethodModule
ParameterPropertyReturnValueStruct
=============================================================================
一共是16個(gè)可取值。
不過(guò)，上面這張表是按字母順序排列的，并不代表它們真實(shí)值的排列順序。使用下面這個(gè)小程序可以查看每個(gè)枚舉值對(duì)應(yīng)的整數(shù)值。
// =<水之真諦
>=
// [url]http://blog.csdn.net/FantasiaX[/url]
using
System;
namespace AttributeTargetValue
{
classProgram
{
staticvoid Main(string[] args)
{
Console.WriteLine("Assembly\t\t\t{0}", Convert.ToInt32(AttributeTargets.Assembly));
Console.WriteLine("Module\t\t\t\t{0}", Convert.ToInt32(AttributeTargets.Module));
Console.WriteLine("Class\t\t\t\t{0}", Convert.ToInt32(AttributeTargets.Class));
Console.WriteLine("Struct\t\t\t\t{0}", Convert.ToInt32(AttributeTargets.Struct));
Console.WriteLine("Enum\t\t\t\t{0}", Convert.ToInt32(AttributeTargets.Enum));
Console.WriteLine("Constructor\t\t\t{0}", Convert.ToInt32(AttributeTargets.Constructor));
Console.WriteLine("Method\t\t\t\t{0}", Convert.ToInt32(AttributeTargets.Method));
Console.WriteLine("Property\t\t\t{0}", Convert.ToInt32(AttributeTargets.Property));
Console.WriteLine("Field\t\t\t\t{0}", Convert.ToInt32(AttributeTargets.Field));
Console.WriteLine("Event\t\t\t\t{0}", Convert.ToInt32(AttributeTargets.Event));
Console.WriteLine("Interface\t\t\t{0}", Convert.ToInt32(AttributeTargets.Interface));
Console.WriteLine("Parameter\t\t\t{0}", Convert.ToInt32(AttributeTargets.Parameter));
Console.WriteLine("Delegate\t\t\t{0}", Convert.ToInt32(AttributeTargets.Delegate));
Console.WriteLine("ReturnValue\t\t\t{0}", Convert.ToInt32(AttributeTargets.ReturnValue));
Console.WriteLine("GenericParameter\t\t{0}", Convert.ToInt32(AttributeTargets.GenericParameter));
Console.WriteLine("All\t\t\t\t{0}", Convert.ToInt32(AttributeTargets.All));
Console.WriteLine("\n");
}
}
}
程序的運(yùn)行結(jié)果是：
可能出乎你的預(yù)料——它們的值并不是步長(zhǎng)值為1的線性遞增。你觀察出什么規(guī)律來(lái)了嗎？提醒你一下：從二進(jìn)制的角度來(lái)考慮喔！！
我想你一定發(fā)現(xiàn)了規(guī)律——除了All的值之外，每個(gè)值的二進(jìn)制形式中只有一位是“1”，其余位全是“0”。這就是枚舉值的另一種用法——標(biāo)識(shí)位。那么，標(biāo)識(shí)位有什么好處呢？
考慮這樣一種情況：我們的Attribute要求既能附著在類上，又能附著在類的方法上，應(yīng)該怎么做呢？
我們知道，C#中有一個(gè)操作符“|”（也就是按位求“或”）。有了它，我們只需要書寫
AttributeTargets.Class | AttributeTargets.Method
就可以了。因?yàn)檫@兩個(gè)枚舉值的標(biāo)識(shí)位（也就是那個(gè)唯一的“1”）是錯(cuò)開(kāi)的，所以只需要按位求或就解決問(wèn)題了。我想，聰明的你一定立刻就能解釋為什么AttributeTargets.All的值是32767了吧:p
OK，了解了這些之后，我們應(yīng)該怎樣控制一個(gè)Attribute的附著目標(biāo)呢？
默認(rèn)情況下，當(dāng)我們聲明并定義一個(gè)新Attribute類時(shí)，它的可附著目標(biāo)是AttributeTargets.All。大多數(shù)情況下AttributeTargets.All就已經(jīng)滿足需求了，不過(guò)，如果你非要對(duì)它有所限制，那就要費(fèi)點(diǎn)兒周折了。
還拿我們上面創(chuàng)建的OysterAttribute舉例——如果你想把它的附著目標(biāo)限制為只有“類”和“值域”，你就應(yīng)該這樣書寫：
[AttributeUsage(AttributeTargets.Class|AttributeTargets.Field)]
classOyster : System.Attribute
{
// OysterAttribute類的具體實(shí)現(xiàn)
}
沒(méi)想到吧！原來(lái)是用Attribute（的實(shí)例）附著在Attribute（類）上！本來(lái)嗎，Attribute的本質(zhì)就是類，而AttributeTargets.Class又說(shuō)明Attribute可以附著在類上，所以，使用Attribute來(lái)“修飾”Attribute也就順理成章了J
最后，細(xì)心的讀者可能會(huì)問(wèn)這樣兩個(gè)問(wèn)題：
1.如果一個(gè)Attribute附著在了某個(gè)類上，那么這個(gè)Attribute會(huì)為會(huì)隨著繼承關(guān)系也附著在派生類上呢？
2.可不可以像多個(gè)牡蠣附著在同一艘船上那樣，讓一個(gè)Attribute的多個(gè)實(shí)例附著在同一個(gè)目標(biāo)上呢？
Very good! 這真是兩個(gè)好問(wèn)題！請(qǐng)看下面的代碼：
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Field, Inherited = false, AllowMultiple = true)]
classOyster : System.Attribute
{
// OysterAttribute類的具體實(shí)現(xiàn)
}
原來(lái)，AttributeUsage這個(gè)用來(lái)專門修飾Attribute的Attribute除了可以控制修飾目標(biāo)外，還能決定被它修飾的Attribute是否能夠隨宿主“遺傳”以及是否可以使用多個(gè)實(shí)例來(lái)修飾同一個(gè)目標(biāo)！
OK，大家猜一猜，修飾ConditionalAttribute的AttributeUsage會(huì)是什么樣子呢？
TO BE CONTINUE
