C#中标准Dispose模式的实现(转载)

时间:2022-05-19 08:32:56

需要明确一下C#程序(或者说.NET)中的资源。简单的说来,C#中的每一个类型都代表一种资源,而资源又分为两类:

托管资源:由CLR管理分配和释放的资源,即由CLR里new出来的对象;

非托管资源:不受CLR管理的对象,windows内核对象,如文件、数据库连接、套接字、COM对象等;

毫无例外地,如果我们的类型使用到了非托管资源,或者需要显式释放的托管资源,那么,就需要让类型继承接口IDisposable。这相当于是告诉调用者,该类型是需要显式释放资源的,你需要调用我的Dispose方法。

不过,这一切并不这么简单,一个标准的继承了IDisposable接口的类型应该像下面这样去实现。这种实现我们称之为Dispose模式:

publicclass SampleClass : IDisposable { //演示创建一个非托管资源 private IntPtr nativeResource = Marshal.AllocHGlobal(100); //演示创建一个托管资源 private AnotherResource managedResource =new AnotherResource(); privatebool disposed =false; ///<summary> /// 实现IDisposable中的Dispose方法 ///</summary> publicvoid Dispose() { //必须为true Dispose(true); //通知垃圾回收机制不再调用终结器(析构器) GC.SuppressFinalize(this); } ///<summary> /// 不是必要的,提供一个Close方法仅仅是为了更符合其他语言(如C++)的规范 ///</summary> publicvoid Close() { Dispose(); } ///<summary> /// 必须,以备程序员忘记了显式调用Dispose方法 ///</summary> ~SampleClass() { //必须为false Dispose(false); } ///<summary> /// 非密封类修饰用protected virtual /// 密封类修饰用private ///</summary> ///<param></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; } publicvoid SamplePublicMethod() { if (disposed) { thrownew 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方法,并没有实际的清理工作,它实际调用的是下面这个带布尔参数的受保护的虚方法: