Язык программирования C#9 и платформа .NET5 - Эндрю Троелсен

using в C# имеет двойной смысл (импортирование пространств имен и вызов метода Dispose()). Однако при работе с типами, которые поддерживают интерфейс IDisposable, такая синтаксическая конструкция будет гарантировать, что используемый объект автоматический вызовет свой метод Dispose() по завершении блока using.

Кроме того, имейте в виду, что внутри using допускается объявлять несколько объектов одного и того же типа. Как и можно было ожидать, компилятор вставит код для вызова Dispose() на каждом объявленном объекте:

// Использовать список с разделителями-запятыми для объявления

// нескольких объектов, подлежащих освобождению.

using(MyResourceWrapper rw = new MyResourceWrapper(),

                        rw2 = new MyResourceWrapper())

{

  // Работать с объектами rw и rw2.

}

Объявления using (нововведение в версии 8.0)

В версии C# 8.0 были добавлены объявления using. Объявление using представляет собой объявление переменной, предваренное ключевым словом using. Функциональность объявления using будет такой же, как у синтаксиса, описанного в предыдущем разделе, за исключением явного блока кода, помещенного внутрь фигурных скобок ({}).

Добавьте к своему классу следующий метод:

private static void UsingDeclaration()

{

  // Эта переменная будет находиться в области видимости

  // вплоть до конца метода.

  using var rw = new MyResourceWrapper();

  // Сделать что-нибудь.

  Console.WriteLine("About to dispose.");

  // В этой точке переменная освобождается.

}

Далее добавьте к своим операторам верхнего уровня показанный ниже вызов:

Console.WriteLine("***** Fun with Dispose *****n");

...

Console.WriteLine("Demonstrate using declarations");

UsingDeclaration();

Console.ReadLine();

Если вы изучите новый метод с помощью ildasm.exe, то (вполне ожидаемо) обнаружите тот же код, что и ранее:

.method private hidebysig static

  void  UsingDeclaration() cil managed

{

  ...

  .try

  {

  ...

  }  // end .try

  finally

  {

    IL_0018: callvirt instance void

      [System.Runtime]System.IDisposable::Dispose()

    ...

  }  // end handler

  IL_001f: ret

} // end of method Program::UsingDeclaration

По сути, это новое средство является "магией" компилятора, позволяющей сэкономить несколько нажатий клавиш. При его использовании соблюдайте осторожность, т.к. новый синтаксис не настолько ясен, как предыдущий.

Создание финализируемых и освобождаемых типов

К настоящему моменту вы видели два разных подхода к конструированию класса, который очищает внутренние неуправляемые ресурсы. С одной стороны, можно применять финализатор. Использование такого подхода дает уверенность в том, что объект будет очищать себя сам во время сборки мусора (когда бы она ни произошла) без вмешательства со стороны пользователя. С другой стороны, можно реализовать интерфейс IDisposable и предоставить пользователю объекта способ очистки объекта по окончании работы с ним. Тем не менее, если пользователь объекта забудет вызвать метод Dispose(), то неуправляемые ресурсы могут оставаться в памяти неопределенно долго.

Нетрудно догадаться, что в одном определении класса можно смешивать оба подхода, извлекая лучшее из обеих моделей. Если пользователь объекта не забыл вызвать метод Dispose(), тогда можно проинформировать сборщик мусора о пропуске процесса финализации, вызвав метод GC.SuppressFinalize(). Если же пользователь объекта забыл вызвать Dispose(), то объект со временем будет финализирован и получит шанс освободить внутренние ресурсы. Преимущество здесь в том, что внутренние неуправляемые ресурсы будут тем или иным способом освобождены.

Ниже представлена очередная версия класса MyResourceWrapper, который теперь является финализируемым и освобождаемым; она определена в проекте консольного приложения C# по имени FinalizableDisposableClass:

using System;

namespace FinalizableDisposableClass

{

  // Усовершенствованная оболочка для ресурсов.

  public class MyResourceWrapper : IDisposable

  {

    // Сборщик мусора будет вызывать этот метод, если

    // пользователь объекта забыл вызвать Dispose().

    ~MyResourceWrapper()

    {

     // Очистить любые внутренние неуправляемые ресурсы.

     // **Не** вызывать Dispose() на управляемых объектах.

    }

    // Пользователь объекта будет вызывать этот метод

    // для как можно более скорой очистки ресурсов.

    public void Dispose()

    {

      // Очистить неуправляемые ресурсы.

      // Вызвать Dispose() для других освобождаемых объектов,

      // содержащихся внутри.

      // Если пользователь вызвал Dispose(), то финализация

      // не нужна, поэтому подавить ее.

      GC.SuppressFinalize(this);

    }

  }

}

Обратите внимание, что метод Dispose() был модифицирован для вызова метода GC.SuppressFinalize(), который информирует исполняющую среду о том, что вызывать деструктор при обработке данного объекта сборщиком мусора больше не обязательно, т.к. неуправляемые ресурсы уже освобождены посредством логики Dispose().

Формализованный шаблон освобождения

Текущая реализация класса MyResourceWrapper работает довольно хорошо, но осталось еще несколько небольших недостатков. Во-первых, методы Finalize() и Dispose() должны освобождать те же самые неуправляемые ресурсы. Это может привести к появлению дублированного кода, что существенно усложнит сопровождение. В идеале следовало бы определить закрытый вспомогательный метод и вызывать его внутри указанных методов.

Во-вторых, желательно удостовериться в том, что метод Finalize() не пытается освободить любые управляемые объекты, когда такие действия должен делать метод Dispose(). В-третьих, имеет смысл также позаботиться о том, чтобы пользователь объекта мог безопасно вызывать метод Dispose() много раз без возникновения ошибки. В настоящий момент защита подобного рода в методе Dispose() отсутствует.

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

class MyResourceWrapper : IDisposable

{

  // Используется для выяснения, вызывался ли метод Dispose().

  private bool disposed = false;

  public void Dispose()

  {

    // Вызвать вспомогательный метод.

    // Указание true означает, что очистку

    // запустил пользователь объекта.

    CleanUp(true);

    // Подавить финализацию.

    GC.SuppressFinalize(this);

  }

  private void CleanUp(bool disposing)

  {

    // Удостовериться, не выполнялось ли уже освобождение

    if (!this.disposed)

    {

      // Если disposing