C#內置特性介紹
.Net 中可以使用特性來完成這一工作。特性是一個對象,它可以加載到程序集及程序集的對象中,這些對象包括 程序集本身、模塊、類、接口、結構、構造函數、方法、方法參數等,加載了特性的對象稱作特性的目標。特性是為程序添加元數據(描述數據的數據)的一種機制,通過它可以給編譯器提供指示或者提供對數據的說明。
NOTE:特性的英文名稱叫做Attribute,在有的書中,將它翻譯為“屬性”;另一些書中,將它翻譯為“特性”;由于通常我們將含有get和/或set訪問器的類成員稱為“屬性”(英文Property),所以本文中我將使用“特性”這個名詞,以區分“屬性”(Property)。
中文版的VS2005使用“屬性”。
C#內置特性之System.ObsoleteAttribute 特性
我們通過這個例子來看一下特性是如何解決上面的問題:我們可以給舊的SendMsg()方法上面加上Obsolete特性來告訴編譯器這個方法已經過時,然后當編譯器發現當程序中有地方在使用這個用Obsolete標記過的方法時,就會給出一個警告信息。
- namespace Attribute {
- public class Message {}
- public class TestClass {
- // 添加Obsolete特性
- [Obsolete("請使用新的SendMsg(Message msg)重載方法")]
- public static void ShowMsg() {
- Console.WriteLine("這是舊的SendMsg()方法");
- }
- public static void ShowMsg(Message msg) {
- Console.WriteLine("新SendMsg()方法");
- }
- }
- class Program {
- static void Main(string[] args) {
- TestClass.ShowMsg();
- TestClass.ShowMsg(new Message());
- }
- }
- }
現在運行這段代碼,我們會發現編譯器給出了一個警告:警告CS0618: “Attribute.TestClass.ShowMsg()”已過時:“請使用新的SendMsg(Message msg)重載方法”。通過使用特性,我們可以看到編譯器給出了警告信息,告訴客戶程序存在一個新的方法可供使用,這樣,程序員在看到這個警告信息后,便會考慮使用新的SendMsg()方法。
NOTE:簡單起見,TestClass類和 Program位于同一個程序集中,實際上它們可以離得很遠。
C#內置特性的使用方法
通過上面的例子,我們已經大致看到特性的使用方法:首先是有一對方括號“[]”,在左方括號“[”后緊跟特性的名稱,比如Obsolete,隨后是一個圓括號“()”。和普通的類不同,這個圓括號不光可以寫入構造函數的參數,還可以給類的屬性賦值,在Obsolete的例子中,僅傳遞了構造函數參數。
NOTE:實際上,當你用鼠標框選住Obsolete,然后按下F12轉到定義,會發現它的全名是ObsoleteAttribute,繼承自Attribute類。但是這里卻僅用Obsolete來標記方法,這是.Net的一個約定,所有的特性應該均以Attribute來結尾,在為對象標記特性時如果沒有添加Attribute,編譯器會自動尋找帶有Attribute的版本。
NOTE:使用構造函數參數,參數的順序必須同構造函數聲明時的順序相同,所有在特性中也叫位置參數(Positional Parameters),與此相應,屬性參數也叫做命名參數(Named Parameters)。
以上就是C#內置特性的簡單介紹。
【編輯推薦】