0. 前言 這篇文章延續《C 基礎知識系列 5 反射和泛型》,繼續介紹C 在反射所開發的功能和做的努力。上一篇文章大概介紹了一下泛型和反射的一些基本內容,主要是通過獲取對象的類型,然後通過這個類型對象操作對象。這一篇介紹一個在反射中很重要的內容:特性,以及上一篇未完成的內容——泛型在反射中的引用。 ...
0. 前言
這篇文章延續《C# 基礎知識系列- 5 反射和泛型》,繼續介紹C#在反射所開發的功能和做的努力。上一篇文章大概介紹了一下泛型和反射的一些基本內容,主要是通過獲取對象的類型,然後通過這個類型對象操作對象。這一篇介紹一個在反射中很重要的內容:特性,以及上一篇未完成的內容——泛型在反射中的引用。
1. 特性
特性是一種類增強技術,配合解析對應的解析方法可以完成很多類原本沒有的功能。特性本質是一種標簽,可以標註在類、方法、屬性等。它是類本身的一種信息擴展,就像生活中一個人只有一個身份證號,但是可以有多個身份一樣,而這些多出來的身份對於類來說就是特性。特性雖然是對類的增強,但不局限於在類上做標記,屬性、方法上都可以。
在C#中特性分為三種,位映射特性、自定義特性和偽自定義特性。
位映射特性,舉個例子,在C#中一個類會有public、private、abstract(抽象類)、saled(不能繼承)等修飾符,而這些修飾符在C#編譯的過程中會生成一串二進位碼,裡面存放就是 是否是public、是否是private 等。這些就是位映射特性的一部分,位映射特性對我們來說是無法進行擴展和修改的,所以就不做更多的介紹。
我們通常說的特性一般指的是自定義特性,這部分特性也是我們能夠擴展的,也是我們實際開發中用的特性。
1.1 定義一個特性
如何正確的定義一個特性呢?在C#中,特性也是類的一種。所以聲明一個特性,就如同聲明一個類一樣,不同的是,這個類指定一個根父類是System.Attribute
。所有自定義特性都是這個類的子類或者後代類,無一例外。同時,C#提倡在定義一個特性類的時候,類名應當以Attribute
結尾,在使用的時候可以自動忽略。
示例:
public class DemoAttribute : Attribute { }
以上實例就是定義了一個很普通的特性類,用了也沒有任何用的特性。因為特性只是一種標簽。這個特性類可以用在任何支持特性的地方,當這個特性標記一個類的時候,目標類的子類也將自動獲取這個特性。
以上是一個特性的預設行為,如果我們想要對此做一定限制的話,那麼就需要用到特性System.AttributeUsageAttribute
。這個特性類用來控制特性的使用方式。
public bool Inherited { get; set; }// 該特性是否可以被子類繼承,預設是 True
public bool AllowMultiple { get; set; }// 一個類是否可以多次使用該特性做標記,預設是 False
public AttributeTargets ValidOn { get; }//獲取一組值,這組值標識指示的屬性可應用到的程式元素,該參數使用構造方法賦值
我們再來看看AttributeTargets
里有些什麼吧。
[System.Flags]
public enum AttributeTargets
{
Assembly = 1,// 表示特性是用在 Assembly上的,不常用
Module = 2, //特性是用在 Module上的,不常用
Class = 4, // 表示特性是用來類上的
Struct = 8, //表示用在結構體上
Enum = 16, // 0x00000010 表示用在枚舉上
Constructor = 32, // 0x00000020 構造方法
Method = 64, // 0x00000040 普通方法
Property = 128, // 0x00000080 屬性
Field = 256, // 0x00000100 欄位
Event = 512, // 0x00000200 事件
Interface = 1024, // 0x00000400 介面
Parameter = 2048, // 0x00000800 方法的參數
Delegate = 4096, // 0x00001000 委托
ReturnValue = 8192, // 0x00002000 返回值
GenericParameter = 16384, // 0x00004000 泛型參數
All = GenericParameter | ReturnValue | Delegate | Parameter | Interface | Event | Field | Property | Method | Constructor | Enum | Struct | Class | Module | Assembly, // 0x00007FFF ,所有
}
我們常用的限制是ALL或者類等,限制也可以是多個,寫法如下:限制A|限制B|限制C
,表示A、B、C三種限制共存。具體原理是因為 AttributeTargets
是支持位運算的枚舉,通過一定的位運算可以在一個值中間存放多個枚舉。
說了這麼多,我們自己重新寫一個特性類吧:
1.限定只能給類使用的特性
[AttributeUsage(AttributeTargets.Class)]
public class DemoAttribute : Attribute { }
2.限定只能給方法使用的特性
[AttributeUsage(AttributeTargets.Method)]
public class DemoAttribute : Attribute
{
}
3.限定不能繼承的特性
[AttributeUsage(AttributeTargets.All, Inherited = false)]
public class DemoAttribute : Attribute
{
}
4.限定類和枚舉可以使用,但不能繼承的 特性
[AttributeUsage(AttributeTargets.Class| AttributeTargets.Enum, Inherited = false)]
public class DemoAttribute : Attribute
{
}
需要註意的一點就是,如果要指定是否可以被繼承或者是否允許多次使用 這兩個屬性則需要先指定特性的作用範圍,即限定是類能使用還是所有都可以。
1.2 使用特性
我們自定義了一個特性,就必須使用它才能會有意義,否則它只是一個普通的類。那麼我們該如何使用呢?其實在上一節中我們隱晦的介紹了特性的使用方式。就是用中括弧包裹起來,給類、屬性、方法等標記起來。
首先我們定義一個賊普通的特性:
public class DemoAttribute : Attribute { }//沒有任何限制,可以用在任何支持特性的地方
然後使用它:
[Demo]//[DemoAttribute]
public class TestDemo
{
}
如示例所示,在類上面添加[Demo]
標記,表示這個類應用了特性DemoAttribute,也可以使用類名,但是C#會自動忽略類名中結尾的Attribute。當然有的人會把特性寫在類或者方法等聲明的同一行開頭位置,不過我一般會寫在不同行,畢竟閱讀上簡單明瞭。
我們之前說過,拋開它集成自Attribute類不提,它也是一個類。既然是類,那麼就會有屬性。那麼現在定義一個帶屬性的特性類:
[AttributeUsage(AttributeTargets.Class| AttributeTargets.Enum, Inherited = false)]
public class DemoAttribute : Attribute
{
public string Name { get; set; }
}
該特性聲明瞭一個變數,使用方式如下:
[Demo(Name = "測試")]
public class Student{ }
DemoAttribute是一個只能用在 類、枚舉 上的特性,有一個屬性是Name。在使用的時候可以用(屬性名="屬性值")
的方式為屬性賦值。
更多的使用方式:
[AttributeUsage(AttributeTargets.Class| AttributeTargets.Enum, Inherited = false)]
public class DemoAttribute : Attribute
{
public string Name { get; set; }
public int Age { get; set; }
public DemoAttribute(int age)
{
Age = age;
}
}
使用:
[Demo(10,Name = "測試")]
public Student(){ }
如果特性類聲明瞭構造方法,那麼在使用的時候,優先按照構造方法的順序進行賦值,然後使用屬性名=屬性值
的方式為其他屬性進行賦值。
2. 特性在反射中的應用
在第一節中介紹瞭如何聲明一個特性和使用特性,但是沒有反射或者類載入技術,那麼特性的作用就並沒有想象中的那麼大。就像人有多個身份,但是也得有對應的公司或者對應的環境。比如說,王XX有個身份是某XX公司老總,那麼XX公司得需要在工商局註冊登記,他這個身份才會有效。如果沒有登記,那麼這個身份也就是個虛名。當特性離開了反射,離開了類載入技術,特性就是擺設。當然這部分只限於自定義特性,因為C#內置的一些特性涉及到另外的技術:動態編譯,或者需要編譯器的配合。我們自定義的特性顯然沒有這些特權,所以必須我們手動開發對應的行為和規範。
首先,聲明一個類和特性:
[AttributeUsage(AttributeTargets.Class| AttributeTargets.Enum, Inherited = false)]
public class DemoAttribute : Attribute
{
public string Name { get; set; }
public int Age { get; set; }
public DemoAttribute(int age)
{
Age = age;
}
}
[Demo(10,Name = "測試")]
public class Student
{
}
2.1 獲取類的特性
var stuType = typeof(Student);
上述代碼先獲取到一個類的類型對象,然後調用:
IEnumerable<CustomAttributeData> attrs = stuType.CustomAttributes;
將獲取到這個類上聲明的所有的自定義的特性,不過獲取到的是一個CustomAttributeData
,這個類封裝了一個特性的特征,但是在我們使用起來會很困難,而且我們更多的需要得到特性本身的對象,而不是這種需要我們進一步處理的對象。那麼,調用:
IEnumerable<Attribute> data = stuType.GetCustomAttributes(typeof(DemoAttribute));
通過上述方法就可以獲取到一組類型是DemoAttribute
的特性對象。
那麼回想一下為什麼是一組?在AttributeUsageAttribute
有一個AllowMultiple
屬性,這個屬性就是用來標記這個特性是否可以標註多個,也就是在同一目標上多次使用,如果這個值為True,則在此處將獲取不定個,否則最多一個。具體取決於對目標做了多少標記。
獲取到特性之後,依據實際需求進行開發。這裡就不做過多介紹了,在後續篇幅中會對這部分的使用做更多的介紹。
2.2 獲取其他元素的特性
特性不止可以標記在類上,還可以標記在屬性、方法上。那麼這些元素應該如何獲取對應的特性呢?
1. 屬性
var stuType = typeof(Student);
var property = stuType.GetProperties()[0];//假設類有一個Property
var attrs = property.GetCustomAttributes(typeof(DemoAttribute));
2. 方法
var stuType = typeof(Student);
var method = stuType.GetMethods()[0];// 假設類有一個方法
var attrs = method.GetCustomAttributes(typeof(DemoAttribute));
需要註意的地方是,
var
關鍵字;DemoAttribute只是一個代指,不是特指之前聲明的DemoAttribute特性類,因為之前聲明的特性類沒有對屬性和方法進行支持,所以在本節中直接使用會編譯不通過。
特性就先簡單的介紹到這裡,特性可以標記給很多目標比如程式集、模塊、類等一系列,但實際開發至少是Web開發中,更多的是標記類、方法、屬性等。這裡只是介紹了特性的聲明和使用,但是沒有介紹實際開發中特性的使用,這部分有機會在後續篇幅中介紹吧。因為我也用的不是很多。
3. 反射中的泛型
之前在《C# 基礎知識系列- 5 泛型和反射》介紹過,C#的泛型不會在編譯過程中抹去痕跡,意思就是我們可以通過反射獲取到對象的實際泛型類型。那麼如何獲取呢?
var stuType = typeof(Student);
// 獲取類的泛型參數
var genericTypes = stuType.GenericTypeArguments;
var method = stuType.GetMethods()[0];
// 獲取方法的泛型參數
var types = method.GetGenericArguments();
這個問題,在我寫Java代碼的時候,困擾了我很久,沒有很好的辦法。但是在C#中,我可以不用考慮這個問題。
4. 總結
反射在各大編程語言中是一個很重要的特點,泛型、特性在泛型中扮演著很重要的角色。反射在實際開發中扮演著很重要的角色,但是我們在開發中必須慎重考慮反射的使用。
到目前為止,反射介紹告一段落,但這不是結束。因為反射是個可深可淺的內容,目前只是介紹了依稀概念和理論上的一些內容,而更多的則隱藏在實際開發中,這時候就需要結合需求進行設計和代碼編寫了。
更多內容煩請關註我的博客