正确实现 IDisposable

正确实现 IDisposable


Author:
Andrew Xu

From:
Andrew Xu

.NET中用于释放对象资源的接口是IDisposable,但是这个接口的实现还是比较有讲究的,此外还有Finalize和Close两个函数。

  public class Foo: IDisposable
{
    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    protected virtual void Dispose(bool disposing)
    {
        if (!m_disposed)
        {
            if (disposing)
            {
              // Release managed resources
            }
 
            // Release unmanaged resources
 
            m_disposed = true;
        }
    }
 
    "Foo()
    {
        Dispose(false);
    }
 
    private bool m_disposed;
}
 

在.NET的对象中实际上有两个用于释放资源的函数:Dispose和Finalize。Finalize的目的是用于释放非托管的资源,而Dispose是用于释放所有资源,包括托管的和非托管的。 
 
在这个模式中,void Dispose(bool disposing)函数通过一个disposing参数来区别当前是否是被Dispose()调用。如果是被Dispose()调用,那么需要同时释放托管和非托管的资源。如果是被"Foo()(也就是C#的Finalize())调用了,那么只需要释放非托管的资源即可。 
 
这是因为,Dispose()函数是被其它代码显式调用并要求释放资源的,而Finalize是被GC调用的。在GC调用的时候Foo所引用的其它托管对象可能还不需要被销毁,并且即使要销毁,也会由GC来调用。因此在Finalize中只需要释放非托管资源即可。另外一方面,由于在Dispose()中已经释放了托管和非托管的资源,因此在对象被GC回收时再次调用Finalize是没有必要的,所以在Dispose()中调用GC.SuppressFinalize(this)避免重复调用Finalize。 
 
然而,即使重复调用Finalize和Dispose也是不存在问题的,因为有变量m_disposed的存在,资源只会被释放一次,多余的调用会被忽略过去。 
 
因此,上面的模式保证了: 
 
1、 Finalize只释放非托管资源; 
2、 Dispose释放托管和非托管资源; 
3、 重复调用Finalize和Dispose是没有问题的; 
4、 Finalize和Dispose共享相同的资源释放策略,因此他们之间也是没有冲突的。 
 
在C#中,这个模式需要显式地实现,其中C#的"Foo()函数代表了Finalize()。而在C  /CLI中,这个模式是自动实现的,C  的类析构函数则是不一样的。 
 
按照C  语义,析构函数在超出作用域,或者delete的时候被调用。在Managed C  (即.NET 1.1中的托管C  )中,析构函数相当于CLR中的Finalize()方法,在垃圾收集的时候由GC调用,因此,调用的时机是不明确的。在.NET 2.0的C  /CLI中,析构函数的语义被修改为等价与Dispose()方法,这就隐含了两件事情: 
 
1、 所有的C  /CLI中的CLR类都实现了接口IDisposable,因此在C#中可以用using关键字来访问这个类的实例。 
2、 析构函数不再等价于Finalize()了。 
 
对于第一点,这是一件好事,我认为在语义上Dispose()更加接近于C  析构函数。对于第二点,Microsoft进行了一次扩展,做法是引入了“!”函数,如下所示: 
1 public ref class Foo
2 {
3 public:
4        Foo();
5        "Foo();      // destructor
6        !Foo();      // finalizer
7 };
8
 
“!”函数(我实在不知道应该怎么称呼它)取代原来Managed C  中的Finalize()被GC调用。MSDN建议,为了减少代码的重复,可以写这样的代码: 
1 "Foo()
2 {
3    //释放托管的资源
4    this->!Foo();
5 }

7 !Foo()
8 {
9    //释放非托管的资源
10 }
11
 
对于上面这个类,实际上C  /CLI生成对应的C#代码是这样的: 
 
 
1 public class Foo
2 {
3    private void !Foo()
4    {
5        // 释放非托管的资源
6    }

8    private void "Foo()
9    {
10        // 释放托管的资源
11        !Foo();
12    }
13 
14    public Foo()
15    {
16    }
17 
18    public void Dispose()
19    {
20        Dispose(true);
21        GC.SuppressFinalize(this);
22    }
23 
24    protected virtual void Dispose(bool disposing)
25    {
26        if (disposing)
27        {
28            "Foo();
29        }
30        else
31        {
32            try
33            {
34              !Foo();
35            }
36            finally
37            {
38              base.Finalize();
39            }
40        }
41    }
42 
43    protected void Finalize()
44    {
45        Dispose(false);
46    }
47 }
48
 
由于"Foo()和!Foo()不会被重复调用(至少MS这样认为),因此在这段代码中没有和前面m_disposed相同的变量,但是基本的结构是一样的。 
 
并且,可以看到实际上并不是"Foo()和!Foo()就是Dispose和Finalize,而是C  /CLI编译器生成了两个Dispose和Finalize函数,并在合适的时候调用它们。C  /CLI其实已经做了很多工作,但是唯一的一个问题就是依赖于用户在"Foo()中调用!Foo()。 
 
关于资源释放,最后一点需要提的是Close函数。在语义上它和Dispose很类似,按照MSDN的说法,提供这个函数是为了让用户感觉舒服一点,因为对于某些对象,例如文件,用户更加习惯调用Close()。 
 
然而,毕竟这两个函数做的是同一件事情,因此MSDN建议的代码就是:
 

1 public void Close()
2 {
3    Dispose(();
4 }
5
6
这里直接调用不带参数的Dispose函数以获得和Dispose相同的语义。这样似乎就圆满了,但是从另外一方面说,如果同时提供了Dispose和Close,会给用户带来一些困惑。没有看到代码细节的前提下,很难知道这两个函数到底有什么区别。因此在.NET的代码设计规范中说,这两个函数实际上只能让用户用一个。因此建议的模式是: 
1 public class Foo: IDisposable
2 {
3    public void Close()
4    {
5        Dispose();
6    }

8    void IDisposable.Dispose()
9    {
10        Dispose(true);
11        GC.SuppressFinalize(this);
12    }
13 
14    protected virtual void Dispose(bool disposing)
15    {
16        // 同前
17    }
18 }
19
 
这里使用了一个所谓的接口显式实现:void IDisposable.Dispose()。这个显式实现只能通过接口来访问,但是不能通过实现类来访问。因此: 
 
1 Foo foo = new Foo();
2
3 foo.Dispose(); // 错误
4 (foo as IDisposable).Dispose(); // 正确
5
 
 
这样做到了兼顾两者。对于喜欢使用Close的人,可以直接用 foo.Close(),并且他看不到 Dispose()。对于喜欢Dispose的,他可以把类型转换为 IDisposable 来调用,或者使用using语句。两者皆大欢喜!    (2007-1-17:10:17)

 感谢原创者的辛勤劳动,希望对您有所帮助,转载请注明原出处。
 您可能对 [C#] 的这些文章也感兴趣:

C#基础学习——异步编程篇
QQ空间及邮箱验证码登录的校验方式及自动登录的解决方案
NET框架与网络服务(下)
C# 对 MS Word的表格中提取指定单元格的数据
C#弹出窗口杀手
.net的reflection(2)
C#实现web信息自动抓取
用设计模式固化你的C#程序(尾篇一)
.net程序员的盲点(二):两个“属性”引起的歧异
C# API方式串口读写