Metoda System.Object.Finalize

  • Článek

Tento článek obsahuje doplňující poznámky k referenční dokumentaci pro toto rozhraní API.

Metoda Finalize slouží k provádění operací čištění nespravovaných prostředků uchovávaných aktuálním objektem před zničením objektu. Metoda je chráněna, a proto je přístupná pouze prostřednictvím této třídy nebo prostřednictvím odvozené třídy.

Jak finalizace funguje

Třída Object neposkytuje žádnou implementaci pro metodu Finalize a uvolňování paměti neoznačí typy odvozené z Object finalizace, pokud nepřepíše metodu Finalize .

Pokud typ přepíše metodu Finalize , systém uvolňování paměti přidá položku pro každou instanci typu do interní struktury označované jako finalizační fronta. Fronta finalizace obsahuje položky pro všechny objekty ve spravované haldě, jejichž finalizační kód musí běžet před uvolněním paměti uvolňování paměti. Systém uvolňování paměti pak volá metodu Finalize automaticky za následujících podmínek:

  • Jakmile uvolňování paměti zjistí, že objekt je nepřístupný, pokud objekt nebyl vyloučen z finalizace voláním GC.SuppressFinalize metody.
  • Pouze v rozhraní .NET Framework během vypínání domény aplikace, pokud objekt není vyloučen z finalizace. Během vypnutí jsou dokončeny i objekty, které jsou stále přístupné.

Finalize je automaticky volána pouze jednou v dané instanci, pokud objekt není znovu registrován pomocí mechanismu, jako GC.ReRegisterForFinalize je a GC.SuppressFinalize metoda nebyla následně volána.

Finalize operace mají následující omezení:

  • Přesný čas, kdy se finalizátor spustí, není definován. Pokud chcete zajistit deterministické uvolnění prostředků pro instance vaší třídy, implementujte metodu Close nebo poskytněte implementaci IDisposable.Dispose .
  • Finalizátory dvou objektů nejsou zaručeny spuštění v žádném konkrétním pořadí, a to ani v případě, že jeden objekt odkazuje na druhý. To znamená, že pokud objekt A má odkaz na objekt B a oba mají finalizační metody, objekt B již byl dokončen při spuštění finalizátoru objektu A.
  • Vlákno, na kterém se finalizátor spouští, není zadáno.

Metoda Finalize se nemusí spustit na dokončení nebo nemusí běžet vůbec za následujících výjimečných okolností:

  • Pokud další finalizační bloky po neomezenou dobu (přejde do nekonečné smyčky, pokusí se získat zámek, který nikdy nemůže získat atd.). Vzhledem k tomu, že modul runtime se pokusí dokončit finalizační metody, nemusí být volány jiné finalizační metody, pokud finalizační metody blokují neomezeně dlouho.
  • Pokud se proces ukončí, aniž by modul runtime mohl vyčistit. V tomto případě je prvním oznámením o ukončení procesu modulu runtime oznámení DLL_PROCESS_DETACH.

Modul runtime pokračuje v finalizaci objektů během vypínání pouze v době, kdy počet finalizovatelných objektů pokračuje v poklesu.

Pokud Finalize nebo přepsání Finalize vyvolá výjimku a modul runtime není hostovaný aplikací, která přepíše výchozí zásady, modul runtime proces ukončí a nespustí se žádné aktivní try/finally bloky ani finalizátory. Toto chování zajišťuje integritu procesu, pokud finalizátor nemůže uvolnit nebo zničit prostředky.

Přepsání metody Finalize

Měli byste přepsat Finalize třídu, která používá nespravované prostředky, jako jsou popisovače souborů nebo databázová připojení, která se musí uvolnit, když se spravovaný objekt, který je používá, zahodí během uvolňování paměti. Neměli byste implementovat metodu Finalize pro spravované objekty, protože systém uvolňování paměti automaticky uvolní spravované prostředky.

Důležité

SafeHandle Pokud je k dispozici objekt, který zabalí váš nespravovaný prostředek, doporučujeme implementovat vzor Dispose bezpečným popisovačem a nepřepsat Finalize. Další informace najdete v alternativní části Sejf Handle.

Metoda Object.Finalize ve výchozím nastavení nic nedělá, ale v případě potřeby byste měli přepsat Finalize pouze a pouze uvolnit nespravované prostředky. Uvolnění paměti obvykle trvá mnohem déle, pokud se spustí operace dokončení, protože vyžaduje alespoň dvě uvolňování paměti. Kromě toho byste měli přepsat metodu Finalize pouze pro odkazové typy. Modul CLR (Common Language Runtime) pouze finalizuje referenční typy. Ignoruje finalizační metody u typů hodnot.

Object.Finalize Rozsah metody je protected. Při přepsání metody ve třídě je vhodné ponechat tento omezený obor. Když necháte chráněnou metodu Finalize , zabráníte uživatelům aplikace v přímém volání metody objektu Finalize .

Každá implementace Finalize odvozeného typu musí volat jeho základní typ implementace Finalize. Toto je jediný případ, kdy kód aplikace může volat Finalize. Metoda objektu Finalize by neměla volat metodu na žádné jiné objekty, než je její základní třída. Je to proto, že ostatní volané objekty mohou být shromážděny současně s volajícím objektem, jako v případě vypínání modulu CLR.

Poznámka:

Kompilátor jazyka C# neumožňuje přepsat metodu Finalize . Místo toho zadáte finalizátor implementací destruktoru pro vaši třídu. Destruktor jazyka C# automaticky volá destruktor základní třídy.

Visual C++ také poskytuje vlastní syntaxi pro implementaci Finalize metody. Další informace najdete v části Destruktory a finalizátory v tématu Postupy: Definování a využívání tříd a struktur (C++/CLI).

Vzhledem k tomu, že uvolňování paměti není deterministické, nevíte přesně, kdy systém uvolňování paměti provádí finalizaci. Pokud chcete uvolnit prostředky okamžitě, můžete se také rozhodnout implementovat vzor Dispose a IDisposable rozhraní. Implementace IDisposable.Dispose může být volána příjemci vaší třídy k uvolnění nespravovaných prostředků a můžete použít metodu Finalize k uvolnění nespravovaných prostředků v případě, že Dispose metoda není volána.

Finalize může provést téměř jakoukoli akci, včetně obnovení objektu (tj. opětovného zpřístupnění objektu) po vyčištění během uvolňování paměti. Objekt však lze obnovit pouze jednou; Finalize nelze volat při obnovování objektů během uvolňování paměti.

Alternativní Sejf Handle

Vytváření spolehlivých finalizátorů je často obtížné, protože nemůžete provést předpoklady o stavu aplikace a protože neošetřené výjimky systému, jako OutOfMemoryException je a StackOverflowException ukončete finalizátor. Místo implementace finalizátoru pro vaši třídu k uvolnění nespravovaných prostředků můžete použít objekt odvozený z System.Runtime.InteropServices.SafeHandle třídy k zabalení nespravovaných prostředků a pak implementovat vzor Dispose bez finalizátoru. Rozhraní .NET Framework poskytuje následující třídy v Microsoft.Win32 oboru názvů, které jsou odvozeny z System.Runtime.InteropServices.SafeHandle:

Následující příklad používá vzor Dispose s bezpečnými popisovači místo přepsání Finalize metody. FileAssociation Definuje třídu, která zabalí informace registru o aplikaci, která zpracovává soubory s konkrétní příponou souboru. Dva obslužné rutiny registru vrácené jako out parametry volání funkce Windows RegOpenKeyEx jsou předány konstruktoru SafeRegistryHandle . Chráněná Dispose metoda typu pak volá metodu SafeRegistryHandle.Dispose , která uvolní tyto dva popisovače.

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