特性(attribute)是被指定給某壹聲明的壹則附加的聲明性信息。
在C#中,有壹個小的預定義特性集合。在學習如何建立我們自己的定制特性(custom attributes)之前,我們先來看看在我們的代碼中如何使用預定義特性。
using System;
public class AnyClass
{
[Obsolete(”Don’t use Old method, use New method”, true)]
static void Old( ) { }
static void New( ) { }
public static void Main( )
{
Old( );
}
}
我們先來看壹下上面這個例子,在這個例子中我們使用了Obsolete特性,它標記了壹個不應該再被使用的程序實體。第壹個參數是壹個字符串,它解釋了為什麽該實體是過時的以及應該用什麽實體來代替它。實際上,妳可以在這裏寫任何文本。第二個參數告訴編譯器應該把使用這個過時的程序實體當作壹種錯誤。它的默認值是false,也就是說編譯器對此會產生壹個警告。
當我們嘗試編譯上面這段程序的時候,我們將會得到壹個錯誤:
AnyClass.Old()’ is obsolete: ‘Don’t use Old method, use New method’
開發定制特性(custom attributes)
現在讓我們來看看如何開發我們自己的特性。
首先我們要從System.Attribute派生出我們自己的特性類(壹個從System.Attribute抽象類繼承而來的類,不管是直接還是間接繼承,都會成為壹個特性類。特性類的聲明定義了壹種可以被放置在聲明之上新的特性)。
using System;
public class HelpAttribute : Attribute
{
}
不管妳是否相信,我們已經建立了壹個定制特性,現在我們可以用它來裝飾現有的類就好像上面我們使用Obsolete attribute壹樣。
[Help()]
public class AnyClass
{
}
註意:對壹個特性類名使用Attribute後綴是壹個慣例。然而,當我們把特性添加到壹個程序實體,是否包括Attribute後綴是我們的自由。編譯器會首先在System.Attribute的派生類中查找被添加的特性類。如果沒有找到,那麽編譯器會添加Attribute後綴繼續查找。
到目前為止,這個特性還沒有起到什麽作用。下面我們來添加些東西給它使它更有用些。
using System;
public class HelpAttribute : Attribute
{
public HelpAttribute(String Descrition_in)
{
this.description = Description_in;
}
protected String description;
public String Description
{
get
{
return this.description;
}
}
}
[Help(”this is a do-nothing class”)]
public class AnyClass
{
}
在上面的例子中,我們給HelpAttribute特性類添加了壹個屬性並且在後續的部分中我們會在運行時環境中查尋它。
定義或控制特性的使用
AttributeUsage類是另外壹個預定義特性類,它幫助我們控制我們自己的定制特性的使用。它描述了壹個定制特性如和被使用。
AttributeUsage有三個屬性,我們可以把它放置在定制屬性前面。第壹個屬性是:
ValidOn
通過這個屬性,我們能夠定義定制特性應該在何種程序實體前放置。壹個屬性可以被放置的所有程序實體在AttributeTargets enumerator中列出。通過OR操作我們可以把若幹個AttributeTargets值組合起來。
AllowMultiple
這個屬性標記了我們的定制特性能否被重復放置在同壹個程序實體前多次。
Inherited
我們可以使用這個屬性來控制定制特性的繼承規則。它標記了我們的特性能否被繼承。
下面讓我們來做壹些實際的東西。我們將會在剛才的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
{
}
這裏會有四種可能的組合:
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false ]
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false ]
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true ]
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true ]
第壹種情況:
如果我們查詢(Query)(稍後我們會看到如何在運行期查詢壹個類的特性)Derive類,我們將會發現Help特性並不存在,因為inherited屬性被設置為false。
第二種情況:
和第壹種情況相同,因為inherited也被設置為false。
第三種情況:
為了解釋第三種和第四種情況,我們先來給派生類添加點代碼:
[Help(”BaseClass”)]
public class Base
{
}
[Help(”DeriveClass”)]
public class Derive : Base
{
}
現在我們來查詢壹下Help特性,我們只能得到派生類的屬性,因為inherited被設置為true,但是AllowMultiple卻被設置為false。因此基類的Help特性被派生類Help特性覆蓋了。
第四種情況:
在這裏,我們將會發現派生類既有基類的Help特性,也有自己的Help特性,因為AllowMultiple被設置為true。
定義或控制特性的使用
AttributeUsage類是另外壹個預定義特性類,它幫助我們控制我們自己的定制特性的使用。它描述了壹個定制特性如和被使用。
AttributeUsage有三個屬性,我們可以把它放置在定制屬性前面。第壹個屬性是:
ValidOn
通過這個屬性,我們能夠定義定制特性應該在何種程序實體前放置。壹個屬性可以被放置的所有程序實體在AttributeTargets enumerator中列出。通過OR操作我們可以把若幹個AttributeTargets值組合起來。
AllowMultiple
這個屬性標記了我們的定制特性能否被重復放置在同壹個程序實體前多次。
Inherited
標籤: C#
利用C#實現標準的Dispose模式
我們已經知道了處置那些占用非受控(unmanaged)資源的對象的重要性,現在應該編寫資源管理代碼來處置那些包含非內存資源的類型了。整個。NET框架組件都使用壹個標準的模式來處理非內存資源。使用妳建立的類型的用戶也希望妳遵循這個標準的模式。標準的處理模式的思想是這樣的:當客戶端記得的時候使用IDisposable接口釋放妳的非受控資源,當客戶端忘記的時候防護性地使用終結器(finalizer)。它與垃圾收集器(Garbage Collector)壹起工作,確保只在必要的時候該對象才受到與終結器相關的性能影響。這是處理非受控資源的壹條很好的途徑,因此我們應該徹底地認識它。
類層次體系中的根基類(root base class)必須實現IDisposable接口以釋放資源。這個類型還必須添加壹個作為防禦機制的終結器。所有這些程序都把釋放資源的工作委托給壹個虛擬的方法,衍生的類可以根據自己的資源管理需求來重載該方法。只要衍生的類必須釋放自己的資源,並且它必須調用該函數的基類版本的時候,它才需要重載這個虛擬方法。
開始的時候,如果妳的類使用了非內存資源,它就必須含有壹個終結器。妳不能依賴客戶端總是調用Dispose()方法。因為當它們忘記這樣做的時候,妳就面臨資源泄漏的問題。沒有調用Dispose是它們的問題,但是妳卻有過失。用於保證非內存資源被正確地釋放的唯壹途徑是建立終結器。
當垃圾收集器運行的時候,它立即從內存中刪除所有不帶終結器的垃圾對象。所有帶有終結器的對象仍然存在於內存中。這些對象都被添加到終結隊列,垃圾收集器引發壹個新線程,周期性地在這些對象上運行終結器。在這些終結程序線程完成自己的工作之後,就可以從內存中刪除垃圾對象了。需要終結的對象在內存中停留的時間比沒有終結器的對象停留的時間長很多。但是妳別無選擇。如果要使程序有防護性,在類型包含非受控資源的時候,妳必須編寫壹個終結器。但是也不用擔心性能問題。下壹步確保了客戶端避免與終結相關的性能開銷。
實現IDisposable接口是壹種標準的途徑,它通知用戶和運行時系統持有資源的對象必須及時地釋放。IDisposable接口僅僅包含壹個方法:
public interface IDisposable
{
void Dispose( );
}
妳對IDisposable.Dispose()方法的實現(implementation)負責下面四個事務:
1、釋放所有的非受控資源。
2、釋放所有的受控資源(包括未解開事件)。
3、設置標誌表明該對象已經被處理過了。妳必須在自己的公共方法中檢查這種狀態標誌並拋出ObjectDisposed異常(如果某個對象被處理過之後再次被調用的話)。
4、禁止終結操作(finalization)。妳調用GC.SuppressFinalize(this)來完成這種事務。
通過實現IDisposable接口妳完成了兩個事務:妳為客戶端及時地釋放自己持有的所有受控資源提供了機制;妳為客戶端提供了壹種釋放非受控資源的標準途徑。這是壹個很大的進步。當妳在類型中實現了Idisposable接口的時候,客戶端可以避免終結操作的開銷,妳的類就成為。NET世界中的”良民”了。
但是在妳建立的這種機制中仍然存在壹些問題。怎樣在衍生類清理自己資源的時候同時也讓基類能夠清理資源?如果衍生類重載了終結操作,或者添加了自己的IDisposable實現,那麽這些方法必須調用基類,否則,基類就不能正確地進行清理操作。同樣,finalize(終結操作)和Dispose參與分擔了壹些相同的職責。Finalize方法和Dispose方法的代碼幾乎相同。而且在重載接口函數後並不像妳預料的那樣工作。標準的Dispose模式中的第三個方法是壹個受保護的虛擬輔助函數,它分解出這些共同的事務,並給衍生類添加壹個用於釋放資源的”鉤子(hook)”。基類包含了核心接口的代碼。作為對Dispose()或終結操作的響應,該虛擬函數為衍生類清除資源提供了”鉤子”:
protected virtual void Dispose( bool isDisposing );
這個重載的方法實現支持finalize和Dispose的必要事務,由於它是虛擬的,它為所有的衍生類提供了壹個入口點。衍生類可以重載這個方法,為清除自己的資源提供適當的實現,同時還可以調用基類版本。當isDisposing為真(true)的時候,妳可以清除受控和非受控資源,當isDisposing為假(false)的時候,妳只能清除非受控資源。在這兩種情況下,妳都可以調用基類的Dispose(bool)方法,讓它清除自己的資源。
下面有壹個簡短的例子,它演示了妳在實現這種模式的時候所提供的代碼框架。MyResourceHog類演示了實現IDisposable接口、終結器的代碼,並建立了壹個虛擬的Dispose方法:
public class MyResourceHog : IDisposable
{
// 已經被處理過的標記
private bool _alreadyDisposed = false;
// 終結器。調用虛擬的Dispose方法
~MyResourceHog()
{
Dispose( false );
}
// IDisposable的實現
// 調用虛擬的Dispose方法。禁止Finalization(終結操作)
public void Dispose()
{
Dispose( true );
GC.SuppressFinalize( true );
}
// 虛擬的Dispose方法
protected virtual void Dispose( bool isDisposing )
{
// 不要多次處理
if ( _alreadyDisposed )
return;
if ( isDisposing )
{
// TODO: 此處釋放受控資源
}
// TODO: 此處釋放非受控資源。設置被處理過標記
_alreadyDisposed = true;
}
}
如果衍生類需要執行另外的清除操作,它應該實現受保護的Dispose方法:
public class DerivedResourceHog : MyResourceHog
{
// 它有自己的被處理過標記
private bool _disposed = false;
protected override void Dispose( bool isDisposing )
{
// 不要多次處理
if ( _disposed )
return;
if ( isDisposing )
{
// TODO: 此處釋放受控資源
}
// TODO: 此處釋放所有受控資源
// 讓基類釋放自己的資源。基類負責調用GC.SuppressFinalize( )
base.Dispose( isDisposing );
// 設置衍生類的被處理過標記
_disposed = true;
}
}