System.IDisposable.Dispose 方法

方法描述

执行与释放或重置非托管资源相关的应用程序定义的任务。

语法定义(C# System.IDisposable.Dispose 方法 的用法)

void Dispose()

参数/返回值

参数值/返回值 参数类型/返回类型 参数描述/返回描述
返回值 void

提示和注释

使用此方法关闭或释放由实现此接口的类的实例保持的文件、流和句柄等非托管资源。 根据约定,此方法用于与释放对象所持有的资源或准备对象以便重新使用关联的所有任务。

重要事项

C++ 程序员应当阅读 Destructors and Finalizers in Visual C++。 在 .NET Framework 2.0 版中,C++ 编译器为实现资源的确定性处置提供支持,并且不允许直接实现 Dispose 方法。

实现此方法时,可通过在包容层次结构中传播调用来确保释放所有保持的资源。 例如,如果对象 A 分配一个对象 B,对象 B 分配一个对象 C,那么 A 的 Dispose 实现必须调用 B 上的 Dispose,B 必须调用 C 上的 Dispose。 如果一个对象的基类实现 Dispose,该对象还必须调用其基类的 IDisposable 方法。

如果某对象的 Dispose 方法被调用一次以上,则该对象必须忽略第一次调用后的所有调用。 如果对象的 Dispose 方法被多次调用,该对象一定不要引发异常。 除 Dispose 之外的实例方法在资源已释放时会引发 ObjectDisposedException。

用户可能期望资源类型使用特定的约定来表示已分配状态和已释放状态。 流类即是这样一种示例,传统上认为它们要么打开要么关闭。 具有此种约定的类的实施者可能选择实现具有自定义名称(如“Close”)的公用方法来调用 Dispose 方法。

因为 Dispose 方法必须显式进行调用,所以,实现 IDisposable 的对象还必须实现一个终结器,以便在未调用 Dispose 时处理释放资源问题。 默认情况下,垃圾回收器会在回收一个对象的内存之前自动调用该对象的终结器。 然而,在调用 Dispose 方法后,通常不需要垃圾回收器调用已释放对象的终结器。 为防止自动终止,Dispose 实现可以调用 GC.SuppressFinalize 方法。

有关实现终结器和 Dispose 方法的更多信息,请参见 GC 类、Object.Finalize 方法和 实现 Finalize 和 Dispose 以清理非托管资源。

当您使用的对象访问非托管的资源(如 StreamWriter)时,一种很好的做法是用 using 语句创建该实例。 using 语句在使用它的代码完成后,将自动关闭流冰调用对象上的 Dispose。 有关示例,请参见 StreamWriter 类。

System.IDisposable.Dispose 方法例子

下面的示例演示如何实现 Dispose 方法。

using System;
using System.ComponentModel;

// The following example demonstrates how to create
// a resource class that implements the IDisposable interface
// and the IDisposable.Dispose method.

public class DisposeExample
{
    // A base class that implements IDisposable.
    // By implementing IDisposable, you are announcing that
    // instances of this type allocate scarce resources.
    public class MyResource: IDisposable
    {
        // Pointer to an external unmanaged resource.
        private IntPtr handle;
        // Other managed resource this class uses.
        private Component component = new Component();
        // Track whether Dispose has been called.
        private bool disposed = false;

        // The class constructor.
        public MyResource(IntPtr handle)
        {
            this.handle = handle;
        }

        // Implement IDisposable.
        // Do not make this method virtual.
        // A derived class should not be able to override this method.
        public void Dispose()
        {
            Dispose(true);
            // This object will be cleaned up by the Dispose method.
            // Therefore, you should call GC.SupressFinalize to
            // take this object off the finalization queue
            // and prevent finalization code for this object
            // from executing a second time.
            GC.SuppressFinalize(this);
        }

        // Dispose(bool disposing) executes in two distinct scenarios.
        // If disposing equals true, the method has been called directly
        // or indirectly by a user's code. Managed and unmanaged resources
        // can be disposed.
        // If disposing equals false, the method has been called by the
        // runtime from inside the finalizer and you should not reference
        // other objects. Only unmanaged resources can be disposed.
        protected virtual void Dispose(bool disposing)
        {
            // Check to see if Dispose has already been called.
            if(!this.disposed)
            {
                // If disposing equals true, dispose all managed
                // and unmanaged resources.
                if(disposing)
                {
                    // Dispose managed resources.
                    component.Dispose();
                }

                // Call the appropriate methods to clean up
                // unmanaged resources here.
                // If disposing is false,
                // only the following code is executed.
                CloseHandle(handle);
                handle = IntPtr.Zero;

                // Note disposing has been done.
                disposed = true;

            }
        }

        // Use interop to call the method necessary
        // to clean up the unmanaged resource.
        [System.Runtime.InteropServices.DllImport("Kernel32")]
        private extern static Boolean CloseHandle(IntPtr handle);

        // Use C# destructor syntax for finalization code.
        // This destructor will run only if the Dispose method
        // does not get called.
        // It gives your base class the opportunity to finalize.
        // Do not provide destructors in types derived from this class.
        ~MyResource()
        {
            // Do not re-create Dispose clean-up code here.
            // Calling Dispose(false) is optimal in terms of
            // readability and maintainability.
            Dispose(false);
        }
    }
    public static void Main()
    {
        // Insert code here to create
        // and use the MyResource object.
    }
}

异常

异常 异常描述

命名空间

namespace: System

程序集: mscorlib(在 mscorlib.dll 中)

版本信息

.NET Framework 受以下版本支持:4、3.5、3.0、2.0、1.1、1.0 .NET Framework Client Profile 受以下版本支持:4、3.5 SP1 受以下版本支持:

适用平台

Windows 7, Windows Vista SP1 或更高版本, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008(不支持服务器核心), Windows Server 2008 R2(支持 SP1 或更高版本的服务器核心), Windows Server 2003 SP2 .NET Framework 并不是对每个平台的所有版本都提供支持。有关支持的版本的列表,请参见.NET Framework 系统要求。