Метод System.Object.Finalize
В этой статье приводятся дополнительные замечания к справочной документации по этому API.
Метод Finalize используется для выполнения операций очистки с неуправляемых ресурсов, удерживаемых текущим объектом перед уничтожением объекта. Метод защищен и поэтому доступен только через этот класс или через производный класс.
Как работает финализация
Класс Object не предоставляет реализацию для Finalize метода, и сборщик мусора не помечает типы, производные от Object завершения, если они не переопределяют Finalize метод.
Если тип переопределяет Finalize метод, сборщик мусора добавляет запись для каждого экземпляра типа во внутреннюю структуру, называемую очередью завершения. Очередь завершения содержит записи для всех объектов в управляемой куче, код завершения которого должен выполняться, прежде чем сборщик мусора может восстановить память. Затем сборщик мусора автоматически вызывает Finalize метод в следующих условиях:
- После того как сборщик мусора обнаружил, что объект недоступен, если объект не был исключен из завершения путем вызова GC.SuppressFinalize метода.
- Только в платформа .NET Framework во время завершения работы домена приложения, если объект не исключен из завершения. Во время завершения работы завершены даже объекты, которые по-прежнему доступны.
Finalize автоматически вызывается только один раз в данном экземпляре, если объект не регистрируется повторно с помощью такого механизма, как GC.ReRegisterForFinalizeGC.SuppressFinalize метод не был вызван впоследствии.
Finalize операции имеют следующие ограничения:
- Точное время выполнения средства завершения не определено. Чтобы обеспечить детерминированный выпуск ресурсов для экземпляров класса, реализуйте
Closeметод или предоставьте реализацию IDisposable.Dispose . - Методы завершения двух объектов не гарантированно выполняются в определенном порядке, даже если один объект ссылается на другой. То есть, если объект A имеет ссылку на объект B и оба имеют методы завершения, объект B может быть уже завершен при запуске средства завершения объекта A.
- Поток, на котором выполняется метод завершения, не указан.
Метод Finalize может не выполняться до завершения или не может выполняться вообще в следующих исключительных обстоятельствах:
- Если другой метод завершения блокирует неограниченное время (переходит в бесконечный цикл, пытается получить блокировку, она никогда не может получить и т. д.). Так как среда выполнения пытается запустить методы завершения до завершения, другие методы завершения могут не вызываться, если метод завершения блокируется на неопределенный срок.
- Если процесс завершается без предоставления среды выполнения возможности очистки. В этом случае первое уведомление среды выполнения о завершении процесса является уведомлением DLL_PROCESS_DETACH.
Среда выполнения продолжает завершать объекты во время завершения работы только в то время как количество завершенных объектов продолжает уменьшаться.
Если Finalize или переопределение Finalize создает исключение, а среда выполнения не размещается приложением, которое переопределяет политику по умолчанию, среда выполнения завершает процесс, а активные try/finally блоки или методы завершения не выполняются. Это поведение гарантирует целостность процесса, если метод завершения не может освободить или уничтожить ресурсы.
Переопределение метода Finalize
Необходимо переопределить Finalize для класса, использующего неуправляемые ресурсы, например дескриптора файлов или подключения к базе данных, которые должны быть освобождены, если управляемый объект, использующий их, не карта во время сборки мусора. Не следует реализовать Finalize метод для управляемых объектов, так как сборщик мусора освобождает управляемые ресурсы автоматически.
Важно!
SafeHandle Если объект доступен, который упаковывает неуправляемый ресурс, рекомендуется реализовать шаблон удаления с безопасным дескриптором и не переопределитьFinalize. Дополнительные сведения см. в разделе "Альтернативный Сейф Handle".
Метод 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 класса, для упаковки неуправляемых ресурсов, а затем реализовать шаблон удаления без завершения. Платформа .NET Framework предоставляет следующие классы в Microsoft.Win32 пространстве имен, производных отSystem.Runtime.InteropServices.SafeHandle:
- SafeFileHandle — это класс-оболочка для дескриптора файлов.
- SafeMemoryMappedFileHandle — это класс-оболочка для дескрипторов файлов, сопоставленных с памятью.
- SafeMemoryMappedViewHandle — это класс-оболочка для указателя на блок неуправляемой памяти.
- SafeNCryptKeyHandle, SafeNCryptProviderHandleи SafeNCryptSecretHandle являются классами-оболочками для криптографических дескрипторов.
- SafePipeHandle — это класс-оболочка для дескрипторов каналов.
- SafeRegistryHandle — это класс-оболочка для дескриптора в раздел реестра.
- SafeWaitHandle — это класс-оболочка для дескриптора ожидания.
В следующем примере используется шаблон удаления с безопасными дескрипторами вместо переопределения 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();
}
}
}
open Microsoft.Win32.SafeHandles
open System
open System.ComponentModel
open System.IO
open System.Runtime.InteropServices
// Windows API constants.
let HKEY_CLASSES_ROOT = 0x80000000
let ERROR_SUCCESS = 0
let KEY_QUERY_VALUE = 1
let KEY_SET_VALUE = 0x2
let REG_SZ = 1u
let MAX_PATH = 260
// Windows API calls.
[<DllImport("advapi32.dll", CharSet= CharSet.Auto, SetLastError=true)>]
extern int RegOpenKeyEx(nativeint hKey, string lpSubKey, int ulOptions, int samDesired, nativeint& phkResult)
[<DllImport("advapi32.dll", CharSet= CharSet.Unicode, EntryPoint = "RegQueryValueExW", SetLastError=true)>]
extern int RegQueryValueEx(nativeint hKey, string lpValueName, int lpReserved, uint& lpType, string lpData, uint& lpcbData)
[<DllImport("advapi32.dll", SetLastError = true)>]
extern int RegSetValueEx(nativeint hKey, [<MarshalAs(UnmanagedType.LPStr)>] string lpValueName, int Reserved, uint dwType, [<MarshalAs(UnmanagedType.LPStr)>] string lpData, int cpData)
[<DllImport("advapi32.dll", SetLastError=true)>]
extern int RegCloseKey(unativeint hKey)
type FileAssociationInfo(fileExtension: string) =
// Private values.
let ext =
if fileExtension.StartsWith "." |> not then
"." + fileExtension
else
fileExtension
let mutable args = ""
let mutable hAppIdHandle = Unchecked.defaultof<SafeRegistryHandle>
let mutable hExtHandle = Unchecked.defaultof<SafeRegistryHandle>
let openCmd =
let mutable lpType = 0u
let mutable hExtension = 0n
// Get the file extension value.
let retVal = RegOpenKeyEx(nativeint HKEY_CLASSES_ROOT, fileExtension, 0, KEY_QUERY_VALUE, &hExtension)
if retVal <> ERROR_SUCCESS then
raise (Win32Exception retVal)
// Instantiate the first SafeRegistryHandle.
hExtHandle <- new SafeRegistryHandle(hExtension, true)
let appId = String(' ', MAX_PATH)
let mutable appIdLength = uint appId.Length
let retVal = RegQueryValueEx(hExtHandle.DangerousGetHandle(), String.Empty, 0, &lpType, appId, &appIdLength)
if retVal <> ERROR_SUCCESS then
raise (Win32Exception retVal)
// We no longer need the hExtension handle.
hExtHandle.Dispose()
// Determine the number of characters without the terminating null.
let appId = appId.Substring(0, int appIdLength / 2 - 1) + @"\shell\open\Command"
// Open the application identifier key.
let exeName = String(' ', MAX_PATH)
let exeNameLength = uint exeName.Length
let mutable hAppId = 0n
let retVal = RegOpenKeyEx(nativeint HKEY_CLASSES_ROOT, appId, 0, KEY_QUERY_VALUE ||| KEY_SET_VALUE, &hAppId)
if retVal <> ERROR_SUCCESS then
raise (Win32Exception retVal)
// Instantiate the second SafeRegistryHandle.
hAppIdHandle <- new SafeRegistryHandle(hAppId, true)
// Get the executable name for this file type.
let exePath = String(' ', MAX_PATH)
let mutable exePathLength = uint exePath.Length
let retVal = RegQueryValueEx(hAppIdHandle.DangerousGetHandle(), String.Empty, 0, &lpType, exePath, &exePathLength)
if retVal <> ERROR_SUCCESS then
raise (Win32Exception retVal)
// Determine the number of characters without the terminating null.
let exePath =
exePath.Substring(0, int exePathLength / 2 - 1)
// Remove any environment strings.
|> Environment.ExpandEnvironmentVariables
let position = exePath.IndexOf '%'
if position >= 0 then
args <- exePath.Substring position
// Remove command line parameters ('%0', etc.).
exePath.Substring(0, position).Trim()
else
exePath
member _.Extension =
ext
member _.Open
with get () = openCmd
and set (value) =
if hAppIdHandle.IsInvalid || hAppIdHandle.IsClosed then
raise (InvalidOperationException "Cannot write to registry key.")
if not (File.Exists value) then
raise (FileNotFoundException $"'{value}' does not exist")
let cmd = value + " %1"
let retVal = RegSetValueEx(hAppIdHandle.DangerousGetHandle(), String.Empty, 0, REG_SZ, value, value.Length + 1)
if retVal <> ERROR_SUCCESS then
raise (Win32Exception retVal)
member this.Dispose() =
this.Dispose true
GC.SuppressFinalize this
member _.Dispose(disposing) =
// Ordinarily, we release unmanaged resources here
// but all are wrapped by safe handles.
// Release disposable objects.
if disposing then
if hExtHandle <> null then hExtHandle.Dispose()
if hAppIdHandle <> null then hAppIdHandle.Dispose()
interface IDisposable with
member this.Dispose() =
this.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
