Книга: C# 4.0: полное руководство

Отмена задачи и обработка исключения AggregateException

Отмена задачи и обработка исключения AggregateException

В версии 4.0 среды .NET Framework внедрена новая подсистема, обеспечивающая структурированный, хотя и очень удобный способ отмены задачи. Эта новая подсистема основывается на понятии признака отмены. Признаки отмены поддерживаются в классе Task, среди прочего, с помощью фабричного метода StartNew().

------------------------------------

ПРИМЕЧАНИЕ

Новую подсистему отмены можно применять и для отмены потоков, рассматривавшихся в предыдущей главе, но она полностью интегрирована в TPL и PLINQ. Именно поэтому эта подсистема рассматривается в этой главе.

------------------------------------

Отмена задачи, как правило, выполняется следующим образом. Сначала получается признак отмены из источника признаков отмены. Затем этот признак передается задаче, после чего она должна контролировать его на предмет получения запроса на отмену. (Этот запрос может поступить только из источника признаков отмены.) Если получен запрос на отмену, задача должна завершиться. В одних случаях этого оказывается достаточно для простого прекращения задачи без каких-либо дополнительных действий, а в других — из задачи должен быть вызван метод ThrowIfCancellationRequested() для признака отмены. Благодаря этому в отменяющем коде становится известно, что задача отменена. А теперь рассмотрим процесс отмены задачи более подробно.

'Признак отмены является экземпляром объекта типа CancellationToken, т.е. структуры, определенной в пространстве имен System.Threading. В структуре CancellationToken определено несколько свойств и методов, но мы воспользуемся двумя из них. Во-первых, это доступное только для чтения свойство IsCancellationRequested, которое объявляется следующим образом.

public bool IsCancellationRequested { get; }

Оно возвращает логическое значение true, если отмена задачи была запрошена для вызывающего признака, а иначе — логическое значение false. И во-вторых, это метод ThrowIfCancellationRequested(), который объявляется следующим образом.

public void ThrowIfCancellationRequested()

Если признак отмены, для которого вызывается этот метод, получил запрос на отмену, то в данном методе генерируется исключение OperationCanceledException. В противном случае никаких действий не выполняется. В отменяющем коде можно организовать отслеживание упомянутого исключения с целью убедиться в том, что отмена задачи действительно произошла. Как правило, с этой целью сначала перехватывается исключение AggregateException, а затем его внутреннее исключение анализируется с помощью свойства InnerException или InnerExceptions. (Свойство InnerExceptions представляет собой коллекцию исключений. Подробнее о коллекциях речь пойдет в главе 25.)

Признак отмены получается из источника признаков отмены, который представляет собой объект класса CancellationTokenSource, определенного в пространстве имен System.Threading. Для того чтобы получить данный признак, нужно создать сначала экземпляр объекта типа CancellationTokenSource. (С этой целью можно воспользоваться вызываемым по умолчанию конструктором класса CancellationTokenSource.) Признак отмены, связанный сданным источником, оказывается доступным через используемое только для чтения свойство Token, которое объявляется следующим образом.

public CancellationToken Token { get; }

Это и есть тот признак, который должен быть передан отменяемой задаче.

Для отмены в задаче должна быть получена копия признака отмены и организован контроль этого признака с целью отслеживать саму отмену. Такое отслеживание можно организовать тремя способами: опросом, методом обратного вызова и с помощью дескриптора ожидания. Проще всего организовать опрос, и поэтому здесь будет рассмотрен именно этот способ. С целью опроса в задаче проверяется упомянутое выше свойство IsCancellationRequested признака отмены. Если это свойство содержит логическое значение true, значит, отмена была запрошена, и задача должна быть завершена. Опрос может оказаться весьма эффективным, если организовать его правильно. Так, если задача содержит вложенные циклы, то проверка свойства IsCancellationRequested во внешнем цикле зачастую дает лучший результат, чем его проверка на каждом шаге внутреннего цикла.

Для создания задачи, из которой вызывается метод ThrowIfCancellationRequested(), когда она отменяется, обычно требуется передать признак отмены как самой задаче, так и конструктору класса Task, будь то непосредственно или же косвенно через метод StartNew(). Передача признака отмены самой задаче позволяет изменить состояние отменяемой задачи в запросе на отмену из внешнего кода. Далее будет использована следующая форма метода StartNew().

public Task StartNew(Action<Object> action, Object состояние,
                   CancellationToken признак_отмены)

В этой форме признак отмены передается через параметры, обозначаемые как состояние и признак_отмены. Это означает, что признак отмены будет передан как делегату, реализующему задачу, так и самому экземпляру объекта типа Task. Ниже приведена форма, поддерживающая делегат Action.

public delegate void Actioncin T>(T obj)

В данном случае обобщенный параметр Т обозначает тип Object. В силу этого объект obj должен быть приведен внутри задачи к типу CancellationToken.

И еще одно замечание: по завершении работы с источником признаков отмены следует освободить его ресурсы, вызвав метод Dispose().

Факт отмены задачи может быть проверен самыми разными способами. Здесь применяется следующий подход: проверка значения свойства IsCanceled для экземпляра объекта типа Task. Если это логическое значение true, то задача была отменена.

В приведенной ниже программе демонстрируется отмена задачи. В ней применяется опрос для контроля состояния признака отмены. Обратите внимание на то, что метод ThrowIfCancellationRequested() вызывается после входа в метод MyTask(). Это дает возможность завершить задачу, если она была отмена еще до ее запуска. Внутри цикла проверяется свойство IsCancellationRequested. Если это свойство содержит логическое значение true, а оно устанавливается после вызова метода Cancel() для экземпляра источника признаков отмены, то на экран выводится сообщение об отмене и далее вызывается метод ThrowIfCancellationRequested() для отмены задачи.

// Простой пример отмены задачи с использованием опроса.
using System;
using System.Threading;
using System.Threading.Tasks;
class DemoCancelTask {
  // Метод, исполняемый как задача,
  static void MyTask(Object ct) {
    CancellationToken cancelTok = (CancellationToken) ct;
    // Проверить, отменена ли задача,
    // прежде чем запускать ее.
    cancelTok.ThrowIfCancellationRequested();
    Console.WriteLine("MyTask() запущен");
    for(int count = 0; count < 10; count++) {
      // В данном примере для отслеживания отмены задачи применяется опрос,
      if(cancelTok.IsCancellationRequested) {
        Console.WriteLine("Получен запрос на отмену задачи.");
        cancelTok.ThrowIfCancellationRequested();
      }
      Thread.Sleep(500);
      Console.WriteLine("В методе MyTask() подсчет равен " + count );
    }
    Console.WriteLine("MyTask завершен");
  }
  static void Main() {
    Console.WriteLine("Основной поток запущен.");
    // Создать объект источника признаков отмены.
    CancellationTokenSource cancelTokSrc = new CancellationTokenSource();
    // Запустить задачу, передав признак отмены ей самой и делегату.
    Task tsk = Task.Factory.StartNew(MyTask, cancelTokSrc.Token,
              cancelTokSrc.Token);
    // Дать задаче возможность исполняться вплоть до ее отмены.
    Thread.Sleep(2000);
    try {
      // Отменить задачу.
      cancelTokSrc.Cancel();
      // Приостановить выполнение метода Main() до тех пор,
      // пока не завершится задача tsk.
      tsk.Wait();
    } catch (AggregateException exc) {
      if(tsk.IsCanceled)
        Console.WriteLine("nЗадача tsk отменена");
      // Для просмотра исключения снять комментарии со следующей строки кода:
      // Console.WriteLine(exc);
    } finally {
      tsk.Dispose();
      cancelTokSrc.Dispose();
    }
    Console.WriteLine("Основной поток завершен.");
  }
}

Ниже приведен результат выполнения этой программы. Обратите внимание на то что задача отменяется через 2 секунды.

Основной поток запущен.
MyTask() запущен
В методе MyTask() подсчет равен 0
В методе MyTask() подсчет равен 1
В методе MyTask() подсчет равен 2
В методе MyTask() подсчет равен 3
Получен запрос на отмену задачи.
Задача tsk отменена
Основной поток завершен.

Как следует из приведенного выше результата, выполнение метода MyTask() отменяется в методе Main() лишь две секунды спустя. Следовательно, в методе MyTask() выполняются четыре шага цикла. Когда же перехватывается исключение AggregateException, проверяется состояние задачи. Если задача tsk отменена, что и должно произойти в данном примере, то об этом выводится соответствующее сообщение. Следует, однако, иметь в виду, что когда сообщение AggregateException генерируется в ответ на отмену задачи, то это еще не свидетельствует об ошибке, а просто означает, что задача была отменена.

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

Оглавление книги