Método System.Object.Finalize
Este artigo fornece observações complementares à documentação de referência para essa API.
O Finalize método é usado para executar operações de limpeza em recursos não gerenciados mantidos pelo objeto atual antes que o objeto seja destruído. O método é protegido e, portanto, é acessível somente por meio dessa classe ou por meio de uma classe derivada.
Como funciona a finalização
A Object classe não fornece nenhuma implementação para o método, e o coletor de lixo não marca tipos derivados de Object para finalização, a menos que eles substituam o FinalizeFinalize método.
Se um tipo substituir o método, o Finalize coletor de lixo adicionará uma entrada para cada instância do tipo a uma estrutura interna chamada fila de finalização. A fila de finalização contém entradas para todos os objetos no heap gerenciado cujo código de finalização deve ser executado antes que o coletor de lixo possa recuperar sua memória. Em seguida, o coletor de lixo chama o Finalize método automaticamente nas seguintes condições:
- Depois que o coletor de lixo tiver descoberto que um objeto está inacessível, a menos que o objeto tenha sido isento da finalização por uma chamada para o GC.SuppressFinalize método.
- Somente no .NET Framework, durante o desligamento de um domínio de aplicativo, a menos que o objeto esteja isento de finalização. Durante o desligamento, até mesmo os objetos que ainda estão acessíveis são finalizados.
Finalize é chamado automaticamente apenas uma vez em uma determinada instância, a menos que o objeto seja registrado novamente usando um mecanismo como GC.ReRegisterForFinalize e o GC.SuppressFinalize método não tenha sido chamado subsequentemente.
Finalize As operações têm as seguintes limitações:
- A hora exata em que o finalizador é executada é indefinida. Para garantir a liberação determinística de recursos para instâncias de sua classe, implemente um
Closemétodo ou forneça uma IDisposable.Dispose implementação. - Os finalizadores de dois objetos não são garantidos para executar em qualquer ordem específica, mesmo se um objeto se referir ao outro. Ou seja, se o Objeto A tiver uma referência ao Objeto B e ambos tiverem finalizadores, o Objeto B pode já ter sido finalizado quando o finalizador do Objeto A for iniciado.
- O thread no qual o finalizador é executado não é especificado.
O Finalize método pode não ser executado até a conclusão ou pode não ser executado nas seguintes circunstâncias excepcionais:
- Se outro finalizador bloqueia indefinidamente (entra em um loop infinito, tenta obter um bloqueio que nunca pode obter, e assim por diante). Como o tempo de execução tenta executar finalizadores até a conclusão, outros finalizadores podem não ser chamados se um finalizador for bloqueado indefinidamente.
- Se o processo for encerrado sem dar ao tempo de execução a chance de limpeza. Nesse caso, a primeira notificação do tempo de execução do encerramento do processo é uma notificação DLL_PROCESS_DETACH.
O tempo de execução continua a finalizar objetos durante o desligamento somente enquanto o número de objetos finalizáveis continua a diminuir.
Se Finalize ou uma substituição de lança uma exceção e o tempo de execução não é hospedado por um aplicativo que substitui a política padrão, o tempo de Finalize execução encerra o processo e nenhum bloco ativo try/finally ou finalizadores são executados. Esse comportamento garante a integridade do processo se o finalizador não puder liberar ou destruir recursos.
Substituindo o método Finalize
Você deve substituir Finalize por uma classe que usa recursos não gerenciados, como identificadores de arquivo ou conexões de banco de dados que devem ser liberados quando o objeto gerenciado que os usa é descartado durante a coleta de lixo. Você não deve implementar um Finalize método para objetos gerenciados porque o coletor de lixo libera recursos gerenciados automaticamente.
Importante
Se estiver disponível um objeto que encapsula seu recurso não gerenciado, a alternativa recomendada é implementar o padrão de descarte com um SafeHandle identificador seguro e não substituir Finalize. Para obter mais informações, consulte A seção alternativa do SafeHandle.
O Object.Finalize método não faz nada por padrão, mas você deve substituir Finalize somente se necessário e somente para liberar recursos não gerenciados. A recuperação de memória tende a levar muito mais tempo se uma operação de finalização for executada, porque requer pelo menos duas coletas de lixo. Além disso, você deve substituir o Finalize método apenas para tipos de referência. O Common Language Runtime apenas finaliza os tipos de referência. Ele ignora finalizadores em tipos de valor.
O escopo do Object.Finalize método é protected. Você deve manter esse escopo limitado ao substituir o método em sua classe. Ao manter um método protegido, você impede que os usuários do seu aplicativo chamem o Finalize método de um Finalize objeto diretamente.
Toda implementação de em um tipo derivado deve chamar a implementação de seu tipo base de FinalizeFinalize. Este é o único caso em que o código do aplicativo tem permissão para chamar Finalize. O método de Finalize um objeto não deve chamar um método em nenhum objeto que não seja o de sua classe base. Isso ocorre porque os outros objetos que estão sendo chamados podem ser coletados ao mesmo tempo que o objeto de chamada, como no caso de um desligamento do Common Language Runtime.
Observação
O compilador C# não permite que você substitua o Finalize método. Em vez disso, você fornece um finalizador implementando um destruidor para sua classe. Um destruidor C# chama automaticamente o destruidor de sua classe base.
Visual C++ também fornece sua própria sintaxe para implementar o Finalize método. Para obter mais informações, consulte a seção "Destruidores e finalizadores" de Como definir e consumir classes e estruturas (C++/CLI).
Como a coleta de lixo não é determinística, você não sabe exatamente quando o coletor de lixo realiza a finalização. Para liberar recursos imediatamente, você também pode optar por implementar o padrão de descarte e a IDisposable interface. A IDisposable.Dispose implementação pode ser chamada pelos consumidores de sua classe para liberar recursos não gerenciados, e você pode usar o método para liberar recursos não gerenciados no caso de o FinalizeDispose método não ser chamado.
Finalize pode executar quase qualquer ação, incluindo ressuscitar um objeto (ou seja, torná-lo acessível novamente) depois que ele tiver sido limpo durante a coleta de lixo. No entanto, o objeto só pode ser ressuscitado uma vez; Finalize não pode ser chamado em objetos ressuscitados durante a coleta de lixo.
A alternativa do SafeHandle
A criação de finalizadores confiáveis geralmente é difícil, porque você não pode fazer suposições sobre o estado do seu aplicativo e porque exceções do sistema não tratadas, como OutOfMemoryException e StackOverflowException encerram o finalizador. Em vez de implementar um finalizador para sua classe liberar recursos não gerenciados, você pode usar um objeto derivado da classe para encapsular seus recursos não gerenciados e, em seguida, implementar o padrão de System.Runtime.InteropServices.SafeHandle descarte sem um finalizador. O .NET Framework fornece as seguintes classes no Microsoft.Win32 namespace que são derivadas de System.Runtime.InteropServices.SafeHandle:
- SafeFileHandle é uma classe wrapper para um identificador de arquivo.
- SafeMemoryMappedFileHandle é uma classe wrapper para identificadores de arquivo mapeados para memória.
- SafeMemoryMappedViewHandle é uma classe wrapper de um ponteiro para um bloco de memória não gerenciada.
- SafeNCryptKeyHandle, SafeNCryptProviderHandlee SafeNCryptSecretHandle são classes wrapper para identificadores criptográficos.
- SafePipeHandle é uma classe wrapper para alças de tubo.
- SafeRegistryHandle é uma classe wrapper para um identificador para uma chave do Registro.
- SafeWaitHandle é uma classe wrapper para um identificador de espera.
O exemplo a seguir usa o padrão de descarte com alças seguras em vez de substituir o Finalize método. Ele define uma classe que encapsula informações do Registro sobre o aplicativo que manipula arquivos com uma FileAssociation extensão de arquivo específica. Os dois identificadores do Registro retornados como out parâmetros pelas chamadas de função RegOpenKeyEx do Windows são passados para o SafeRegistryHandle construtor. O método protegido Dispose do tipo, em seguida, chama o SafeRegistryHandle.Dispose método para liberar esses dois identificadores.
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
