C# AttributeUsage使用案例詳解
C# AttributeUsage的使用是如何的呢？首先讓我們來瞭解一下什麼是AttributeUsage類它是另外一個預定義特性類，AttributeUsage類的作用就是幫助我們控制定制特性的使用。其實AttributeUsage類就是描述瞭一個定制特性如和被使用。
C# AttributeUsage的使用要明白：
AttributeUsage有三個屬性，我們可以把它放置在定制屬性前面。
- ValidOn
通過這個屬性，我們能夠定義定制特性應該在何種程序實體前放置。一個屬性可以被放置的所有程序實體在AttributeTargets enumerator中列出。通過OR操作我們可以把若幹個AttributeTargets值組合起來。 - AllowMultiple
這個屬性標記瞭我們的定制特性能否被重復放置在同一個程序實體前多次。 - Inherited
我們可以使用這個屬性來控制定制特性的繼承規則。它標記瞭我們的特性能否被繼承。
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。它規定瞭Help特性隻能被放在class的前面。這也就意味著下面的代碼將會產生錯誤：
[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特性被放置在任何程序實體前。可能的值是：
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。它規定瞭特性不能被重復放置多次。
[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()
{
}
}
它產生瞭一個編譯期錯誤。
AnyClass.cs: Duplicate ‘Help’ attribute
Ok,現在我們來討論一下最後的這個屬性。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類，我們將會發現Help特性並不存在，因為inherited屬性被設置為false。
C# AttributeUsage的使用第二種情況：
和第一種情況相同，因為inherited也被設置為false。
C# AttributeUsage的使用第三種情況：
為瞭解釋第三種和第四種情況，我們先來給派生類添加點代碼：
[Help("BaseClass")]
public class Base
{
}
[Help("DeriveClass")]
public class Derive : Base
{
}
現在我們來查詢一下Help特性，我們隻能得到派生類的屬性，因為inherited被設置為true，但是AllowMultiple卻被設置為false。因此基類的Help特性被派生類Help特性覆蓋瞭。
C# AttributeUsage的使用第四種情況：
在這裡，我們將會發現派生類既有基類的Help特性，也有自己的Help特性，因為AllowMultiple被設置為true。
C# AttributeUsage的相關內容就向你介紹到這裡，希望對你瞭解和掌握C# AttributeUsage的使用有所幫助。
到此這篇關於C# AttributeUsage使用案例詳解的文章就介紹到這瞭,更多相關C# AttributeUsage使用內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！