Object.Finalize Metodo

Definizione

Consente a un oggetto di effettuare un tentativo di liberare risorse ed eseguire altre operazioni di pulizia prima che venga recuperato da Garbage Collection.

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

Esempio

Nell'esempio seguente viene verificato che il metodo viene chiamato quando un oggetto che Finalize esegue l'override Finalize viene eliminato. Si noti che, in un'applicazione di produzione, il metodo verrebbe sottoposto a override per rilasciare Finalize le risorse non gestite utilizzate dall'oggetto . Si noti anche che l'esempio C# fornisce un distruttore anziché eseguire l'override del Finalize metodo .

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

Per un esempio aggiuntivo che esegue l'override Finalize del metodo , vedere il metodo GC.SuppressFinalize .

Commenti

Il metodo viene usato per eseguire operazioni di pulizia sulle Finalize risorse non gestite utilizzate dall'oggetto corrente prima che l'oggetto venga eliminato. Il metodo è protetto e pertanto è accessibile solo tramite questa classe o tramite una classe derivata.

Contenuto della sezione:

Funzionamento della finalizzazione

La classe non fornisce alcuna implementazione per il metodo e il Garbage Collector non contrassegna i tipi derivati da per la finalizzazione a meno che non Object Finalize Object eseegneranno l'override del Finalize metodo .

Se un tipo esegue l'override del metodo , il Garbage Collector aggiunge una voce per ogni istanza del tipo a una struttura Finalize interna denominata coda di finalizzazione. La coda di finalizzazione contiene voci per tutti gli oggetti nell'heap gestito il cui codice di finalizzazione deve essere eseguito prima che Il Garbage Collector possa recuperare la memoria. Il Garbage Collector chiama quindi Finalize automaticamente il metodo nelle condizioni seguenti:

  • Dopo che il Garbage Collector ha rilevato che un oggetto è inaccessibile, a meno che l'oggetto non sia stato esentato dalla finalizzazione da una chiamata al GC.SuppressFinalize metodo .

  • In .NET Framework solo, durante l'arresto di un dominio applicazione, a meno che l'oggetto non sia esente dalla finalizzazione. Durante l'arresto, vengono finalizzati anche gli oggetti ancora accessibili.

Finalize viene chiamato automaticamente una sola volta in una determinata istanza, a meno che l'oggetto non venga registrato di nuovo usando un meccanismo come e il GC.ReRegisterForFinalize metodo non sia stato chiamato GC.SuppressFinalize successivamente.

Finalize Le operazioni presentano le limitazioni seguenti:

  • L'ora esatta in cui viene eseguito il finalizzatore non è definita. Per garantire il rilascio deterministico delle risorse per le istanze della classe, implementare un Close metodo o fornire IDisposable.Dispose un'implementazione.

  • Non è garantito che i finalizzatori di due oggetti siano eseguiti in un ordine specifico, anche se un oggetto fa riferimento all'altro. In altri casi, se l'oggetto A ha un riferimento all'oggetto B ed entrambi dispongono di finalizzatori, l'oggetto B potrebbe essere già stato finalizzato all'avvio del finalizzatore dell'oggetto A.

  • Il thread su cui viene eseguito il finalizzatore non è specificato.

Il metodo potrebbe non essere eseguito fino al completamento o potrebbe non essere eseguito Finalize nelle circostanze eccezionali seguenti:

  • Se un altro finalizzatore si blocca a tempo indeterminato (entra in un ciclo infinito, tenta di ottenere un blocco che non può mai ottenere e così via). Poiché il runtime tenta di eseguire finalizzatori fino al completamento, altri finalizzatori potrebbero non essere chiamati se un finalizzatore si blocca a tempo indeterminato.

  • Se il processo termina senza concedere al runtime la possibilità di eseguire la pulizia. In questo caso, la prima notifica del runtime di terminazione del processo è una DLL_PROCESS_DETACH notifica.

Il runtime continua a finalizzare gli oggetti durante l'arresto solo mentre il numero di oggetti finalizzabili continua a diminuire.

Se o un override di genera un'eccezione e il runtime non è ospitato da un'applicazione che esegue l'override dei criteri predefiniti, il runtime termina il processo e non vengono eseguiti blocchi attivi o Finalize Finalize try / finally finalizzatori. Questo comportamento garantisce l'integrità del processo se il finalizzatore non può liberare o eliminare risorse.

Override del metodo Finalize

È necessario eseguire l'override per una classe che usa risorse non gestite, ad esempio handle di file o connessioni di database che devono essere rilasciate quando l'oggetto gestito che le usa viene eliminato durante Finalize l'operazione di Garbage Collection. Non è consigliabile implementare un metodo per gli oggetti gestiti perché il Finalize Garbage Collector rilascia automaticamente le risorse gestite.

Importante

Se è disponibile un oggetto che esegue il wrapping della risorsa non gestita, l'alternativa consigliata consiste nell'implementare il modello dispose con un handle sicuro e non eseguire SafeHandle l'override di Finalize . Per altre informazioni, vedere la sezione alternativa SafeHandle.

Il Object.Finalize metodo non esegue alcuna operazione per impostazione predefinita, ma è necessario eseguire l'override solo se necessario e solo per Finalize rilasciare risorse non gestite. Il recupero della memoria tende a richiedere molto più tempo se viene eseguita un'operazione di finalizzazione, perché richiede almeno due Garbage Collection. È inoltre necessario eseguire l'override del Finalize metodo solo per i tipi riferimento. Common Language Runtime finalizza solo i tipi riferimento. Ignora i finalizzatori sui tipi valore.

L'ambito del Object.Finalize metodo è protected . È consigliabile mantenere questo ambito limitato quando si esegue l'override del metodo nella classe . Mantenendo un Finalize metodo protetto, si impedisce agli utenti dell'applicazione di chiamare direttamente il metodo di Finalize un oggetto.

Ogni implementazione Finalize di in un tipo derivato deve chiamare l'implementazione del tipo di base di Finalize . Questo è l'unico caso in cui il codice dell'applicazione può chiamare Finalize . Il metodo di un oggetto non deve chiamare un metodo su oggetti diversi da Finalize quello della relativa classe di base. Ciò è dovuto al fatto che gli altri oggetti chiamati possono essere raccolti contemporaneamente all'oggetto chiamante, ad esempio in caso di arresto di Common Language Runtime.

Nota

Il compilatore C# non consente di eseguire l'override del Finalize metodo . È invece possibile fornire un finalizzatore implementando un distruttore per la classe. Un distruttore C# chiama automaticamente il distruttore della relativa classe di base.

Visual C++ fornisce anche la propria sintassi per l'implementazione del Finalize metodo . Per altre informazioni, vedere la sezione "Distruttori e finalizzatori" di Procedura: Definire e utilizzare classi e struct (C++/CLI).

Poiché l'operazione di Garbage Collection non è deterministica, non è possibile sapere con precisione quando il Garbage Collector esegue la finalizzazione. Per rilasciare immediatamente le risorse, è anche possibile scegliere di implementare il modello dispose e l'interfaccia IDisposable . L'implementazione può essere chiamata dai consumer della classe per liberare risorse non gestite ed è possibile usare il metodo per liberare risorse non gestite nel caso in cui il metodo IDisposable.Dispose Finalize non sia Dispose chiamato.

Finalize può eseguire quasi qualsiasi azione, inclusa la rimozione di un oggetto (ovvero rendendo nuovamente accessibile l'oggetto) dopo che è stato pulito durante l'operazione di Garbage Collection. Tuttavia, l'oggetto può essere resuscito una sola volta. Finalize non può essere chiamato su oggetti resusciti durante l'operazione di Garbage Collection.

Alternativa SafeHandle

La creazione di finalizzatori affidabili è spesso difficile, perché non è possibile fare supposizioni sullo stato dell'applicazione e perché le eccezioni di sistema non gestite, ad esempio e terminano il OutOfMemoryException StackOverflowException finalizzatore. Anziché implementare un finalizzatore per la classe per rilasciare risorse non gestite, è possibile usare un oggetto derivato dalla classe per eseguire il wrapping delle risorse non gestite e quindi implementare il modello dispose senza un System.Runtime.InteropServices.SafeHandle finalizzatore. Il .NET Framework fornisce le classi seguenti nello spazio dei nomi Microsoft.Win32 derivate da System.Runtime.InteropServices.SafeHandle :

Nell'esempio seguente viene utilizzato il modello dispose con handle sicuri anziché eseguire l'override del Finalize metodo . Definisce una classe che esegue il wrapping delle informazioni del FileAssociation Registro di sistema sull'applicazione che gestisce i file con una determinata estensione di file. I due handle del Registro di sistema restituiti come parametri Windows chiamate di funzione out RegOpenKeyEx vengono passati al SafeRegistryHandle costruttore. Il metodo protetto del tipo Dispose chiama quindi il metodo per liberare questi due SafeRegistryHandle.Dispose handle.

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

Si applica a

Vedi anche