C finalize и dispose

Большинство объектов, используемых в программах на C#, относятся к управляемым или managed-коду, и легко очищаются сборщиком мусора. Однако вместе с тем встречаются также и такие объекты, которые задействуют неуправляемые объекты (низкоуровневые файловые дескрипторы, сетевые подключения и т.д.). Такие неуправляемые объекты обращаются к API операционной системы через службы PInvoke. Сборщик мусора может справиться с управляемыми объектами, однако он не знает, как удалять неуправляемые объекты. В этом случае разработчик должен сам реализовывать механизмы очистки на уровне программного кода.

Освобождение неуправляемых ресурсов подразумевает реализацию одного из двух механизмов:

Реализация классом интерфейса System.IDisposable

Создание деструкторов

Если вы вдруг программировали на языке C++, то наверное уже знакомы с концепцией деструкторов. Метод деструктора носит имя класса (как и конструктор), перед которым стоит знак тильды (

). Например, создадим деструктор класса Person:

Деструктор в отличие от конструктора не может иметь модификаторов доступа. В данном случае в деструкторе в целях демонстрации просто вызывается звуковой сигнал и выводится строка на консоль, но в реальных программах в деструктор вкладывается логика освобождения неуправляемых ресурсов.

Однако на деле при очистке сборщик мусора вызывает не деструктор, а метод Finalize класса Person. Все потому, что компилятор C# компилирует деструктор в конструкцию, которая эквивалентна следующей:

Метод Finalize уже определен в базовом для всех типов классе Object, однако данный метод нельзя так просто переопределить. И фактическая его реализация происходит через создание деструктора.

Используя в программе класс Person, после ее завершения можно будет услышать голосовой сигнал и увидеть на консоли выводимую строку:

Обратите внимание, что даже после завершения метода Test и соответственно удаления из стека ссылки на объект Person в куче, может не последовать немедленного вызова деструктора. Лишь при завершении всей программы гарантировано произойдет очистка памяти и вызов деструктора. Поэтому для более быстой очистки памяти применяется метод GC.Collect.

На уровне памяти это выглядит так: сборщик мусора при размещении объекта в куче определяет, поддерживает ли данный объект метод Finalize . И если объект имеет метод Finalize, то указатель на него сохраняется в специальной таблице, которая называется очередь финализации. Когда наступает момент сборки мусора, сборщик видит, что данный объект должен быть уничтожен, и если он имеет метод Finalize, то он копируется в еще одну таблицу и окончательно уничтожается лишь при следующем проходе сборщика мусора.

И здесь мы можем столкнуться со следующей проблемой: а что если нам немедленно надо вызвать деструктор и освободить все связанные с объектом неуправляемые ресурсы? В этом случае мы можем использовать второй подход — реализацию интерфейса IDisposable.

Интерфейс IDisposable

Интерфейс IDisposable объявляет один единственный метод Dispose , в котором при реализации интерфейса в классе должно происходить освобождение неуправляемых ресурсов. Например:

В данном коде используется конструкция try. finally. По сути эта конструкция по функционалу в общем эквивалентна следующим двум строкам кода:

Но конструкцию try. finally предпочтительнее использовать при вызове метода Dispose, так как она гарантирует, что даже в случае возникновения исключения произойдет освобождение ресурсов в методе Dispose.

Комбинирование подходов

Мы рассмотрели два подхода. Какой же из них лучше? С одной стороны, метод Dispose позволяет в любой момент времени вызвать освобождение связанных ресурсов, а с другой — программист, использующий наш класс, может забыть поставить в коде вызов метода Dispose. В общем бывают различные ситуации. И чтобы сочетать плюсы обоих подходов мы можем использовать комбинированный подход. Microsoft предлагает нам использовать следующий формализованный шаблон:

Логика очистки реализуется перегруженной версией метода Dispose(bool disposing) . При вызове деструктора в качестве параметра disposing передается значение false, чтобы избежать очистки управляемых ресурсов, так как мы не можем быть уверенными в их состоянии, что они до сих пор находятся в памяти. И в этом случае остается полагаться на деструкторы этих ресурсов. Ну и в обоих случаях освобождаются неуправляемые ресурсы.

Еще один важный момент — вызов в методе Dispose метода GC.SuppressFinalize(this) . GC.SuppressFinalize не позволяет системе выполнить метод Finalize для данного объекта.

Таким образом, даже если разработчик не использует в программе метод Dispose, все равно произойдет очистка и освобождение ресурсов.

Общие рекомендации по использованию Finalize и Dispose

Деструктор следует реализовывать только у тех объектов, которым он действительно необходим, так как метод Finalize оказывает сильное влияние на производительность

После вызова метода Dispose необходимо блокировать у объекта вызов метода Finalize с помощью GC.SuppressFinalize

При создании производных классов от базовых, которые реализуют интерфейс IDisposable, следует также вызывать метод Dispose базового класса:

Отдавайте предпочтение комбинированному шаблону, реализующему как метод Dispose, так и деструктор

Автор: sidorus ← к списку ← →

Имя деструктора()<>.
Деструктор вызывается автоматически CLR перед уничтожением объекта. Dispose() можно вызывать в ручном режиме,для освобождения ресурсов. Но после вызова Dispose() GC может вызывать деструктор тоесть будет проводится двойная работа, чтобы этого избежать Microsoft рекомендует использовать Паттерн ResourceWrapper.
Главная идея в том что если вызван метод Dispose() то finalize вызывать не нужно. Если пользователь забыл вызвать Dispose() то все равно сработает finalize.

Читайте также:  Как повысить скорость жесткого диска windows 7

Если Вам понравился вопрос, проголосуйте за него

Голосов: 94 Голосовать

Определение

Позволяет объекту попытаться освободить ресурсы и выполнить другие операции очистки, перед тем как он будет уничтожен во время сборки мусора. Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Примеры

В следующем примере проверяется, Finalize вызывается ли метод при уничтожении объекта, переопределяющего. Finalize The following example verifies that the Finalize method is called when an object that overrides Finalize is destroyed. Обратите внимание, что в рабочем приложении Finalize метод будет переопределен для освобождения неуправляемых ресурсов, удерживаемых объектом. Note that, in a production application, the Finalize method would be overridden to release unmanaged resources held by the object. Также обратите внимание C# , что в примере вместо переопределения Finalize метода предоставляется деструктор. Also note that the C# example provides a destructor instead of overriding the Finalize method.

Дополнительный пример переопределения Finalize метода см. в GC.SuppressFinalize описании метода. For an additional example that overrides the Finalize method, see the GC.SuppressFinalize method.

Комментарии

Finalize Метод используется для выполнения операций очистки неуправляемых ресурсов, хранящихся в текущем объекте, до уничтожения объекта. The Finalize method is used to perform cleanup operations on unmanaged resources held by the current object before the object is destroyed. Этот метод защищен и поэтому доступен только через этот класс или производный класс. The method is protected and therefore is accessible only through this class or through a derived class.

Содержание In this section:

Принцип работы финализации How finalization works

Класс не предоставляет реализацию Finalize для метода, и сборщик мусора не помечает типы, производные от Object для завершения, если только они не переопределяют Finalize метод. Object The Object class provides no implementation for the Finalize method, and the garbage collector does not mark types derived from Object for finalization unless they override the Finalize method.

Если тип переопределяет Finalize метод, сборщик мусора добавляет запись для каждого экземпляра типа во внутреннюю структуру, называемую очередью финализации. If a type does override the Finalize method, the garbage collector adds an entry for each instance of the type to an internal structure called the finalization queue. Очередь финализации содержит записи для всех объектов в управляемой куче, код завершения которых должен быть выполнен до освобождения памяти сборщиком мусора. The finalization queue contains entries for all the objects in the managed heap whose finalization code must run before the garbage collector can reclaim their memory. Затем сборщик мусора вызывает Finalize метод автоматически при выполнении следующих условий: The garbage collector then calls the Finalize method automatically under the following conditions:

После того как сборщик мусора обнаружит, что объект недоступен, за исключением случаев, когда объект был исключен из финализации путем вызова GC.SuppressFinalize метода. After the garbage collector has discovered that an object is inaccessible, unless the object has been exempted from finalization by a call to the GC.SuppressFinalize method.

Только в .NET Framework, во время завершения работы домена приложения, если только объект не исключен из финализации. On .NET Framework only, during shutdown of an application domain, unless the object is exempt from finalization. Во время завершения работы, даже объекты, которые по-прежнему доступны, завершаются. During shutdown, even objects that are still accessible are finalized.

Finalizeметод автоматически вызывается только один раз для данного экземпляра, если только объект не будет повторно зарегистрирован с помощью механизма, такого GC.ReRegisterForFinalize как, и не был впоследствии вызван методом. GC.SuppressFinalize Finalize is automatically called only once on a given instance, unless the object is re-registered by using a mechanism such as GC.ReRegisterForFinalize and the GC.SuppressFinalize method has not been subsequently called.

Finalizeоперации имеют следующие ограничения. Finalize operations have the following limitations:

Точное время выполнения метода завершения не определено. The exact time when the finalizer executes is undefined. Чтобы обеспечить детерминированный выпуск ресурсов для экземпляров класса, реализуйте Close метод или IDisposable.Dispose предоставьте реализацию. To ensure deterministic release of resources for instances of your class, implement a Close method or provide a IDisposable.Dispose implementation.

Методы завершения двух объектов не гарантированно выполняются в каком бы то ни было определенном порядке, даже если один объект ссылается на другой. The finalizers of two objects are not guaranteed to run in any specific order, even if one object refers to the other. То есть если объект A имеет ссылку на объект B и оба метода имеют методы завершения, то объект B может быть уже завершен при запуске метода завершения объекта A. That is, if Object A has a reference to Object B and both have finalizers, Object B might have already been finalized when the finalizer of Object A starts.

Читайте также:  Как восстановить удаленный офис на windows 10

Поток, в котором выполняется метод завершения, не определен. The thread on which the finalizer runs is unspecified.

Finalize Метод может не выполняться до завершения или вообще не выполняться при следующих исключительных обстоятельствах: The Finalize method might not run to completion or might not run at all under the following exceptional circumstances:

Если другой метод завершения блокируется неограниченно (переходит в бесконечный цикл, пытается получить блокировку, которую он никогда не может получить и т. д.). If another finalizer blocks indefinitely (goes into an infinite loop, tries to obtain a lock it can never obtain, and so on). Поскольку среда выполнения пытается выполнить методы завершения до завершения, другие методы завершения могут не вызываться, если метод завершения блокирует неограниченное время. Because the runtime tries to run finalizers to completion, other finalizers might not be called if a finalizer blocks indefinitely.

Значение, если процесс завершается без предоставления среде выполнения возможности очистки. If the process terminates without giving the runtime a chance to clean up. В этом случае первое уведомление среды выполнения о завершении процесса — это DLL_PROCESS_DETACH уведомление. In this case, the runtime’s first notification of process termination is a DLL_PROCESS_DETACH notification.

Среда выполнения продолжит завершать объекты во время завершения работы только в тот момент, когда число объектов, которые можно завершить, будет уменьшаться. The runtime continues to finalize objects during shutdown only while the number of finalizable objects continues to decrease.

Если Finalize try или / переопределение finally вызывает исключение, а среда выполнения не размещается приложением, которое переопределяет политику по умолчанию, среда выполнения завершает процесс и не обрабатывает активные блоки или Finalize методы завершения выполняются. If Finalize or an override of Finalize throws an exception, and the runtime is not hosted by an application that overrides the default policy, the runtime terminates the process and no active try / finally blocks or finalizers are executed. Такое поведение обеспечивает целостность процессов, если финализатор не может освободить или уничтожить ресурсы. This behavior ensures process integrity if the finalizer cannot free or destroy resources.

Переопределение метода Finalize Overriding the Finalize method

Необходимо переопределить Finalize для класса, использующего неуправляемые ресурсы, такие как дескрипторы файлов или подключения к базе данных, которые должны быть освобождены, когда управляемый объект, использующий их, будет удален во время сборки мусора. You should override Finalize for a class that uses unmanaged resources, such as file handles or database connections that must be released when the managed object that uses them is discarded during garbage collection. Не следует реализовывать Finalize метод для управляемых объектов, так как сборщик мусора вывысвобождает управляемые ресурсы автоматически. You shouldn’t implement a Finalize method for managed objects because the garbage collector releases managed resources automatically.

Если доступен Finalizeобъект, который создает оболочку для неуправляемого ресурса, рекомендуемым альтернативом является реализация шаблона удаления с помощью безопасного маркера, а не переопределения. SafeHandle If a SafeHandle object is available that wraps your unmanaged resource, the recommended alternative is to implement the dispose pattern with a safe handle and not override Finalize. Дополнительные сведения см. в разделе альтернатива SafeHandle . For more information, see The SafeHandle alternative section.

По умолчанию Finalizeметодне выполняет никаких действий, но при необходимости его следует переопределить только для освобождения неуправляемых ресурсов. Object.Finalize The Object.Finalize method does nothing by default, but you should override Finalize only if necessary, and only to release unmanaged resources. Освобождение памяти обычно занимает намного больше времени, если выполняется операция финализации, так как для нее требуется как минимум две сборки мусора. Reclaiming memory tends to take much longer if a finalization operation runs, because it requires at least two garbage collections. Кроме того, следует переопределить Finalize метод только для ссылочных типов. In addition, you should override the Finalize method for reference types only. Среда CLR завершает только ссылочные типы. The common language runtime only finalizes reference types. Он игнорирует методы завершения для типов значений. It ignores finalizers on value types.

Областью действия Object.Finalize метода является protected . The scope of the Object.Finalize method is protected . Эту ограниченную область следует поддерживать при переопределении метода в классе. You should maintain this limited scope when you override the method in your class. Сохраняя Finalize защищенный метод, пользователи приложения не смогут напрямую вызывать Finalize метод объекта. By keeping a Finalize method protected, you prevent users of your application from calling an object’s Finalize method directly.

Читайте также:  Игры на движке хавок

Каждая реализация Finalize в производном типе должна вызывать Finalizeреализацию его базового типа. Every implementation of Finalize in a derived type must call its base type’s implementation of Finalize. Это единственный случай, когда коду приложения разрешено вызывать Finalize. This is the only case in which application code is allowed to call Finalize. Finalize Метод объекта не должен вызывать метод для всех объектов, отличных от базового класса. An object’s Finalize method shouldn’t call a method on any objects other than that of its base class. Это связано с тем, что другие вызываемые объекты могут собираться одновременно с вызывающим объектом, например в случае завершения работы среды CLR. This is because the other objects being called could be collected at the same time as the calling object, such as in the case of a common language runtime shutdown.

C# Компилятор не позволяет переопределить Finalize метод. The C# compiler does not allow you to override the Finalize method. Вместо этого метод завершения предоставляется путем реализации деструктора для класса. Instead, you provide a finalizer by implementing a destructor for your class. C# Деструктор автоматически вызывает деструктор своего базового класса. A C# destructor automatically calls the destructor of its base class.

Визуальный C++ элемент Finalize также предоставляет собственный синтаксис для реализации метода. Visual C++ also provides its own syntax for implementing the Finalize method. Дополнительные сведения см. в подразделе "деструкторы и методы завершения" статьи как Определение и использование классов и структур (C++/CLI). For more information, see the "Destructors and finalizers" section of How to: Define and Consume Classes and Structs (C++/CLI).

Поскольку сборка мусора является недетерминированной, вы точно не узнаете, когда сборщик мусора выполняет завершение. Because garbage collection is non-deterministic, you do not know precisely when the garbage collector performs finalization. Для немедленного освобождения ресурсов можно также выбрать реализацию шаблона удаления и IDisposable интерфейса. To release resources immediately, you can also choose to implement the dispose pattern and the IDisposable interface. Реализация может быть вызвана потребителями вашего класса для освобождения неуправляемых ресурсов, и Finalize метод можно использовать для высвобождения неуправляемых ресурсов Dispose в случае, если метод не вызывается. IDisposable.Dispose The IDisposable.Dispose implementation can be called by consumers of your class to free unmanaged resources, and you can use the Finalize method to free unmanaged resources in the event that the Dispose method is not called.

Finalizeможет выполнить практически любое действие, включая восстановление объекта (т. е. сделать объект доступным снова) после его очистки во время сборки мусора. Finalize can take almost any action, including resurrecting an object (that is, making the object accessible again) after it has been cleaned up during garbage collection. Однако объект может быть восстановлен только один раз. Finalize нельзя вызвать для восстановленных объектов во время сборки мусора. However, the object can only be resurrected once; Finalize cannot be called on resurrected objects during garbage collection.

Альтернатива SafeHandle The SafeHandle alternative

Создание надежных методов завершения зачастую сложно, поскольку вы не можете делать предположения о состоянии приложения, а также из-за необработанных системных исключений, таких как OutOfMemoryException , StackOverflowException и завершения метода завершения. Creating reliable finalizers is often difficult, because you cannot make assumptions about the state of your application, and because unhandled system exceptions such as OutOfMemoryException and StackOverflowException terminate the finalizer. Вместо реализации метода завершения для класса для освобождения неуправляемых ресурсов можно использовать объект, производный от System.Runtime.InteropServices.SafeHandle класса, для упаковки неуправляемых ресурсов, а затем реализовать шаблон Dispose без метода завершения. Instead of implementing a finalizer for your class to release unmanaged resources, you can use an object that is derived from the System.Runtime.InteropServices.SafeHandle class to wrap your unmanaged resources, and then implement the dispose pattern without a finalizer. .NET Framework предоставляет следующие классы в Microsoft.Win32 пространстве имен, которые являются производными от: System.Runtime.InteropServices.SafeHandle The .NET Framework provides the following classes in the Microsoft.Win32 namespace that are derived from System.Runtime.InteropServices.SafeHandle:

SafeFileHandle— Это класс-оболочка для маркера файла. SafeFileHandle is a wrapper class for a file handle.

SafeMemoryMappedFileHandle— Это класс-оболочка для дескрипторов размещенных в памяти файлов. SafeMemoryMappedFileHandle is a wrapper class for memory-mapped file handles.

SafeMemoryMappedViewHandle— Это класс-оболочка для указателя на блок неуправляемой памяти. SafeMemoryMappedViewHandle is a wrapper class for a pointer to a block of unmanaged memory.

SafePipeHandle— Это класс-оболочка для дескрипторов канала. SafePipeHandle is a wrapper class for pipe handles.

SafeRegistryHandle— Это класс-оболочка для маркера в разделе реестра. SafeRegistryHandle is a wrapper class for a handle to a registry key.

SafeWaitHandle— Это класс-оболочка для обработчика ожидания. SafeWaitHandle is a wrapper class for a wait handle.