Object.Finalize Метод

Определение

Позволяет объекту попытаться освободить ресурсы и выполнить другие операции очистки, перед тем как он будет уничтожен во время сборки мусора.

!Object ()
~Object ();
abstract member Finalize : unit -> unit
override this.Finalize : unit -> unit
Finalize ()

Примеры

В следующем примере проверяется, Finalize вызывается ли метод при уничтожении объекта, переопределяющего Finalize . Обратите внимание, что в рабочем приложении Finalize метод будет переопределен для освобождения неуправляемых ресурсов, удерживаемых объектом. Кроме того, обратите внимание, что в примере C# вместо переопределения метода предоставляется деструктор Finalize .

using System;
using System.Diagnostics;

public class ExampleClass
{
   Stopwatch sw;

   public ExampleClass()
   {
      sw = Stopwatch.StartNew();
      Console.WriteLine("Instantiated object");
   }

   public void ShowDuration()
   {
      Console.WriteLine("This instance of {0} has been in existence for {1}",
                        this, sw.Elapsed);
   }

   ~ExampleClass()
   {
      Console.WriteLine("Finalizing object");
      sw.Stop();
      Console.WriteLine("This instance of {0} has been in existence for {1}",
                        this, sw.Elapsed);
   }
}

public class Demo
{
   public static void Main()
   {
      ExampleClass ex = new ExampleClass();
      ex.ShowDuration();
   }
}
// The example displays output like the following:
//    Instantiated object
//    This instance of ExampleClass has been in existence for 00:00:00.0011060
//    Finalizing object
//    This instance of ExampleClass has been in existence for 00:00:00.0036294
Imports System.Diagnostics

Public Class ExampleClass
   Dim sw As StopWatch
   
   Public Sub New()
      sw = Stopwatch.StartNew()
      Console.WriteLine("Instantiated object")
   End Sub 

   Public Sub ShowDuration()
      Console.WriteLine("This instance of {0} has been in existence for {1}",
                        Me, sw.Elapsed)
   End Sub
   
   Protected Overrides Sub Finalize()
      Console.WriteLine("Finalizing object")
      sw.Stop()
      Console.WriteLine("This instance of {0} has been in existence for {1}",
                        Me, sw.Elapsed)
   End Sub
End Class

Module Demo
   Public Sub Main()
      Dim ex As New ExampleClass()
      ex.ShowDuration()
   End Sub
End Module
' The example displays output like the following:
'    Instantiated object
'    This instance of ExampleClass has been in existence for 00:00:00.0011060
'    Finalizing object
'    This instance of ExampleClass has been in existence for 00:00:00.0036294

Дополнительный пример переопределения Finalize метода см. в описании GC.SuppressFinalize метода.

Комментарии

FinalizeМетод используется для выполнения операций очистки неуправляемых ресурсов, хранящихся в текущем объекте, до уничтожения объекта. Этот метод защищен и поэтому доступен только через этот класс или производный класс.

Содержание

Принцип работы финализации

ObjectКласс не предоставляет реализацию для Finalize метода, и сборщик мусора не помечает типы, производные от Object для завершения, если только они не переопределяют Finalize метод.

Если тип переопределяет Finalize метод, сборщик мусора добавляет запись для каждого экземпляра типа во внутреннюю структуру, называемую очередью финализации. Очередь финализации содержит записи для всех объектов в управляемой куче, код завершения которых должен быть выполнен до освобождения памяти сборщиком мусора. Затем сборщик мусора вызывает Finalize метод автоматически при выполнении следующих условий:

  • После того как сборщик мусора обнаружит, что объект недоступен, за исключением случаев, когда объект был исключен из финализации путем вызова GC.SuppressFinalize метода.

  • только в платформа .NET Framework, во время завершения работы домена приложения, если только объект не исключен из финализации. Во время завершения работы, даже объекты, которые по-прежнему доступны, завершаются.

Finalize метод автоматически вызывается только один раз для данного экземпляра, если только объект не будет повторно зарегистрирован с помощью механизма, такого как GC.ReRegisterForFinalize , и GC.SuppressFinalize не был впоследствии вызван методом.

Finalize операции имеют следующие ограничения.

  • Точное время выполнения метода завершения не определено. Чтобы обеспечить детерминированный выпуск ресурсов для экземпляров класса, реализуйте Close метод или предоставьте IDisposable.Dispose реализацию.

  • Методы завершения двух объектов не гарантированно выполняются в каком бы то ни было определенном порядке, даже если один объект ссылается на другой. То есть если объект A имеет ссылку на объект B и оба метода имеют методы завершения, то объект B может быть уже завершен при запуске метода завершения объекта A.

  • Поток, в котором выполняется метод завершения, не определен.

FinalizeМетод может не выполняться до завершения или вообще не выполняться при следующих исключительных обстоятельствах:

  • Если другой метод завершения блокируется неограниченно (переходит в бесконечный цикл, пытается получить блокировку, которую он никогда не может получить и т. д.). Поскольку среда выполнения пытается выполнить методы завершения до завершения, другие методы завершения могут не вызываться, если метод завершения блокирует неограниченное время.

  • Значение, если процесс завершается без предоставления среде выполнения возможности очистки. В этом случае первое уведомление среды выполнения о завершении процесса — это DLL_PROCESS_DETACH уведомление.

Среда выполнения продолжит завершать объекты во время завершения работы только в тот момент, когда число объектов, которые можно завершить, будет уменьшаться.

Если Finalize или переопределение Finalize вызывает исключение, а среда выполнения не размещается приложением, которое переопределяет политику по умолчанию, среда выполнения завершает процесс и не try / finally выполняет активные блоки или методы завершения. Такое поведение обеспечивает целостность процессов, если финализатор не может освободить или уничтожить ресурсы.

Переопределение метода Finalize

Необходимо переопределить Finalize для класса, использующего неуправляемые ресурсы, такие как дескрипторы файлов или подключения к базе данных, которые должны быть освобождены, когда управляемый объект, использующий их, будет удален во время сборки мусора. Не следует реализовывать Finalize метод для управляемых объектов, так как сборщик мусора вывысвобождает управляемые ресурсы автоматически.

Важно!

Если SafeHandle доступен объект, который создает оболочку для неуправляемого ресурса, рекомендуемым альтернативом является реализация шаблона удаления с помощью безопасного маркера, а не переопределения Finalize . Дополнительные сведения см. в разделе альтернатива SafeHandle .

По Object.Finalize умолчанию метод не выполняет никаких действий, но при необходимости его следует переопределить Finalize только для освобождения неуправляемых ресурсов. Освобождение памяти обычно занимает намного больше времени, если выполняется операция финализации, так как для нее требуется как минимум две сборки мусора. Кроме того, следует переопределить Finalize метод только для ссылочных типов. Среда CLR завершает только ссылочные типы. Он игнорирует методы завершения для типов значений.

Областью действия Object.Finalize метода является protected . Эту ограниченную область следует поддерживать при переопределении метода в классе. Сохраняя Finalize защищенный метод, пользователи приложения не смогут Finalize напрямую вызывать метод объекта.

Каждая реализация Finalize в производном типе должна вызывать реализацию его базового типа Finalize . Это единственный случай, когда коду приложения разрешено вызывать Finalize . FinalizeМетод объекта не должен вызывать метод для всех объектов, отличных от базового класса. Это связано с тем, что другие вызываемые объекты могут собираться одновременно с вызывающим объектом, например в случае завершения работы среды CLR.

Примечание

Компилятор C# не позволяет переопределить Finalize метод. Вместо этого метод завершения предоставляется путем реализации деструктора для класса. Деструктор C# автоматически вызывает деструктор своего базового класса.

Visual C++ также предоставляет собственный синтаксис для реализации Finalize метода. Дополнительные сведения см. в подразделе "деструкторы и методы завершения" раздела инструкции: определение и использование классов и структур (C++/CLI).

Поскольку сборка мусора является недетерминированной, вы точно не узнаете, когда сборщик мусора выполняет завершение. Для немедленного освобождения ресурсов можно также выбрать реализацию шаблона удаления и IDisposable интерфейса. IDisposable.DisposeРеализация может быть вызвана потребителями вашего класса для освобождения неуправляемых ресурсов, и метод можно использовать Finalize для высвобождения неуправляемых ресурсов в случае, если Dispose метод не вызывается.

Finalize может выполнить практически любое действие, включая восстановление объекта (т. е. сделать объект доступным снова) после его очистки во время сборки мусора. Однако объект может быть восстановлен только один раз. Finalize нельзя вызвать для восстановленных объектов во время сборки мусора.

Альтернативный вариант с использованием SafeHandle

Создание надежных методов завершения зачастую сложно, поскольку вы не можете делать предположения о состоянии приложения, а также из-за необработанных системных исключений, таких как OutOfMemoryException , и StackOverflowException завершения метода завершения. Вместо реализации метода завершения для класса для освобождения неуправляемых ресурсов можно использовать объект, производный от System.Runtime.InteropServices.SafeHandle класса, для упаковки неуправляемых ресурсов, а затем реализовать шаблон Dispose без метода завершения. платформа .NET Framework предоставляет следующие классы в Microsoft.Win32 пространстве имен, которые являются производными от System.Runtime.InteropServices.SafeHandle :

  • SafeFileHandle — Это класс-оболочка для маркера файла.

  • SafeMemoryMappedFileHandle — Это класс-оболочка для дескрипторов размещенных в памяти файлов.

  • SafeMemoryMappedViewHandle — Это класс-оболочка для указателя на блок неуправляемой памяти.

  • SafeNCryptKeyHandle, SafeNCryptProviderHandle и SafeNCryptSecretHandle являются классами-оболочками для криптографических дескрипторов.

  • SafePipeHandle — Это класс-оболочка для дескрипторов канала.

  • SafeRegistryHandle — Это класс-оболочка для маркера в разделе реестра.

  • SafeWaitHandle — Это класс-оболочка для обработчика ожидания.

В следующем примере шаблон Dispose используется с надежными дескрипторами вместо переопределения Finalize метода. Он определяет FileAssociation класс, который заключает в реестр сведения о приложении, обрабатывающем файлы с определенным расширением файла. два дескриптора реестра возвращаются в виде out параметров, Windows вызовы функций RegOpenKeyEx передаются в SafeRegistryHandle конструктор. После этого защищенный Dispose метод типа вызывает SafeRegistryHandle.Dispose метод для высвобождения этих двух дескрипторов.

using Microsoft.Win32.SafeHandles;
using System;
using System.ComponentModel;
using System.IO;
using System.Runtime.InteropServices;

public class FileAssociationInfo : IDisposable
{
   // Private variables.
   private String ext;
   private String openCmd;
   private String args;
   private SafeRegistryHandle hExtHandle, hAppIdHandle;

   // Windows API calls.
   [DllImport("advapi32.dll", CharSet= CharSet.Auto, SetLastError=true)]
   private static extern int RegOpenKeyEx(IntPtr hKey,
                  String lpSubKey, int ulOptions, int samDesired,
                  out IntPtr phkResult);
   [DllImport("advapi32.dll", CharSet= CharSet.Unicode, EntryPoint = "RegQueryValueExW",
              SetLastError=true)]
   private static extern int RegQueryValueEx(IntPtr hKey,
                  string lpValueName, int lpReserved, out uint lpType,
                  string lpData, ref uint lpcbData);
   [DllImport("advapi32.dll", SetLastError = true)]
   private static extern int RegSetValueEx(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string lpValueName,
                  int Reserved, uint dwType, [MarshalAs(UnmanagedType.LPStr)] string lpData,
                  int cpData);
   [DllImport("advapi32.dll", SetLastError=true)]
   private static extern int RegCloseKey(UIntPtr hKey);

   // Windows API constants.
   private const int HKEY_CLASSES_ROOT = unchecked((int) 0x80000000);
   private const int ERROR_SUCCESS = 0;

    private const int KEY_QUERY_VALUE = 1;
    private const int KEY_SET_VALUE = 0x2;

   private const uint REG_SZ = 1;

   private const int MAX_PATH = 260;

   public FileAssociationInfo(String fileExtension)
   {
      int retVal = 0;
      uint lpType = 0;

      if (!fileExtension.StartsWith("."))
             fileExtension = "." + fileExtension;
      ext = fileExtension;

      IntPtr hExtension = IntPtr.Zero;
      // Get the file extension value.
      retVal = RegOpenKeyEx(new IntPtr(HKEY_CLASSES_ROOT), fileExtension, 0, KEY_QUERY_VALUE, out hExtension);
      if (retVal != ERROR_SUCCESS)
         throw new Win32Exception(retVal);
      // Instantiate the first SafeRegistryHandle.
      hExtHandle = new SafeRegistryHandle(hExtension, true);

      string appId = new string(' ', MAX_PATH);
      uint appIdLength = (uint) appId.Length;
      retVal = RegQueryValueEx(hExtHandle.DangerousGetHandle(), String.Empty, 0, out lpType, appId, ref appIdLength);
      if (retVal != ERROR_SUCCESS)
         throw new Win32Exception(retVal);
      // We no longer need the hExtension handle.
      hExtHandle.Dispose();

      // Determine the number of characters without the terminating null.
      appId = appId.Substring(0, (int) appIdLength / 2 - 1) + @"\shell\open\Command";

      // Open the application identifier key.
      string exeName = new string(' ', MAX_PATH);
      uint exeNameLength = (uint) exeName.Length;
      IntPtr hAppId;
      retVal = RegOpenKeyEx(new IntPtr(HKEY_CLASSES_ROOT), appId, 0, KEY_QUERY_VALUE | KEY_SET_VALUE,
                            out hAppId);
       if (retVal != ERROR_SUCCESS)
         throw new Win32Exception(retVal);

      // Instantiate the second SafeRegistryHandle.
      hAppIdHandle = new SafeRegistryHandle(hAppId, true);

      // Get the executable name for this file type.
      string exePath = new string(' ', MAX_PATH);
      uint exePathLength = (uint) exePath.Length;
      retVal = RegQueryValueEx(hAppIdHandle.DangerousGetHandle(), String.Empty, 0, out lpType, exePath, ref exePathLength);
      if (retVal != ERROR_SUCCESS)
         throw new Win32Exception(retVal);

      // Determine the number of characters without the terminating null.
      exePath = exePath.Substring(0, (int) exePathLength / 2 - 1);
      // Remove any environment strings.
      exePath = Environment.ExpandEnvironmentVariables(exePath);

      int position = exePath.IndexOf('%');
      if (position >= 0) {
         args = exePath.Substring(position);
         // Remove command line parameters ('%0', etc.).
         exePath = exePath.Substring(0, position).Trim();
      }
      openCmd = exePath;
   }

   public String Extension
   { get { return ext; } }

   public String Open
   { get { return openCmd; }
     set {
        if (hAppIdHandle.IsInvalid | hAppIdHandle.IsClosed)
           throw new InvalidOperationException("Cannot write to registry key.");
        if (! File.Exists(value)) {
           string message = String.Format("'{0}' does not exist", value);
           throw new FileNotFoundException(message);
        }
        string cmd = value + " %1";
        int retVal = RegSetValueEx(hAppIdHandle.DangerousGetHandle(), String.Empty, 0,
                                   REG_SZ, value, value.Length + 1);
        if (retVal != ERROR_SUCCESS)
           throw new Win32Exception(retVal);
     } }

   public void Dispose()
   {
      Dispose(disposing: true);
      GC.SuppressFinalize(this);
   }

   protected void Dispose(bool disposing)
   {
      // Ordinarily, we release unmanaged resources here;
      // but all are wrapped by safe handles.

      // Release disposable objects.
      if (disposing) {
         if (hExtHandle != null) hExtHandle.Dispose();
         if (hAppIdHandle != null) hAppIdHandle.Dispose();
      }
   }
}
Imports Microsoft.Win32.SafeHandles
Imports System.ComponentModel
Imports System.IO
Imports System.Runtime.InteropServices
Imports System.Text

Public Class FileAssociationInfo : Implements IDisposable
   ' Private variables.
   Private ext As String
   Private openCmd As String
   Private args As String
   Private hExtHandle, hAppIdHandle As SafeRegistryHandle

   ' Windows API calls.
   Private Declare Unicode Function RegOpenKeyEx Lib"advapi32.dll" _
                   Alias "RegOpenKeyExW" (hKey As IntPtr, lpSubKey As String, _
                   ulOptions As Integer, samDesired As Integer, _
                   ByRef phkResult As IntPtr) As Integer
   Private Declare Unicode Function RegQueryValueEx Lib "advapi32.dll" _
                   Alias "RegQueryValueExW" (hKey As IntPtr, _
                   lpValueName As String, lpReserved As Integer, _
                   ByRef lpType As UInteger, lpData As String, _
                   ByRef lpcbData As UInteger) As Integer
   Private Declare Function RegSetValueEx Lib "advapi32.dll" _
                  (hKey As IntPtr, _
                  <MarshalAs(UnmanagedType.LPStr)> lpValueName As String, _
                  reserved As Integer, dwType As UInteger, _
                  <MarshalAs(UnmanagedType.LPStr)> lpData As String, _
                  cpData As Integer) As Integer
   Private Declare Function RegCloseKey Lib "advapi32.dll" _
                  (hKey As IntPtr) As Integer

   ' Windows API constants.
   Private Const HKEY_CLASSES_ROOT As Integer = &h80000000
   Private Const ERROR_SUCCESS As Integer = 0

   Private Const KEY_QUERY_VALUE As Integer = 1
   Private Const KEY_SET_VALUE As Integer = &h2

   Private REG_SZ As UInteger = 1

   Private Const MAX_PATH As Integer  = 260

   Public Sub New(fileExtension As String)
      Dim retVal As Integer = 0
      Dim lpType As UInteger = 0

      If Not fileExtension.StartsWith(".") Then
         fileExtension = "." + fileExtension
      End If
      ext = fileExtension

      Dim hExtension As IntPtr = IntPtr.Zero
      ' Get the file extension value.
      retVal = RegOpenKeyEx(New IntPtr(HKEY_CLASSES_ROOT), fileExtension, 0,
                            KEY_QUERY_VALUE, hExtension)
      if retVal <> ERROR_SUCCESS Then
         Throw New Win32Exception(retVal)
      End If
      ' Instantiate the first SafeRegistryHandle.
      hExtHandle = New SafeRegistryHandle(hExtension, True)

      Dim appId As New String(" "c, MAX_PATH)
      Dim appIdLength As UInteger = CUInt(appId.Length)
      retVal = RegQueryValueEx(hExtHandle.DangerousGetHandle(), String.Empty, _
                               0, lpType, appId, appIdLength)
      if retVal <> ERROR_SUCCESS Then
         Throw New Win32Exception(retVal)
      End If
      ' We no longer need the hExtension handle.
      hExtHandle.Dispose()

      ' Determine the number of characters without the terminating null.
      appId = appId.Substring(0, CInt(appIdLength) \ 2 - 1) + "\shell\open\Command"

      ' Open the application identifier key.
      Dim exeName As New string(" "c, MAX_PATH)
      Dim exeNameLength As UInteger = CUInt(exeName.Length)
      Dim hAppId As IntPtr
      retVal = RegOpenKeyEx(New IntPtr(HKEY_CLASSES_ROOT), appId, 0,
                            KEY_QUERY_VALUE Or KEY_SET_VALUE, hAppId)
      If retVal <> ERROR_SUCCESS Then
         Throw New Win32Exception(retVal)
      End If

      ' Instantiate the second SafeRegistryHandle.
      hAppIdHandle = New SafeRegistryHandle(hAppId, True)

      ' Get the executable name for this file type.
      Dim exePath As New string(" "c, MAX_PATH)
      Dim exePathLength As UInteger = CUInt(exePath.Length)
      retVal = RegQueryValueEx(hAppIdHandle.DangerousGetHandle(), _
                               String.Empty, 0, lpType, exePath, exePathLength)
      If retVal <> ERROR_SUCCESS Then
         Throw New Win32Exception(retVal)
      End If
      ' Determine the number of characters without the terminating null.
      exePath = exePath.Substring(0, CInt(exePathLength) \ 2 - 1)

      exePath = Environment.ExpandEnvironmentVariables(exePath)
      Dim position As Integer = exePath.IndexOf("%"c)
      If position >= 0 Then
         args = exePath.Substring(position)
         ' Remove command line parameters ('%0', etc.).
         exePath = exePath.Substring(0, position).Trim()
      End If
      openCmd = exePath
   End Sub

   Public ReadOnly Property Extension As String
      Get
         Return ext
      End Get
   End Property

   Public Property Open As String
      Get
         Return openCmd
      End Get
      Set
        If hAppIdHandle.IsInvalid Or hAppIdHandle.IsClosed Then
           Throw New InvalidOperationException("Cannot write to registry key.")
        End If
        If Not File.Exists(value) Then
           Dim message As String = String.Format("'{0}' does not exist", value)
           Throw New FileNotFoundException(message)
        End If
        Dim cmd As String = value + " %1"
        Dim retVal As Integer = RegSetValueEx(hAppIdHandle.DangerousGetHandle(), String.Empty, 0,
                                              REG_SZ, value, value.Length + 1)
        If retVal <> ERROR_SUCCESS Then
           Throw New Win32Exception(retVal)
        End If
      End Set
   End Property

   Public Sub Dispose() _
      Implements IDisposable.Dispose
      Dispose(disposing:=True)
      GC.SuppressFinalize(Me)
   End Sub

   Protected Sub Dispose(disposing As Boolean)
      ' Ordinarily, we release unmanaged resources here
      ' but all are wrapped by safe handles.

      ' Release disposable objects.
      If disposing Then
         If hExtHandle IsNot Nothing Then hExtHandle.Dispose()
         If hAppIdHandle IsNot Nothing Then hAppIdHandle.Dispose()
      End If
   End Sub
End Class

Применяется к

См. также раздел