淺談C#中標準Dispose模式的實現

leintor發表於2012-08-04
C#模式

C#程式中的Dispose方法，一旦被呼叫了該方法的物件，雖然還沒有垃圾回收，但實際上已經不能再使用了。所以使用上要仔細考慮細節。

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

託管資源：由CLR管理分配和釋放的資源，即由CLR裡new出來的物件；

非託管資源：不受CLR管理的物件，windows核心物件，如檔案、資料庫連線、套接字、COM物件等；

毫無例外地，如果我們的型別使用到了非託管資源，或者需要顯式釋放的託管資源，那麼，就需要讓型別繼承介面IDisposable。這相當於是告訴呼叫者，該型別是需要顯式釋放資源的，你需要呼叫我的Dispose方法。

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

  1. public class SampleClass : IDisposable    
  2.   {        
  3.   //演示建立一個非託管資源          
  4. private IntPtr nativeResource = Marshal.AllocHGlobal(100);          
  5. //演示建立一個託管資源          
  6. private AnotherResource managedResource = new AnotherResource();          
  7. private bool disposed = false;         
  8.  ///           
  9. /// 實現IDisposable中的Dispose方法         
  10.  ///           
  11. public void Dispose()       
  12.    {             
  13.  //必須為true             
  14.  Dispose(true);             
  15.  //通知垃圾回收機制不再呼叫終結器（析構器）         
  16.    GC.SuppressFinalize(this);       
  17.    }         
  18.  ///          
  19.  /// 不是必要的，提供一個Close方法僅僅是為了更符合其他語言（如C++）的規範          
  20. ///           
  21. public void Close()        
  22.   {            
  23.   Dispose();       
  24.    }        
  25.   ///        
  26.    /// 必須，以備程式設計師忘記了顯式呼叫Dispose方法      
  27.     ///          
  28.  ~SampleClass()        
  29.   {          
  30.     //必須為false           
  31.    Dispose(false);      
  32.     }          
  33. ///           
  34. /// 非密封類修飾用protected virtual        
  35.   /// 密封類修飾用private        
  36.   ///          
  37.  ///     
  38.       protected virtual void Dispose(bool disposing)          
  39. {             
  40.  if (disposed)           
  41.    {               
  42.    return;          
  43.     }          
  44.     if (disposing)         
  45.      {             
  46.      // 清理託管資源              
  47.     if (managedResource != null)              
  48.   {                  
  49.     managedResource.Dispose();                
  50.     managedResource = null;              
  51.     }       
  52.        }            
  53.   // 清理非託管資源           
  54.    if (nativeResource != IntPtr.Zero)         
  55.    {              
  56.     Marshal.FreeHGlobal(nativeResource);        
  57.         nativeResource = IntPtr.Zero;        
  58.       }             
  59.  //讓型別知道自己已經被釋放           
  60.    disposed = true;    
  61.       }     
  62.      public void SamplePublicMethod()       
  63.    {             
  64.  if (disposed)         
  65.      {               
  66.    throw new ObjectDisposedException("SampleClass", "SampleClass is disposed");       
  67.        }        
  68.       //省略        
  69.   }    } 

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

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

  1. ///        
  2.   /// 必須，以備程式設計師忘記了顯式呼叫Dispose方法      
  3.    ///         
  4.  ~SampleClass()       
  5.   {             
  6. //必須為false           
  7.   Dispose(false);     
  8.     }  

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

一個型別的Dispose方法應該允許被多次呼叫而不拋異常。鑑於這個原因，型別內部維護了一個私有的布林型變數disposed：

  1. private bool disposed = false; 

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

  1. if (disposed)      
  2.         {               
  3.    return;          
  4.     }             
  5.  //省略清理部分的程式碼，並在方法的最後為disposed賦值為true              
  6. disposed = true; 

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

應該注意到：在標準的Dispose模式中，真正實現IDisposable介面的Dispose方法，並沒有實際的清理工作，它實際呼叫的是下面這個帶布林引數的受保護的虛方法：

  1.       ///        
  2.  /// 非密封類修飾用protected virtual        
  3. /// 密封類修飾用private       
  4.  ///         
  5. ///        
  6.  protected virtual void Dispose(bool disposing)      
  7.   {            
  8. //省略程式碼    
  9.     } 

之所以提供這樣一個受保護的虛方法，是為了考慮到這個型別會被其他類繼承的情況。如果型別存在一個子類，子類也許會實現自己的Dispose模式。受保護的虛方法用來提醒子類必須在實現自己的清理方法的時候注意到父類的清理工作，即子類需要在自己的釋放方法中呼叫base.Dispose方法。
還有，我們應該已經注意到了真正撰寫資源釋放程式碼的那個虛方法是帶有一個布林引數的。之所以提供這個引數，是因為我們在資源釋放時要區別對待託管資源和非託管資源。

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

  1. public void Dispose()      
  2.     {            
  3.   //必須為true         
  4.      Dispose(true);        
  5.       //其他省略        
  6.   } 

這表明，這個時候程式碼要同時處理託管資源和非託管資源。

在供垃圾回收器呼叫的隱式清理資源的終結器中，呼叫引數是false：

  1. ~SampleClass()        
  2.   {         
  3.      //必須為false         
  4.      Dispose(false);    
  5.       } 

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

那麼，為什麼要區別對待託管資源和非託管資源。在認真闡述這個問題之前，我們需要首先弄明白：託管資源需要手動清理嗎？不妨先將C#中的型別分為兩類，一類繼承了IDisposable介面，一類則沒有繼承。前者，我們暫時稱之為非普通型別，後者我們稱之為普通型別。非普通型別因為包含非託管資源，所以它需要繼承IDisposable介面，但是，這個包含非託管資源的型別本身，它是一個託管資源。所以說，託管資源需要手動清理嗎？這個問題的答案是：託管資源中的普通型別，不需要手動清理，而非普通型別，是需要手動清理的（即呼叫Dispose方法）。

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

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

來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/20200170/viewspace-739839/，如需轉載，請註明出處，否則將追究法律責任。

相關文章