C#中標準Dispose模式的實現

作者: 陸敏技來源: 博客園發布時間: 2011-04-19 10:36 閱讀: 13269 次推薦: 5 原文鏈接 [收藏]

摘要：C#程序中的Dispose方法，一旦被調用了該方法的對象，雖然還沒有垃圾回收，但實際上已經不能再使用了。所以使用上要仔細考慮細節。

　　需要明確一下C#程序（或者說.NET）中的資源。簡單的說來，C#中的每一個類型都代表一種資源，而資源又分為兩類：

　　托管資源：由CLR管理分配和釋放的資源，即由CLR里new出來的對象；

　　非托管資源：不受CLR管理的對象，windows內核對象，如文件、數據庫連接、套接字、COM對象等；

　　毫無例外地，如果我們的類型使用到了非托管資源，或者需要顯式釋放的托管資源，那么，就需要讓類型繼承接口IDisposable。這相當于是告訴調用者，該類型是需要顯式釋放資源的，你需要調用我的Dispose方法。

　　不過，這一切并不這么簡單，一個標準的繼承了IDisposable接口的類型應該像下面這樣去實現。這種實現我們稱之為Dispose模式：

public class SampleClass : IDisposable
{
//演示創建一個非托管資源
private IntPtr nativeResource = Marshal.AllocHGlobal(100);
//演示創建一個托管資源
private AnotherResource managedResource = new AnotherResource();
private bool disposed = false;

/// <summary>
/// 實現IDisposable中的Dispose方法
/// </summary>
public void Dispose()
{
//必須為true
Dispose(true);
//通知垃圾回收機制不再調用終結器（析構器）
GC.SuppressFinalize(this);
}

/// <summary>
/// 不是必要的，提供一個Close方法僅僅是為了更符合其他語言（如C++）的規范
/// </summary>
public void Close()
{
Dispose();
}

/// <summary>
/// 必須，以備程序員忘記了顯式調用Dispose方法
/// </summary>
~SampleClass()
{
//必須為false
Dispose(false);
}

/// <summary>
/// 非密封類修飾用protected virtual
/// 密封類修飾用private
/// </summary>
/// <param name="disposing"></param>
protected virtual void Dispose(bool disposing)
{
if (disposed)
{
return;
}
if (disposing)
{
// 清理托管資源
if (managedResource != null)
{
managedResource.Dispose();
managedResource = null;
}
}
// 清理非托管資源
if (nativeResource != IntPtr.Zero)
{
Marshal.FreeHGlobal(nativeResource);
nativeResource = IntPtr.Zero;
}
//讓類型知道自己已經被釋放
disposed = true;
}

public void SamplePublicMethod()
{
if (disposed)
{
throw new ObjectDisposedException("SampleClass", "SampleClass is disposed");
}
//省略
}
}

　　在Dispose模式中，幾乎每一行都有特殊的含義。

　　在標準的Dispose模式中，我們注意到一個以~開頭的方法：

/// <summary>
/// 必須，以備程序員忘記了顯式調用Dispose方法
/// </summary>
~SampleClass()
{
//必須為false
Dispose(false);
}

　　這個方法叫做類型的終結器。提供終結器的全部意義在于：我們不能奢望類型的調用者肯定會主動調用Dispose方法，基于終結器會被垃圾回收器調用這個特點，終結器被用做資源釋放的補救措施。

　　一個類型的Dispose方法應該允許被多次調用而不拋異常。鑒于這個原因，類型內部維護了一個私有的布爾型變量disposed：

private bool disposed = false;

　　在實際處理代碼清理的方法中，加入了如下的判斷語句：

if (disposed)
{
return;
}
//省略清理部分的代碼，并在方法的最后為disposed賦值為true
disposed = true;

　　這意味著類型如果被清理過一次，則清理工作將不再進行。

　　應該注意到：在標準的Dispose模式中，真正實現IDisposable接口的Dispose方法，并沒有實際的清理工作，它實際調用的是下面這個帶布爾參數的受保護的虛方法：

/// <summary>
/// 非密封類修飾用protected virtual
/// 密封類修飾用private
/// </summary>
/// <param name="disposing"></param>
protected virtual void Dispose(bool disposing)
{
//省略代碼
}

　　之所以提供這樣一個受保護的虛方法，是為了考慮到這個類型會被其他類繼承的情況。如果類型存在一個子類，子類也許會實現自己的Dispose模式。受保護的虛方法用來提醒子類必須在實現自己的清理方法的時候注意到父類的清理工作，即子類需要在自己的釋放方法中調用base.Dispose方法。

　　還有，我們應該已經注意到了真正撰寫資源釋放代碼的那個虛方法是帶有一個布爾參數的。之所以提供這個參數，是因為我們在資源釋放時要區別對待托管資源和非托管資源。

　　在供調用者調用的顯式釋放資源的無參Dispose方法中，調用參數是true：

public void Dispose()
{
//必須為true
Dispose(true);
//其他省略
}

　　這表明，這個時候代碼要同時處理托管資源和非托管資源。

　　在供垃圾回收器調用的隱式清理資源的終結器中，調用參數是false：

~SampleClass()
{
//必須為false
Dispose(false);
}

　　這表明，隱式清理時，只要處理非托管資源就可以了。

　　那么，為什么要區別對待托管資源和非托管資源。在認真闡述這個問題之前，我們需要首先弄明白：托管資源需要手動清理嗎？不妨先將C#中的類型分為兩類，一類繼承了IDisposable接口，一類則沒有繼承。前者，我們暫時稱之為非普通類型，后者我們稱之為普通類型。

　　非普通類型因為包含非托管資源，所以它需要繼承IDisposable接口，但是，這個包含非托管資源的類型本身，它是一個托管資源。所以說，托管資源需要手動清理嗎？這個問題的答案是：托管資源中的普通類型，不需要手動清理，而非普通類型，是需要手動清理的（即調用Dispose方法）。

　　Dispose模式設計的思路基于：如果調用者顯式調用了Dispose方法，那么類型就該按部就班為自己的所以資源全部釋放掉。如果調用者忘記調用Dispose方法，那么類型就假定自己的所有托管資源（哪怕是那些上段中闡述的非普通類型）全部交給垃圾回收器去回收，而不進行手工清理。理解了這一點，我們就理解了為什么Dispose方法中，虛方法傳入的參數是true，而終結器中，虛方法傳入的參數是true。

　　注意：我們提到了需要及時釋放資源，卻并沒有進一步細說是否需要及時讓引用等于null這一點。有一些人認為等于null可以幫助垃圾回收機制早點發現并標識對象是垃圾。其他人則認為這沒有任何幫助。