正确实现IDisposable Dispose和Close的区别

怎样实现IDisposable接口

using System;

public class MyResource:IDisposable

{

    private bool m_disposed= false;//标识资源是否被释放过

    public void Dispose()

    {

       Dispose( true);

       GC. SuppressFinalize( this);//防止Finalize调用

    }

    protected virtual void Dispose( bool disposing)

    {

       if(!m_disposed)

       {

           if(disposing)

           {

              //释放托管资源

           }

           //释放非托管资源

           m_disposed= true;

       }

    }

    ~ MyResource()

    {

       Dispose( false);

    }

}

在.NET的对象中实际上有两个用于释放资源的函数：Dispose和Finalize。Finalize的目的是用于释放非托管的资源，而Dispose是用于释放所有资源，包括托管的和非托管的。

在这个模式中，void Dispose(bool disposing)函数通过一个disposing参数来区别当前是被Dispose()调用还是被析构函数调用（当disposing为“true”时，说明Dispose()是被程序显示调用的，需要释放托管资源和非托管资源；当disposing为“false”时，说明Dispose（）是被析构函数（也就是C#的Finalize(）)调用的，只需要释放非托管资源）。

这是因为，Dispose()函数是被其它代码在程序中显式调用并要求释放资源的，而Finalize是被GC调用的。在GC调用的时候MyResource所引用的其它托管对象可能还不需要被销毁，并且即使要销毁，也会由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#的析构函数~MyResource()代表了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 }
6
7 !Foo()
8 {
9     //释放非托管的资源
10 }
11

对于上面这个类，实际上C++/CLI生成对应的C#代码是这样的：
public class Foo

{

    private void ! Foo()

    {

       // 释放非托管资源

    }

  private void ~ Foo()

    {

       // 释放托管资源

       ! Foo();

    }

 

    public Foo()

    {

    }

 

    public void Dispose()

    {

       Dispose( true);

       GC. SuppressFinalize( this);

    }

 

  protected virtual void Dispose( bool disposing)

  {

    if (disposing)

    {

       ~ Foo();//释放托管资源和非托管资源´

    }

    else

    {

       try

       {

           ! Foo(); //释放非托管资源

       }

       finally

       {

           base. Finalize(); //调用基类的Finalize()

       }

    }

 }

 

  protected void Finalize()

 {

    //释放非托管资源

    Dispose( false); //可能是!Foo()调用Finalize()

 }

}

由于~Foo()和!Foo()不会被重复调用（至少MS这样认为），因此在这段代码中没有和前面m_disposed相同的变量，但是基本的结构是一样的。

并且，可以看到实际上并不是~Foo()和!Foo()就是Dispose和Finalize，而是C++/CLI编译器生成了两个Dispose和Finalize函数，并在合适的时候调用它们。C++/CLI其实已经做了很多工作，但是唯一的一个问题就是依赖于用户在~Foo()中调用!Foo()。

关于资源释放，最后一点需要提的是Close函数。在语义上它和Dispose很类似，按照MSDN的说法，提供这个函数是为了让用户感觉舒服一点，因为对于某些对象，例如文件，用户更加习惯调用Close()。

那么Dispose和Close到底有什么区别？

当我们开发C#代码的时候，经常碰到一个问题，有些class提供Close()，有些class提供Dispose()，那么Dispose和Close到底有什么区别？

首先，Dispose和Close基本上应该是一样的。Close是为了那些不熟悉Dispose的开发者设计的。因为基本上所有的developer都知道Close是干吗的(特别是对于那些有C++背景的developer)。

但是当我们写code时候，如果要实现Close和Dispose的时候，要注意Close和Dispose的设计模式。.net的一些class只提供Close，而且派生自IDisposable，并且隐藏了Dispose方法。是不是觉得很不明白了？

对这些class来说，关键在于它们显式的(explicitly)实现了IDisposable。对于隐式实现来说，你只需要调用"new A().Dispose()"，但是对于显式实现来说，Dispose不会是这个class的成员函数。唯一的调用方式是你先要cast到 IDisposable才行。(“new A().Dispose()”编译不过，但是“((IDisposable)new A()).Dispose()”可以编译过)。所以这样就符合了设计的要求：提供Close()，隐藏Dispose()，并且实现了 IDisposable接口。

在.net的framework里，Close()被设计成public的，并且在Close()里面call被隐藏的Dispose()； Dispose()去call另一个virtual的Dispose(bool)函数。所以如果你从这个class继承，你就必须实现Dispose (bool)方法。

调用者call Close()的时候就会call到你重载的那个Dispose(bool)方法去释放资源。

请参考 http://blogs.msdn.com/brada/archive/2003/07/06/50127.aspx

注意事项：
1，Close()不应该被定义成virtual。对于这个design pattern，Close()只是用来call那个隐藏的Dispose()，用户不应该改变Close的behavior。对于这个问题， System.IO.Stream也有设计问题。之所以有问题是为了满足向后兼容的需求。See http://msdn2.microsoft.com/en-us/library/ms227422.aspx. 文档里面提到虽然Close()是virtual的，但是不应该被override。

注，本文译自我们team manager Richard Wong的精彩讲解，贴于此处以期望能够对大家有所帮助。感谢Richard！

演示代码如下：


using System;

namespace ConsoleApplication
{
abstract class MyStream : IDisposable
{
public MyStream()
{
m_unmanagedResource = Marshal.AllocCoTaskMem(100);
m_bitmap = new Bitmap(50, 50);
}

#region IDisposable Members
void IDisposable.Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}

protected virtual void Dispose(bool isDisposing)
{
if (!m_disposed)
{
if (isDisposing)
{
m_bitmap.Dispose();
}
Marshal.FreeCoTaskMem(m_unmanagedResource);
m_disposed = true;
}
}

public void Close()
{
((IDisposable)this).Dispose();
}

~MyStream()
{
Dispose(false);
}

private IntPtr m_unmanagedResource; // Unmanaged resource
private Bitmap m_bitmap; // IDisposable managed resources
private bool m_disposed;

#endregion
}

class MyDerivedStream : MyStream
{
public MyDerivedStream()
{
m_anotherMemory = Marshal.AllocCoTaskMem(20);
m_anotherImage = new Bitmap(24, 24);
}

protected override void Dispose(bool isDisposing)
{
if (!m_disposed)
{
if (isDisposing)
{
m_anotherImage.Dispose();
}

Marshal.FreeCoTaskMem(m_anotherMemory);
base.Dispose(isDisposing);
m_disposed = true;
}
}

public static void Main(string[] args)
{
MyStream aStream = new MyDerivedStream();

aStream.Close(); // Allowed
// aStream.Dispose(); // Cannot compile

((IDisposable)aStream).Dispose(); // Allowed

//
// This one works as well, because newStream calls the explicit implemented
// IDisposable.Dispose method
//
using (MyStream newStream = new MyDerivedStream())
{
//
// Do something
//
}
}

private IntPtr m_anotherMemory;
private Bitmap m_anotherImage;
private bool m_disposed;
}
}