使用C#完成規(guī)范的 Dispose模式
發(fā)表時(shí)間:2024-06-02 來源:明輝站整理相關(guān)軟件相關(guān)文章人氣:
[摘要]本文講解的是你在建立包含內(nèi)存以外資源的類型,特別是處置非內(nèi)存資源的時(shí)候,如何編寫自己的資源管理代碼! ∥覀円呀(jīng)知道了處置那些占用非受控(unmanaged)資源的對象的重要性,現(xiàn)在應(yīng)該編寫資源管理代碼來處置那些包含非內(nèi)存資源的類型了。整個(gè).NET框架組件都使用一個(gè)標(biāo)準(zhǔn)的模式來處理非內(nèi)存資源。使用...
本文講解的是你在建立包含內(nèi)存以外資源的類型,特別是處置非內(nèi)存資源的時(shí)候,如何編寫自己的資源管理代碼。
我們已經(jīng)知道了處置那些占用非受控(unmanaged)資源的對象的重要性,現(xiàn)在應(yīng)該編寫資源管理代碼來處置那些包含非內(nèi)存資源的類型了。整個(gè).NET框架組件都使用一個(gè)標(biāo)準(zhǔn)的模式來處理非內(nèi)存資源。使用你建立的類型的用戶也希望你遵循這個(gè)標(biāo)準(zhǔn)的模式。標(biāo)準(zhǔn)的處理模式的思想是這樣的:當(dāng)客戶端記得的時(shí)候使用IDisposable接口釋放你的非受控資源,當(dāng)客戶端忘記的時(shí)候防護(hù)性地使用終結(jié)器(finalizer)。它與垃圾收集器(Garbage Collector)一起工作,確保只在必要的時(shí)候該對象才受到與終結(jié)器相關(guān)的性能影響。這是處理非受控資源的一條很好的途徑,因此我們應(yīng)該徹底地認(rèn)識(shí)它。
類層次體系中的根基類(root base class)必須實(shí)現(xiàn)IDisposable接口以釋放資源。這個(gè)類型還必須添加一個(gè)作為防御機(jī)制的終結(jié)器。所有這些程序都把釋放資源的工作委托給一個(gè)虛擬的方法,衍生的類可以根據(jù)自己的資源管理需求來重載該方法。只要衍生的類必須釋放自己的資源,并且它必須調(diào)用該函數(shù)的基類版本的時(shí)候,它才需要重載這個(gè)虛擬方法。
開始的時(shí)候,如果你的類使用了非內(nèi)存資源,它就必須含有一個(gè)終結(jié)器。你不能依賴客戶端總是調(diào)用Dispose()方法。因?yàn)楫?dāng)它們忘記這樣做的時(shí)候,你就面臨資源泄漏的問題。沒有調(diào)用Dispose是它們的問題,但是你卻有過失。用于保證非內(nèi)存資源被正確地釋放的唯一途徑是建立終結(jié)器。
當(dāng)垃圾收集器運(yùn)行的時(shí)候,它立即從內(nèi)存中刪除所有不帶終結(jié)器的垃圾對象。所有帶有終結(jié)器的對象仍然存在于內(nèi)存中。這些對象都被添加到終結(jié)隊(duì)列,垃圾收集器引發(fā)一個(gè)新線程,周期性地在這些對象上運(yùn)行終結(jié)器。在這些終結(jié)程序線程完成自己的工作之后,就可以從內(nèi)存中刪除垃圾對象了。需要終結(jié)的對象在內(nèi)存中停留的時(shí)間比沒有終結(jié)器的對象停留的時(shí)間長很多。但是你別無選擇。如果要使程序有防護(hù)性,在類型包含非受控資源的時(shí)候,你必須編寫一個(gè)終結(jié)器。但是也不用擔(dān)心性能問題。下一步確保了客戶端避免與終結(jié)相關(guān)的性能開銷。
實(shí)現(xiàn)IDisposable接口是一種標(biāo)準(zhǔn)的途徑,它通知用戶和運(yùn)行時(shí)系統(tǒng)持有資源的對象必須及時(shí)地釋放。IDisposable接口僅僅包含一個(gè)方法:
public interface IDisposable
{
void Dispose( );
}
你對IDisposable.Dispose()方法的實(shí)現(xiàn)(implementation)負(fù)責(zé)下面四個(gè)事務(wù):
1、釋放所有的非受控資源。
2、釋放所有的受控資源(包括未解開事件)。
3、設(shè)置標(biāo)志表明該對象已經(jīng)被處理過了。你必須在自己的公共方法中檢查這種狀態(tài)標(biāo)志并拋出ObjectDisposed異常(如果某個(gè)對象被處理過之后再次被調(diào)用的話)。
4、禁止終結(jié)操作(finalization)。你調(diào)用GC.SuppressFinalize(this)來完成這種事務(wù)。
通過實(shí)現(xiàn)IDisposable接口你完成了兩個(gè)事務(wù):你為客戶端及時(shí)地釋放自己持有的所有受控資源提供了機(jī)制;你為客戶端提供了一種釋放非受控資源的標(biāo)準(zhǔn)途徑。這是一個(gè)很大的進(jìn)步。當(dāng)你在類型中實(shí)現(xiàn)了Idisposable接口的時(shí)候,客戶端可以避免終結(jié)操作的開銷,你的類就成為.NET世界中的"良民"了。
但是在你建立的這種機(jī)制中仍然存在一些問題。怎樣在衍生類清理自己資源的時(shí)候同時(shí)也讓基類能夠清理資源?如果衍生類重載了終結(jié)操作,或者添加了自己的IDisposable實(shí)現(xiàn),那么這些方法必須調(diào)用基類,否則,基類就不能正確地進(jìn)行清理操作。同樣,finalize(終結(jié)操作)和Dispose參與分擔(dān)了一些相同的職責(zé)。Finalize方法和Dispose方法的代碼幾乎相同。而且在重載接口函數(shù)后并不像你預(yù)料的那樣工作。標(biāo)準(zhǔn)的Dispose模式中的第三個(gè)方法是一個(gè)受保護(hù)的虛擬輔助函數(shù),它分解出這些共同的事務(wù),并給衍生類添加一個(gè)用于釋放資源的"鉤子(hook)";惏撕诵慕涌诘拇a。作為對Dispose()或終結(jié)操作的響應(yīng),該虛擬函數(shù)為衍生類清除資源提供了"鉤子":
protected virtual void Dispose( bool isDisposing );
這個(gè)重載的方法實(shí)現(xiàn)支持finalize和Dispose的必要事務(wù),由于它是虛擬的,它為所有的衍生類提供了一個(gè)入口點(diǎn)。衍生類可以重載這個(gè)方法,為清除自己的資源提供適當(dāng)?shù)膶?shí)現(xiàn),同時(shí)還可以調(diào)用基類版本。當(dāng)isDisposing為真(true)的時(shí)候,你可以清除受控和非受控資源,當(dāng)isDisposing為假(false)的時(shí)候,你只能清除非受控資源。在這兩種情況下,你都可以調(diào)用基類的Dispose(bool)方法,讓它清除自己的資源。
下面有一個(gè)簡短的例子,它演示了你在實(shí)現(xiàn)這種模式的時(shí)候所提供的代碼框架。MyResourceHog類演示了實(shí)現(xiàn)IDisposable接口、終結(jié)器的代碼,并建立了一個(gè)虛擬的Dispose方法:
public class MyResourceHog : IDisposable
{
// 已經(jīng)被處理過的標(biāo)記
private bool _alreadyDisposed = false;
// 終結(jié)器。調(diào)用虛擬的Dispose方法
~MyResourceHog()
{
Dispose( false );
}
// IDisposable的實(shí)現(xiàn)
// 調(diào)用虛擬的Dispose方法。禁止Finalization(終結(jié)操作)
public void Dispose()
{
Dispose( true );
GC.SuppressFinalize( true );
}
// 虛擬的Dispose方法
protected virtual void Dispose( bool isDisposing )
{
// 不要多次處理
if ( _alreadyDisposed )
return;
if ( isDisposing )
{
// TODO: 此處釋放受控資源
}
// TODO: 此處釋放非受控資源。設(shè)置被處理過標(biāo)記
_alreadyDisposed = true;
}
}
如果衍生類需要執(zhí)行另外的清除操作,它應(yīng)該實(shí)現(xiàn)受保護(hù)的Dispose方法:
public class DerivedResourceHog : MyResourceHog
{
// 它有自己的被處理過標(biāo)記
private bool _disposed = false;
protected override void Dispose( bool isDisposing )
{
// 不要多次處理
if ( _disposed )
return;
if ( isDisposing )
{
// TODO: 此處釋放受控資源
}
// TODO: 此處釋放所有受控資源
// 讓基類釋放自己的資源;愗(fù)責(zé)調(diào)用GC.SuppressFinalize( )
base.Dispose( isDisposing );
// 設(shè)置衍生類的被處理過標(biāo)記
_disposed = true;
}
}
請注意,基類和衍生類都包含該對象的被處理過(disposed)標(biāo)記。這純粹是起保護(hù)作用。復(fù)制這個(gè)標(biāo)記可以封裝構(gòu)成某個(gè)對象的所有類釋放資源時(shí)產(chǎn)生的任何可能的錯(cuò)誤。
你必須編寫防護(hù)性的Dispose和finalize。對象的處理可以按任意次序進(jìn)行,你可能會(huì)遇到在調(diào)用自己類型的成員對象的Dispose()方法之前,該對象已經(jīng)被處理過了。你不應(yīng)該認(rèn)為這是問題,因?yàn)镈ispose()方法會(huì)被多次調(diào)用。如果它在已經(jīng)被處理過的對象上被調(diào)用,它就不執(zhí)行任何事務(wù)。Finalizer(終結(jié)器)也有類似的規(guī)則。如果你引用的對象仍然存在于內(nèi)存中,你就沒有必要檢查空引用(null reference)。但是,你引用的任何對象都可能被處理了,它也可能已經(jīng)被終結(jié)了。
這為我?guī)砹伺c處理或清除相關(guān)的任何方法的最重要的建議:你應(yīng)該僅僅釋放資源,在dispose方法中不要執(zhí)行任何其它操作。如果你在Dispose或finalize方法中執(zhí)行其它操作,都可能給對象的生命周期帶來嚴(yán)重的不良影響。對象在被構(gòu)造的時(shí)候才"出生",當(dāng)垃圾收集器收回它們的時(shí)候才"死亡"。當(dāng)你的程序再也不能訪問它們的時(shí)候,你可以認(rèn)為它們處于"昏睡"狀態(tài)。如果你不能到達(dá)(reach)某個(gè)對象,你就不能調(diào)用它的方法,對于所有的意圖和目的來說,它是死的。但是帶有終結(jié)器的對象被宣布死亡之前還有最后一口氣。終結(jié)器除了清理非受控資源之外不應(yīng)該執(zhí)行其它任何操作。如果某個(gè)終結(jié)器由于什么原因使某個(gè)對象又可以到達(dá)了,那么該對象就恢復(fù)(resurrected)了。即使它是從"昏睡"狀態(tài)醒來的,它也是"活著"的。下面是一個(gè)很明顯的例子:
public class BadClass
{
// 保存某個(gè)全局對象的引用
private readonly ArrayList _finalizedList;
private string _msg;
public BadClass( ArrayList badList, string msg )
{
// 緩沖該引用
_finalizedList = badList;
_msg = (string)msg.Clone();
}
~BadClass()
{
// 把該對象添加到列表中。這個(gè)對象是可到達(dá)的,不再是垃圾了。它回來了!
_finalizedList.Add( this );
}
}
當(dāng)某個(gè)BadClass對象執(zhí)行自己的終結(jié)器的時(shí)候,它向全局列表上添加了對自己的引用。這僅僅使自己可到達(dá)了,它活了過來!但是這樣操作所帶來的問題使任何人都會(huì)感到膽怯。該對象已經(jīng)被終結(jié)了,因此垃圾收集器相信不用再次調(diào)用它的終結(jié)器了。你真的需要終結(jié)一個(gè)被恢復(fù)的對象的時(shí)候,終結(jié)操作卻不會(huì)發(fā)生了。其次,你的一些資源可能不能用了。GC不會(huì)把終結(jié)器隊(duì)列中的對象可以到達(dá)的任何對象從內(nèi)存中移除,但是它可能已經(jīng)終結(jié)了這些對象。如果是這樣的話,那些對象一定不能再次使用了。盡管BadClass的成員仍然存在于內(nèi)存中,它們卻像被處理過或被終結(jié)了一樣。在C#語言中沒有控制終結(jié)次序的途徑。你不能使這種構(gòu)造工作更可靠。不要嘗試!
除了學(xué)院的練習(xí)作業(yè)之外,我從來沒有見到過如此明顯地使用被恢復(fù)對象的代碼。但是我看到有些代碼有這個(gè)傾向,它們在終結(jié)器中試圖執(zhí)行某些實(shí)際工作,當(dāng)終結(jié)器調(diào)用的某些函數(shù)保存了對該對象的引用的時(shí)候,它就正在把對象變成活動(dòng)的狀態(tài)。原則上我們必須非常仔細(xì)地檢查finalizer和Dispose方法中任何代碼。如果有些代碼除了釋放資源之外還執(zhí)行了其它的操作,我們就需要再檢查一次。這些操作在未來可能引起程序bug。請移除這些操作,并確保finalizer和Dispose()方法只釋放資源,不作其它任務(wù)事務(wù)。
在受控環(huán)境中,你不必為自己建立的每個(gè)類型編寫終結(jié)器,你只需要為存儲(chǔ)非受控類型,或者包含了實(shí)現(xiàn)IDisposable接口的成員的類型編寫終結(jié)器。即使你只需要Disposable接口,不需要finalizer,也應(yīng)該同時(shí)實(shí)現(xiàn)整個(gè)模式。否則,你會(huì)使衍生類的標(biāo)準(zhǔn)Dispose思想的實(shí)現(xiàn)變得很復(fù)雜,從而限制了衍生類的功能。請遵循前面談到的標(biāo)準(zhǔn)的Dispose思想,這將使你、你的類的用戶、從你的類型建立衍生類的用戶的生活更加輕松。