Méthode System.Object.Finalise

  • Article

Cet article vous offre des remarques complémentaires à la documentation de référence pour cette API.

La Finalize méthode est utilisée pour effectuer des opérations de propre up sur des ressources non managées détenues par l’objet actuel avant la destruction de l’objet. La méthode est protégée et est donc accessible uniquement via cette classe ou par le biais d’une classe dérivée.

Fonctionnement de la finalisation

La Object classe ne fournit aucune implémentation pour la Finalize méthode, et le garbage collector ne marque pas les types dérivés de Object la finalisation, sauf s’ils remplacent la Finalize méthode.

Si un type remplace la Finalize méthode, le garbage collector ajoute une entrée pour chaque instance du type à une structure interne appelée file d’attente de finalisation. La file d’attente de finalisation contient des entrées pour tous les objets du tas managé dont le code de finalisation doit s’exécuter avant que le garbage collector puisse récupérer leur mémoire. Le garbage collector appelle ensuite automatiquement la Finalize méthode dans les conditions suivantes :

  • Une fois que le garbage collector a découvert qu’un objet est inaccessible, sauf si l’objet a été exempté de la finalisation par un appel à la GC.SuppressFinalize méthode.
  • Sur .NET Framework uniquement, lors de l’arrêt d’un domaine d’application, sauf si l’objet n’est pas exempté de la finalisation. Pendant l’arrêt, même les objets qui sont toujours accessibles sont finalisés.

Finalize est automatiquement appelé une seule fois sur une instance donnée, sauf si l’objet est réinscrit à l’aide d’un mécanisme tel que GC.ReRegisterForFinalize et que la GC.SuppressFinalize méthode n’a pas été appelée par la suite.

Finalize les opérations présentent les limitations suivantes :

  • Heure exacte à laquelle le finaliseur s’exécute n’est pas défini. Pour garantir la mise en production déterministe des ressources pour les instances de votre classe, implémentez une Close méthode ou fournissez une IDisposable.Dispose implémentation.
  • Les finaliseurs de deux objets ne sont pas garantis pour s’exécuter dans un ordre spécifique, même si un objet fait référence à l’autre. Autrement dit, si l’objet A a une référence à l’objet B et que les deux ont des finaliseurs, l’objet B a peut-être déjà été finalisé au démarrage du finaliseur de l’objet A.
  • Thread sur lequel le finaliseur s’exécute n’est pas spécifié.

La Finalize méthode peut ne pas s’exécuter jusqu’à la fin ou ne pas s’exécuter du tout dans les circonstances exceptionnelles suivantes :

  • Si un autre finaliseur bloque indéfiniment (passe dans une boucle infinie, tente d’obtenir un verrou qu’il ne peut jamais obtenir, etc.). Étant donné que le runtime tente d’exécuter des finaliseurs à la fin, d’autres finaliseurs peuvent ne pas être appelés si un finaliseur bloque indéfiniment.
  • Si le processus se termine sans donner à l’exécution une chance de propre. Dans ce cas, la première notification du runtime d’arrêt du processus est une notification DLL_PROCESS_DETACH.

Le runtime continue de finaliser les objets pendant l’arrêt uniquement alors que le nombre d’objets finalisables continue de diminuer.

Si Finalize ou un remplacement de Finalize lève une exception et que le runtime n’est pas hébergé par une application qui remplace la stratégie par défaut, le runtime met fin au processus et aucun bloc actif try/finally ou finaliseur n’est exécuté. Ce comportement garantit l’intégrité du processus si le finaliseur ne peut pas libérer ou détruire des ressources.

Substitution de la méthode Finalise

Vous devez remplacer Finalize une classe qui utilise des ressources non managées, telles que des handles de fichiers ou des connexions de base de données qui doivent être libérées lorsque l’objet managé qui les utilise est dis carte ed pendant le garbage collection. Vous ne devez pas implémenter de Finalize méthode pour les objets managés, car le garbage collector libère automatiquement les ressources managées.

Important

Si un SafeHandle objet est disponible qui encapsule votre ressource non managée, l’alternative recommandée consiste à implémenter le modèle de suppression avec un handle sécurisé et non à remplacer Finalize. Pour plus d’informations, consultez la section Coffre Handle alternative.

La Object.Finalize méthode ne fait rien par défaut, mais vous devez remplacer Finalize uniquement si nécessaire, et uniquement pour libérer des ressources non managées. La récupération de la mémoire a tendance à prendre beaucoup plus de temps si une opération de finalisation s’exécute, car elle nécessite au moins deux garbage collections. En outre, vous devez remplacer la méthode pour les Finalize types de référence uniquement. Le Common Language Runtime finalise uniquement les types de référence. Il ignore les finaliseurs sur les types valeur.

L’étendue de la Object.Finalize méthode est protected. Vous devez conserver cette étendue limitée lorsque vous remplacez la méthode dans votre classe. En conservant une Finalize méthode protégée, vous empêchez les utilisateurs de votre application d’appeler directement la méthode d’un Finalize objet.

Chaque implémentation d’un Finalize type dérivé doit appeler l’implémentation de son type de base de Finalize. Il s’agit du seul cas dans lequel le code de l’application est autorisé à appeler Finalize. La méthode d’un Finalize objet ne doit pas appeler une méthode sur des objets autres que celui de sa classe de base. Cela est dû au fait que les autres objets appelés peuvent être collectés en même temps que l’objet appelant, comme dans le cas d’un arrêt common language runtime.

Remarque

Le compilateur C# ne vous permet pas de remplacer la Finalize méthode. Au lieu de cela, vous fournissez un finaliseur en implémentant un destructeur pour votre classe. Un destructeur C# appelle automatiquement le destructeur de sa classe de base.

Visual C++ fournit également sa propre syntaxe pour implémenter la Finalize méthode. Pour plus d’informations, consultez la section « Destructeurs et finaliseurs » de How to : Define and Consume Classes and Structs (C++/CLI).

Étant donné que le garbage collection n’est pas déterministe, vous ne savez pas précisément quand le garbage collector effectue la finalisation. Pour libérer immédiatement des ressources, vous pouvez également choisir d’implémenter le modèle de suppression et l’interface IDisposable . L’implémentation IDisposable.Dispose peut être appelée par les consommateurs de votre classe pour libérer des ressources non managées, et vous pouvez utiliser la Finalize méthode pour libérer des ressources non managées si la Dispose méthode n’est pas appelée.

Finalizepeut effectuer presque n’importe quelle action, y compris la récupération d’un objet (autrement dit, rendre l’objet accessible à nouveau) une fois qu’il a été propre mis en place pendant le garbage collection. Toutefois, l’objet ne peut être ressuscité qu’une seule fois ; Finalize ne peut pas être appelé sur des objets ressuscités pendant le garbage collection.

L'alternative de SafeHandle

La création de finaliseurs fiables est souvent difficile, car vous ne pouvez pas faire des hypothèses sur l’état de votre application, et parce que des exceptions système non gérées telles que OutOfMemoryException et StackOverflowException mettent fin au finaliseur. Au lieu d’implémenter un finaliseur pour votre classe afin de libérer des ressources non managées, vous pouvez utiliser un objet dérivé de la System.Runtime.InteropServices.SafeHandle classe pour encapsuler vos ressources non managées, puis implémenter le modèle de suppression sans finaliseur. Le .NET Framework fournit les classes suivantes dans l’espace Microsoft.Win32 de noms dérivé de System.Runtime.InteropServices.SafeHandle:

L’exemple suivant utilise le modèle de suppression avec des handles sécurisés au lieu de remplacer la Finalize méthode. Il définit une FileAssociation classe qui encapsule les informations de Registre sur l’application qui gère les fichiers avec une extension de fichier particulière. Les deux handles de Registre retournés en tant que out paramètres par les appels de fonction Windows RegOpenKeyEx sont passés au SafeRegistryHandle constructeur. La méthode protégée Dispose du type appelle ensuite la SafeRegistryHandle.Dispose méthode pour libérer ces deux handles.

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