C# AttributeUsage使用案例詳解
C# AttributeUsage的使用是如何的呢?首先讓我們來了解一下什么是AttributeUsage類它是另外一個預(yù)定義特性類,AttributeUsage類的作用就是幫助我們控制定制特性的使用。其實AttributeUsage類就是描述了一個定制特性如和被使用。
C# AttributeUsage的使用要明白:
AttributeUsage有三個屬性,我們可以把它放置在定制屬性前面。
- ValidOn
通過這個屬性,我們能夠定義定制特性應(yīng)該在何種程序?qū)嶓w前放置。一個屬性可以被放置的所有程序?qū)嶓w在AttributeTargets enumerator中列出。通過OR操作我們可以把若干個AttributeTargets值組合起來。 - AllowMultiple
這個屬性標記了我們的定制特性能否被重復(fù)放置在同一個程序?qū)嶓w前多次。 - Inherited
我們可以使用這個屬性來控制定制特性的繼承規(guī)則。它標記了我們的特性能否被繼承。
C# AttributeUsage的使用實例:
下面讓我們來做一些實際的東西。我們將會在剛才的Help特性前放置AttributeUsage特性以期待在它的幫助下控制Help特性的使用。
using System; [AttributeUsage(AttributeTargets.Class), AllowMultiple = false, Inherited = false ] public class HelpAttribute : Attribute { public HelpAttribute(String Description_in) { this.description = Description_in; } protected String description; public String Description { get { return this.description; } } }
先讓我們來看一下AttributeTargets.Class。它規(guī)定了Help特性只能被放在class的前面。這也就意味著下面的代碼將會產(chǎn)生錯誤:
[Help("this is a do-nothing class")] public class AnyClass { [Help("this is a do-nothing method")] //error public void AnyMethod() { } }
編譯器報告錯誤如下:
AnyClass.cs: Attribute ‘Help' is not valid on this declaration type.
It is valid on ‘class' declarations only.
我們可以使用AttributeTargets.All來允許Help特性被放置在任何程序?qū)嶓w前。可能的值是:
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。它規(guī)定了特性不能被重復(fù)放置多次。
[Help("this is a do-nothing class")] [Help("it contains a do-nothing method")] public class AnyClass { [Help("this is a do-nothing method")] //error public void AnyMethod() { } }
它產(chǎn)生了一個編譯期錯誤。
AnyClass.cs: Duplicate ‘Help' attribute
Ok,現(xiàn)在我們來討論一下最后的這個屬性。Inherited, 表明當特性被放置在一個基類上時,它能否被派生類所繼承。
[Help("BaseClass")] public class Base { } public class Derive : Base { }
C# AttributeUsage的使用會有四種可能的組合:
[Help("BaseClass")] public class Base { } public class Derive : Base { }
C# AttributeUsage的使用第一種情況:
如果我們查詢(Query)(稍后我們會看到如何在運行期查詢一個類的特性)Derive類,我們將會發(fā)現(xiàn)Help特性并不存在,因為inherited屬性被設(shè)置為false。
C# AttributeUsage的使用第二種情況:
和第一種情況相同,因為inherited也被設(shè)置為false。
C# AttributeUsage的使用第三種情況:
為了解釋第三種和第四種情況,我們先來給派生類添加點代碼:
[Help("BaseClass")] public class Base { } [Help("DeriveClass")] public class Derive : Base { }
現(xiàn)在我們來查詢一下Help特性,我們只能得到派生類的屬性,因為inherited被設(shè)置為true,但是AllowMultiple卻被設(shè)置為false。因此基類的Help特性被派生類Help特性覆蓋了。
C# AttributeUsage的使用第四種情況:
在這里,我們將會發(fā)現(xiàn)派生類既有基類的Help特性,也有自己的Help特性,因為AllowMultiple被設(shè)置為true。
C# AttributeUsage的相關(guān)內(nèi)容就向你介紹到這里,希望對你了解和掌握C# AttributeUsage的使用有所幫助。
到此這篇關(guān)于C# AttributeUsage使用案例詳解的文章就介紹到這了,更多相關(guān)C# AttributeUsage使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!