Dispose Pattern

 

(1). When trying to clean up unmanaged resources(like File Handle、Mutex、Network Handle、Database Connection、Socket、GDI Object) , GC can not collect autotically. GC only works for managed resources. So these unmanaged resources have to be cleaned up manually.

 

(2). To manually cleaned up unmanaged resources, we can call calling a Finalize method . But it is not recommented for some reasons. So to properly dispose of unmanaged resources, it is recommended that you implement a public Dispose or Close method that executes the necessary cleanup code for the object which is called Disposed pattern.

 

Sample code From MSDN

 

 

 class X: IDisposable{
        public X(?…){
                … initialize resources … 
        }

        ~X(){
                ?… release resources ?… 
        }

        public void Dispose(){
                // this is the same as calling ~X()
                Finalize(); 
                // no need to finalize later
                System.GC.SuppressFinalize(this); 
        }
   };

 

 (ZT)

http://www.365tech.net/ASP_DOT_NET/31799

.net内存回收与Dispose﹐Close﹐Finalize方法

一. net的对象使用一般分为三种情况﹕

1.创建对象
2.使用对象
3.释放对象

二.创建对象
1.创建对象实际分为两个步骤﹕变量类型宣告和初始化对象

2.变量类型宣告(declare),如﹕

FileStream fs
这行代码会在当前的变量作用域空间(栈或堆)里建立一个叫做fs的变量﹐至少四个字节吧(因为要存一个对象的地址)

3.初始化对象
对象在使用(调用其方法或属性)前﹐必须进行初始化。
如﹕

fs = new FileStream(@"C:\test.txt",FileMode.OpenOrCreate);
这行代码会分成3个步骤﹕
a.在托管堆中分配一块内存﹐其大小等于FileStream中所有字段(当然不包括静态的)的内存总和加上MS认为需要的其它东东。
b.初始化对象的字段(值类型的把其位全部初始化成0,对象初始化为null﹐当然string是一个例外﹐它被初始化成空字符串)
c.调用FileStream相应的构造器﹐这里会初始化一个非托管资源(文件)的私有字段。

三.使用对象
使用对象就没什么讲的﹐就是调用对象的方法(或属性等)来完成某个功能当然为了释放对象而调用的方法其范畴应不属于此类中(现在提到的Finalize等)

四.释放对象
1.释放对象也就是说这个对象我已经不需要了﹐现在我要把其释放﹐以便把其在堆上所占用的内存空间给收回来(当然变量名的内存空间就不需要管了﹐因为它会随其作用域自动消失)

2. .net自动进行内存管理﹐也就是说当它判断一个对象没有用了(当然有自己的算法)﹐它就会将其内存给自动收回来﹐但是其收回的时间一般不确定(当.net认为内存紧张时﹐它就会开始)

BTW:其实我们就是想自己收回对象的内存也不可能﹐因为MS没有提供途径(GC.Collect也是启动.net的内存收集功能)

五.第一个结论
在net中使用对象很简单﹐创建对象之后直接使用就可以了﹐不用了也不要去管它﹐垃圾收集器会帮你把内存要回来的。

六.例外
当对象的成员引用了一个非托管资源时(不在托管堆上分配的内存或资源﹐像文件﹐数据库连接等等)﹐下面以一个例子来说明﹕
System.IO.FileStream类别﹐这是.net基本类库提供的一个非托管资源(文件)封装对象(用Reflector工具反编译mscorlib.dll可见其代码)

1.FileStream毫无疑问封装了一个非托管资源

观其源代码发现有这样一个私有成员﹕

private SafeFileHandle _handle;
 通过构造器调用的Init方法可以发现这个成员的初始化代码﹕

this._handle = Win32Native.SafeCreateFile(text2, num1, share, secAttrs, mode, num2, 
Win32Native.NULL);
 而后者实际上就是kernel32.dll中的CreateFile方法﹐它返回一个HANDLE(即非托管资源引用)

2.我们先来使用这个类别﹕

 1using System;
 2using System.IO;
 3
 4public class TestFileStream
 5{
 6    public static void Main(string[] args)
 7    {   
 8           //创建一个FileStream对象
 9        FileStream fs = new FileStream(@"C:\test.txt",FileMode.OpenOrCreate);       
10        Console.WriteLine("您可以尝试在系统中删除c盘下的test.txt(回车键继续)");
11        //暂停程序执行﹐并尝试在系统中删除那个文件
12        Console.ReadLine();
13
14        //删除文件测试
15        try
16        {
17            File.Delete(@"c:\test.txt");
18        }
19        catch (IOException ex)
20        {
21            Console.WriteLine("[Error]程序删除文件失败﹕{0}",ex.Message);
22        }
23    }
24}

3.在程序挂起时(Console.ReadLine等待输入)﹐删除文件会失败﹐很容易理解﹐因为文件打开后没有将其关闭﹐系统不知道这个文件是否还有用﹐所以帮我们保护这个文件(理所当然﹐那个非托管资源所使用的内存还被程序占用着)

4.但是在程序执行完后﹐我们再尝试删除文件﹐成功﹗为什么?(fs不是没有关闭那个SafeFileHandle吗?)
当然您可以说﹐windows操作系统在一个进程结束后会自动回收其资源﹐没错(但是如果是com就惨了﹐因为com是存在于自己的独立进程内﹐而操作系统不负责这个:(   )﹐不过这里不是因为windows操作系统的功能﹐而是.net垃圾收集器帮的忙。

5.看下面这个例子

 1using System;
 2using System.IO;
 3
 4public class TestFileStream
 5{
 6    public static void Main(string[] args)
 7    {
 8        //创建一个FileStream对象
 9        FileStream fs = new FileStream(@"C:\test.txt", FileMode.OpenOrCreate);
10        Console.WriteLine("您可以尝试在系统中删除c盘下的test.txt(回车键继续)");
11        //暂停程序执行﹐并尝试在系统中删除那个文件
12        Console.ReadLine();
13
14        /**//*进行垃圾收集*/
15        GC.Collect();
16        Console.WriteLine("再删一下试试");
17        Console.ReadLine();
18    }
19}
 6.注意中间那行代码:

GC.Collect();
这是强制要.net垃圾收集器进行垃圾收集。
我们再去尝试删除test.txt﹐居然可以被删除了﹐为什么呀?(fs不是没有关闭那个SafeFileHandle吗?)﹐让我细细道来﹕

7.我们首先了解一下.net垃圾收集器进行垃圾收集的四种时机(参见﹕.net框架程序设计 李建忠译)
a.最常见的﹕当.net觉得合适时﹐例如它感到内存紧张了(朮语称为﹕0代对象充满)
b.微软强烈不建议使用的﹕GC的Collect方法调用(就是我们上面用的这种啦﹐因为会降低性能﹐会挂起进程, 等等﹐反正听微软的吧。当然某些时候可以用﹐就像我上面用来测试的代码﹐呵呵...)
c.应用程序域卸载时(AppDomain)
d.CLR被关闭时

8.现在我们可以明白第1个例子为什么在程序结束后文件可以被删除﹐因为CLR被关闭时﹐.net执行了垃圾收集(也就是等同于第二个例子的GC.Collect()代码)

9.所以现在所有的问题都集中到垃圾收集上面﹐它做了什么?

a.垃圾收集器在判断一个对象不会再被引用到后﹐就开始对它进行垃圾收集(即回收内存)
b.清空内存(即把托管堆中的内存收回来)
c.但是对象的有些字段引用到了非托管资源怎么办?如FileStream的_handle
d.所以我们必须告诉垃圾收集器﹐在你回收我的内存之前﹐先帮我执行一个方法来收回我的非托管资源﹐以免托管堆的内存被你回收了﹐而我引用的非托管资源的内存却被泄漏了。
e.这个方法就是Finalize()﹐也就是C#的 ~ClassName() 方法(同C++中的析构语法)
f.所以一个对象如果存在Finalize方法时﹐垃圾收集器在收回它的内存之前就会自动调用这个方法
g.这样我们就可以把那些东东(非托管资源)给清理干净了

由此看来﹐垃圾收集器提供的这种机制就是为了更好的完善.net的自动内存管理的功能﹐让我们也可以参与到垃圾收集中去

10.我们再来看看GC.Collect()这行代码或CLR关闭时.Net做了什么﹕
a.垃圾收集器启动﹐发现fs引用的那个对象已经没用了(当然CLR关闭时才不管你有没有用﹐通通回收)﹐于是对它进行内存回收
b.发现fs的类型﹕FileStream提供了Finalize方法﹐于是先调用这个方法
(以下通过Reflector继续)
c.Finalize方法中有 this._handle.Dispose()代码﹐于是调用SafeHandler.Dispose()
d.接着转到(当然好多个圈﹐您悠着点...)SafeFileHandle.ReleaseHandle方法﹐发现代码﹕Win32Native.CloseHandle() (即关闭非托管资源--文件HANDLE)

真相大白﹕原来是垃圾收集器帮我们关闭了那个非托管资源(当然还是通过我们自己写的Finalize方法)﹐因此后面就可以删除文件了。

11.有人会问﹕好像我们平时在使用FileStream对象时﹐没这么复杂呀?
答﹕Very Good!

一部分人﹕是因为大家都和我的例1一样有好运气﹐那个C盘下的test.txt文件自从被创建后﹐我压根就不会再去用它﹐管它这部分资源有没有被泄漏﹐有没有被锁定﹐最后程序结束时﹐被垃圾收集器帮了忙﹐把忘了关闭的文件HANDLE给收回来了。

剩下的一部分人﹕在程序里埋下了一颗"哑弹"﹐不知什么时候会爆炸﹐就像我例子中的File.Delete方法就出现了异常。

(不过我觉得)绝大多数人﹕是在看了很多诸如.net编程忠告﹐Microsoft强烈建议﹐MSDN标准做法等等等等( 还有我这篇blog﹐呵呵)之后﹐知道了在使用如FileStream,SqlConnection这些东东时﹐必须将其Close。

12.Close与Dispose
查看我们那两个例子的代码﹐都是不标准的﹐正确做法应该在使用完那个FileStream后﹐调用fs.Close()将其关闭﹐以保证资源的安全。

附﹕正确做法

 1using System;
 2using System.IO;
 3
 4public class TestFileStream
 5{
 6    public static void Main(string[] args)
 7    {
 8        //创建一个FileStream对象
 9        FileStream fs = new FileStream(@"C:\test.txt", FileMode.OpenOrCreate);
10
11        /**//*在用完FileStream后关闭*/
12        fs.Close();
13
14        //删除文件测试
15        try
16        {
17            File.Delete(@"c:\test.txt");
18        }
19        catch (IOException ex)
20        {
21            Console.WriteLine("[Error]程序删除文件失败﹕{0}", ex.Message);
22        }
23    }
24}

13.有人举手﹐讲这么多﹐早告诉我调用fs.Close不就得了。
哥们﹐fs.Close()方法是由您写的﹐调不调用﹐手在您身上﹐您不调用的话﹐哪天程序出了问题﹐您有会叫﹕微软真垃圾﹐.net真不稳定﹐还是java好﹐安全﹐可靠...    为防您的国骂﹐MS只好在垃圾收集中加这一款﹐以防不测...

14.Dispose模式
认真查看.net类库中的那些基本类别﹐凡是有Finalize方法的类别﹐基本上都提供了诸如Dispose,Close,Dispose(bool)等方法(FileStream也不例外)

15.其实不管是Dispose,Close,Finalize方法﹐最终应该都是执行相同的代码
区别﹕
Finalize方法﹕只能由微软调用
Dispose和Close方法﹕提供给您调用
因此在您使用完那些类别后﹐那就直接调用Close吧(没有Close﹐再调用Dispose方法)﹐当然万一您忘了﹐也别担心﹐还有垃圾收集器帮您垫后。

七.第二个结论﹕
1.在您开发一个封装非托管资源(即类中的字段引用到了非托管资源)的类别时﹕
A:强烈建议您提供Finalize方法进行非托管资源的释放﹐.net垃圾收集器不会帮您自动回收那部分资源﹐而是通过调用您的Finalize方法来帮您释放。(这样可以保证﹕在使用您类别的那位程序员忘了手动回收内存时﹐还可通过垃圾收集器来补救)

B.强烈建议您提供一个Close或Dispose方法﹐以便使用您类别的程序员可以手动释放您的类别中的非托管资源。(参见.net框架程序设计 自动内存管理一章实现Dispose模式)

C.如果类别封装了像FileStream这样的对象(即对非托管资源的再次封装)时﹐一般也应该提供一 个Close或Dispose方法﹐除非您的这个成员保证在每次使用后﹐都被正常的关闭﹐即对调用者透明。

2.在您使用一个封装非托管资源的类别时﹕
A:强烈建议您在明确知道这个类别没有用之后﹐调用其提供的Close或Dispose方法手动释放其非托管资源的 内存。有道是﹕有借有还﹐再借不难;借了不还﹐再借休想~~

B:注意在手动释放后﹐不要再调用该对象的相关方法了﹐因为对象已经损毁了

再次BTW:不管是Finalize﹐Close还是Dispose﹐您都无法显式释放托管堆内存﹐它们永远是微软的"私人财产 "﹕)

 

(ZT)

 

 

1. .Net Framework 提供Object.Finalize 方法，用来清理这个object有关的unmanaged resource。
Unmanaged resource:

如数据库连接，网络连接，打开的文件，GDI对象（字体等），GC不知道如何释放这些资源。

在C#里，不能直接调用Finalize方法，必须通过析构函数来间接地调用。

class Car

{

    ~ Car()  // destructor

    {
        // cleanup statements...
    }

}

析构函数里隐式调用了基类的Finalize方法，上面的代码可以翻译如下：

protected override void Finalize()

{

try

{

// cleanup statements...

}

    finally
    {
        base.Finalize();
    }
}

C#中，一个对象被析构时，父类的析构函数会自动被调用。 

2. Finalization Queue

Finalization Queue是GC 使用的一个内部结构，用来记录所有定义了Finalize方法的对象（C#中定义了析构函数的类的对象）。

每当一个有Finalize方法的对象被创建时，GC会在Finalization Queue里加入一条记录，指向这个对象在managed heap里的位置。

出于性能考虑，如果没有必要，就不要定义Finalize方法（析构函数）。

Finalize方法（析构函数）里不应该抛出异常来。

 3. 收回被有Finalize方法对象占用的空间，起码需要2次GC过程。

GC工作时，会收回程序里无法引用的并且没有定义Finalize方法的对象占用的空间。 而对于那些有Finalize方法的对象，GC把这些对象在finalization queue里的记录清除，然后把这些记录放在一个list里，表示已经准备好被finalization了。然后GC会调用这个list里记录对应的对象的Finalize方法，调用完之后就把这个记录从list中删掉。

在下一次GC工作时，执行过finalize办法的对象占用的内存就会被收回了。

 4. Dispose 方法

Finalize方法的调用时机不是程序里控制的，而且调用时代价比较大。一个类可以通过实现IDisposable这个接口，提供一个Dispose的方法，然后程序里就可以显示地调用这个方法来释放外部资源。

注意：如果一个类实现了IDisposable接口，你仍然需要提供Finalize方法。

基本的代码

// Design pattern for a base class.

public class Base: IDisposable

{

   //Implement IDisposable.

   public void Dispose() 

   {
     Dispose(true);

      GC.SuppressFinalize(this); 
   } 

   protected virtual void Dispose(bool disposing) 
   {
      if (disposing) 
      {
         // Free other state (managed objects).
      }
      // Free your own state (unmanaged objects).

      // Set large fields to null.
   } 

   // Use C# destructor syntax for finalization code.

   ~Base()

   {
      // Simply call Dispose(false).
      Dispose (false);
   }
}

// Design pattern for a derived class.

public class Derived: Base

{   
   protected override void Dispose(bool disposing) 
   {
      if (disposing) 
      {
         // Release managed resources.
      }

      // Release unmanaged resources.

      // Set large fields to null.

      // Call Dispose on your base class.

      base.Dispose(disposing);
   }

   // The derived class does not have a Finalize method

   // or a Dispose method without parameters because it inherits

   // them from the base class.

}

5

Finalize方法Guideline

(1) 只在需要的时候才去定义一个类的Finalize方法。

(2) 如果需要定义Finalize方法，强烈提示实现IDisposable接口。

(3) C#中，程序里是不可以直接调用Finalize方法的。

Dispose方法Guideline

(1) 尽量在基类中就实现接口；但不要在基类里实现Finalize方法（如果没必要的话）。

(2) 如果基类里实现了IDisposable接口，那么在子类的Dispose方法里应该显示调用基类的Dispose方法。

(3) Dispose方法是可以被重复调用的。但只有第一次调用时会去释放资源。

(4) 一个对象被调用过Dispose方法之后就应该是不可再用了。如果程序试图调用这个对象的方法(除Dispose方法)， 应该抛出ObjectDisposedException.

(5) Dispose方法里应该先调用GC.SuppressFinalize方法。如果这个对象在finalization queue上，这个方法会阻止这个对象的Finalize方法被调用。 见扩展[1]了解更多。