天天看點

為什麼要實作 IDisposable 接口?

一、背景

最近在精讀 《CLR Via C#》和 《Effective C#》 的時候,發現的一個問題點。一般來說,我們實作

IDisposable

接口,是為了釋放托管資源和非托管資源。不過在 C# 類型定義裡面有一個功能類似的東西,那就是 終結器。

最開始我是學 C++ 的,之後學 C# 的時候發現這玩意兒不論是寫法和作用,都跟 C++ 裡面的 析構函數 一樣。在 C++ 裡面的析構函數是在對象釋放的時候會被調用,之後這個觀點一直被我帶到 C#,認為資源釋放的動作放在終結器不就行了麼。為什麼還要我實作

IDisposable

接口,然後讓使用者手動釋放呢?

C++ 版本的析構函數:

class Line
{
   public:
      Line();  
      ~Line(); 
 
    private:
      double length;
};
           

C# 版本的終結器:

public class Line
{
    private double _length;
    
    public Line()
    {
        
    }
    
    ~Line()
    {
        
    }
}
           

二、原因

說起這個原因,首先得從 C# 終結器的 調用時機 說起。終結器的調用是 CLR 在進行 GC 時,如果某個對象寫有終結器,即便它應該被釋放,也不會馬上回收該對象。而 C++ 的析構函數是确定性析構,取決于你調用 delete 的時機。

GC 會将其添加到一個隊列當中,單獨使用了一個 高優先級 線程去調用對象的終結器。因為要保證線程能夠通路到終結器對象,是以本該釋放的對象,以及對象相關的資源就 會被提升 1 代 ,會 增加記憶體占用。

一旦終結器方法帶有死循環,那麼 GC 将永遠無法釋放該資源,造成 記憶體洩漏。

除開記憶體占用增大的原因,如果你在終結器方法内部引用了其他帶終結器對象,GC 無法保證終結器調用順序,是以你可能通路到的對象是已經終結了的。

還有一種情況會導緻尴尬的記憶體洩漏,本來對象 A 應該被釋放了,結果你在終結器内部又讓其他的根保持對象的引用,又會讓這個對象複活。因為 GC 隻會執行一次帶終結器對象的終結器。執行一次過後,就再也不會執行對象的終結器了。

public class BadClass
{
    private static readonly List<BadClass> _list = new List<BadClass>();
    private string _msg;
    
    public BadClass(string msg)
    {
        _msg = (string)msg.Clone();
    }
    
    ~BadClass()
    {
        // 造成 _msg 的記憶體不會被釋放。
        _list.Add(this);
    }
}
           

三、最佳實踐

針對 Effective C# 所提出的最佳實踐,你應該為對象實作

IDisposable

接口,以釋放托管資源。如果你對象确實使用了非托管資源,那麼你也應該為其編寫終結器。因為非托管資源的,你不能保證調用者能夠顯示調用

Dispose()

方法,是以你得通過終結器來處理。

一個典型的

Dispose()

方法應該将托管資源、非托管資源全部進行釋放,設定對應的辨別表明對象已經被釋放了,阻止垃圾回收器重複清理該對象、保證方法的 幂等性。

public class FatherClass : IDisposable
{
    private bool isDisposed = false;
    
    public void Dispose()
    {
        Dispose(true);
        // 通知 GC,這個對象已經完全被清理。
        GC.SuppressFinalize(this);
    }
    
    ~FatherClass()
    {
        Dispose(false);
    }
    
    protected virtual Dispose(bool isDisposing)
    {
        if(isDisposed) return;
        
        if(isDisposing)
        {
            // 釋放托管資源。
        }
        
        // 釋放非托管資源。
        isDisposed = true;
    }
    
    public void TestMethod()
    {
        if(isDisposed)
        {
            throw new ObjectDisposedException("對象已經被釋放。");
        }
    }
}

public class ChildClass : FatherClass
{
    private bool isDisposed = false;
    
    protected override void Dispose(bool isDisposing)
    {
        if(isDisposed) return;
        
        if(isDisposing)
        {
            // 釋放托管資源。
        }
        
        base.Dispose(isDisposing);
        
        isDisposed = true;
    }
}
           

在上面的實踐中,我們提煉出了一個

void Dispose(bool)

方法,并将其設定為虛函數。這樣做的好處有兩點,第一點是友善子類重寫釋放邏輯,第二點是可以将終結器和

Dispose()

方法内部重複的代碼提煉出來。