C#中的Finalize,Dispose,SuppressFinalize（转载）

MSDN建议按照下面的模式实现IDisposable接口：

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 = false;
}

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

 

这里解释一下C#中的Finalize函数，Finalize函数实际上可以理解为C#的析构函数，上面代码中的~Foo()就是Foo类的Finalize函数，默认情况下一个类的Finalize函数会在GC垃圾回收销毁该类的对象时被自动调用，但是我们可以通过调用GC.SuppressFinalize函数来告诉GC，在销毁一个类的对象时不调用Finalize函数，例如上面代码中的GC.SuppressFinalize(this)就是在告诉GC，当销毁Foo类的对象时，不要调用Foo类的Finalize函数~Foo()。

在这个模式中，void Dispose(bool disposing)函数通过一个disposing参数来区别当前是否是被Dispose()调用。如果是被Dispose()调用，那么需要同时释放 托管和非托管的资源。如果是被~Foo()（也就是C#的Finalize()）调用了，那么只需要释放非托管的资源即可。

这是因为，Dispose()函数是被其它代码显式调用并要求释放资源的，而Finalize是被GC调用的。在GC调用的时候Foo所引用的其它 托管对象可能还不需要被销毁，并且即使要销毁，也会由GC来调用。因此在Finalize中只需要释放非托管资源即可。另外一方面，由于在 Dispose()中已经释放了托管和非托管的资源，因此在对象被GC回收时再次调用Finalize是没有必要的，所以在Dispose()中调用 GC.SuppressFinalize(this)让GC进行垃圾回收时不要调用Finalize，从而避免调用Dispose(false)重复释放非托管的资源。

 

也就是说：

• 如果开发人员没有调用Foo类的Dispose()函数（例如开发人员不小心忘记了），那么Finalize函数~Foo()也会确保Foo类的非托管资源最终得到释放。
• 如果开发人员调用了Foo类的Dispose()函数，已经释放了Foo类的托管和非托管的资源，那么Finalize函数~Foo()就不会被调用，避免重复释放非托管资源。

然而，即使重复调用Finalize和Dispose也是不存在问题的，因为有变量m_disposed的存在，资源只会被释放一次，多余的调用会被忽略过去。

因此，上面的模式保证了：

1. Finalize只释放非托管资源；
2. Dispose释放托管和非托管资源；
3. 重复调用Finalize和Dispose是没有问题的；
4. Finalize和Dispose共享相同的资源释放策略，因此他们之间也是没有冲突的。

在C#中，这个模式需要显式地实现，其中C#的~Foo()函数代表了Finalize()。而在C++/CLI中，这个模式是自动实现的。

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

然而，毕竟这两个函数做的是同一件事情，因此MSDN建议的代码就是：

public void Close()
{
    Dispose();
}

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

public class Foo : IDisposable
{
    public void Close()
    {
        (this as IDisposable).Dispose();
    }

    void IDisposable.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 = false;
}

这里使用了一个所谓的接口显式实现：void IDisposable.Dispose()。这个显式实现只能通过接口来访问，但是不能通过实现类来访问。因此：

Foo foo = new Foo();

foo.Dispose(); // 错误

(foo as IDisposable).Dispose(); // 正确

using (foo) // 正确
{

}

补充：

1. Finalize方法（C#中是析构函数，以下称析构函数）是用于释放非托管资源的，而托管资源会由GC自动回收。所以，我们也可以这样来区分 托管和非托管资源。所有会由GC自动回收的资源，就是托管的资源，而不能由GC自动回收的资源，就是非托管资源。在我们的类中直接使用非托管资源的情况很少，所以基本上不用我们写析构函数。
2. 大部分的非托管资源会给系统带来很多负面影响，例如数据库连接不被释放就可能导致连接池中的可用数据库连接用尽。文件不关闭会导致其它进程无法读写这个文件等等。
3. 由于大多数的非托管资源都要求可以手动释放，所以，我们应该专门为释放非托管资源公开一个方法。实现IDisposable接口的Dispose方法是最好的模型，因为C#支持using语句块，可以在离开语句块时自动调用Dispose方法。
4. 虽然可以手动释放非托管资源，我们仍然要在析构函数中释放非托管资源，这样才是安全的应用程序。否则如果因为程序员的疏忽忘记了手动释放非托管资源， 那么就会带来灾难性的后果。所以说在析构函数中释放非托管资源，是一种补救的措施，至少对于大多数类来说是如此。
5. 由于析构函数的调用将导致GC对对象回收的效率降低，所以如果已经完成了析构函数该干的事情（例如释放非托管资源），就应当使用SuppressFinalize方法告诉GC不需要再执行某个对象的析构函数。
6. 析构函数中只能释放非托管资源而不能对任何托管的对象/资源进行操作。因为你无法预测析构函数的运行时机，所以，当析构函数被执行的时候，也许你进行操作的托管资源已经被释放了。这样将导致严重的后果。
7. （这是一个规则）如果一个类拥有一个实现了IDisposable接口类型的成员，并创建（注意是创建，而不是接收，必须是由类自己创建）它的实例对象，则这个类也应该实现IDisposable接口，并在Dispose方法中调用所有实现了IDisposable接口的成员的Dispose方法。只有这样，才能保证所有实现了IDisposable接口的类的对象的Dispose方法能够被调用到，确保可以手动释放任何需要释放的资源。

参考文献

原文链接