Асинхронное программирование в C# (теория)
последнее обновление: 13 марта 2019
Контекст выполнения (ExecutionContext)
Контекст выполнения (ExecutionContext) - это родительский контекст (контейнер для других конекстов), включающий все остальные контексты.
Он не имеет собственного поведения, а служит только для запоминания и передачи контекста и используется такими компонентами .NET, как класс Task.
Контекст синхронизации (SynchronizationContext)
Контекст синхронизации (SynchronizationContext) - позволяет возобновить выполнение метода в конкретном потоке.
Текущий контекст SynchronizationContext – это свойство текущего потока. Идея в том, что всякий раз, как код исполняется в каком-то специальном потоке, мы
можем получить текущий контекст синхронизации и сохранить его.
Впоследствии этот контекст можно использовать для того, чтобы продолжить исполнение кода в том потоке, в котором оно было начато.
В классе SynchronizationContext есть важный метод Post , который гарантирует, что переданный делегат будет исполняться в правильном контексте.
Важно! В момент приостановки метода при встрече оператора await текущий контекст SynchronizationContext сохраняется.
Далее, когда метод возобновляется, компилятор вставляет вызов Post , чтобы исполнение возобновилось в запомненном контексте.
Асинхронное программирование
Код называется асинхронным , если он запускает какую-то длительную операцию, но не дожидается ее завершения. Противоположностью является блокирующий код, который ничего не делает, пока операция не завершится.
К числу таких длительных операций можно отнести:
• сетевые запросы;
• доступ к диску;
• продолжительные задержки.
Если этот поток продолжает делать что-то еще, пока выполняется длительная операция, то код асинхронный . Если поток в это время ничего не делает, значит, он заблокирован и, следовательно, вы написали блокирующий код .
Всякий раз, запуская новый поток или пользуясь классом ThreadPool, вы пишете асинхронную программу , потому что текущий поток может продолжать заниматься другими вещами.
Чем так хорош асинхронный код?
Асинхронный код освобождает поток , из которого был запущен. И это очень хорошо по многим причинам.
Часто существует лишь один поток, способный выполнить определенную задачу (например, поток пользовательского интерфейса) и, если не освободить его быстро, то приложение перестанет реагировать на действия пользователя.
Но самым важным мне кажется тот факт, что асинхронное выполнение открывает возможность для параллельных вычислений .
Что такое async?
В версии C# 5.0 Microsoft добавила механизм, предстающий в виде двух новых ключевых слов: async и await .
Механизм async встроен в компилятор и без поддержки с его стороны не мог бы быть реализован в библиотеке. Компилятор преобразовывает исходный код, то есть действует примерно по тому же принципу, что в случае лямбда-выражений и итераторов в предыдущих версиях C#.
Серверный код веб-приложения
У ASP.NET-приложений на веб-сервере нет ограничения на единственный поток , как в случае программ с пользовательским интерфейсом. И тем не менее асинхронное выполнение может оказаться весьма полезным, так как для таких приложений характерны длительные операции, особенно запросы к базе данных.
В зависимости от версии IIS может быть ограничено либо общее число потоков, обслуживающих веб-запросы, либо общее число одновременно обрабатываемых запросов. Если большая часть времени обработки запроса уходит на обращение к базе данных, то увеличение числа одновременно обрабатываемых запросов может повысить пропускную способность сервера
Помните: основная отличительная особенность асинхронного кода состоит в том, что поток, начавший длительную операцию, освобождается для других дел .
В случае ASP.NET этот поток берется из пула потоков, поэтому после запуска длительной операции он сразу же возвращается в пул и может затем использоваться для обработки других запросов. Таким образом, для обработки одного и того же количества запросов требуется меньше потоков.
Введение в класс Task
Библиотека Task Parallel Library была включена в версию .NET Framework 4.0. Важнейшим в ней является класс
Task , представляющий выполняемую операцию. Его универсальный вариант,
Task<T> , играет роль обещания вернуть значение (типа T), когда в будущем, по завершении операции, оно станет доступно.
Как мы увидим ниже,
механизм async в C# 5.0 активно пользуется классом Task. Но и без async классом Task, а особенно его вариантом Task
, можно воспользоваться при написании асинхронных программ. Для этого нужно запустить операцию, которая возвращает Task<T>, а затем вызвать метод ContinueWith для регистрации обратного вызова.
Это называется асинхронность вручную потому что используем метод ContinueWith .
Заметка на будующее:
Класс Task умеет в частности обрабатывать исключения и работать с контекстами синхронизации SynchronizationContext .
Мы увидим, что это полезно, когда требуется выполнить обратный вызов в конкретном потоке (например, в потоке пользовательского интерфейса).
Написание асинхронных методов:
1-ый шаг это пометка метода ключевым словом async .
Оно включается в сигнатуру метода точно так же, как, например, слово static.
2-ой шаг мы должны дождаться завершения скачивания, воспользовавшись ключевым словом await .
С точки зрения синтаксиса C#, await – это унарный оператор, такой же как оператор ! или оператор приведения типа (type).
Он располагается слева от выражения и означает, что нужно дождаться завершения асинхронного выполнения этого выражения.
На заметку!
Метод, помеченный ключевым словом async, автоматически не становится асинхронным .
Async-методы лишь упрощают использование других асинхронных методов. Они начинают исполняться синхронно, и так происходит до тех пор, пока не встретится вызов асинхронного метода внутри оператора await .
В этот момент сам вызывающий метод становится асинхронным.
Если же оператор await не встретится, то метод так и будет выполняться синхронно до своего завершения.
Task и await
Я говорил, что класс Task представляет выполняемую операцию, а его подкласс Task<T> – операцию, которая в будущем вернет значение типа T. Можно считать, что Task<T> – это обещание вернуть значение типа T по завершении длительной операции.
Оба класса Task и Task<T> могут представлять асинхронные операции, и оба умеют вызывать ваш код по завершении операции. Чтобы воспользоваться этой возможностью вручную, необходимо вызвать метод ContinueWith , передав ему код, который должен быть выполнен, когда длительная операция завершится. Именно так и поступает оператор await , чтобы выполнить оставшуюся часть async-метода .
Если применить await к объекту типа Task<T> , то мы получим выражение await , которое само имеет тип T .
Это означает, что результат оператора await можно присвоить переменной, которая используется далее в методе, что мы и видели в примерах.
Однако если await применяется к объекту неуниверсального класса Task , то получается предложение await , которое ничему нельзя присвоить (как и результат метода типа void). Это разумно, потому что класс Task не обещает вернуть значение в качестве результата, а представляет лишь саму операцию.
Тип значения, возвращаемого асинхронным методом
Метод, помеченный ключевым словом async , может возвращать значения трех типов:
• void
• Task
• Task, где T – некоторый тип.
Никакие другие типы не допускаются, потому что в общем случае
исполнение асинхронного метода не завершается в момент возврата управления. Как правило, асинхронный метод ждет завершения длительной операции, то есть управление-то он возвращает сразу, но результат в этот момент еще не получен и, стало быть, недоступен вызывающей программе.
Я провожу различие между типом возвращаемого методом значения (например, Task<string> ) и типом результата, который нужен вызывающей программе (в данном случае string).
В обычных, не асинхронных, методах тип возвращаемого значения совпадает с типом результата, тогда как в асинхронных методах они различны – и это очень существенно.
Использовать тип void следует, когда вы уверены, что вызывающей программе безразлично, когда завершится операция и завершится ли она успешно.
Async-методы , возвращающие тип Task , позволяют вызывающей программе ждать завершения асинхронной операции и распространяют исключения, имевшие место при ее выполнении.
Если значение результата несущественно, то метод типа async Task предпочтительнее метода типа async void , потому что вызывающая программа получает возможность узнать о завершении операции, что упрощает упорядочение задач и обработку исключений.
Async, сигнатуры методов и интерфейсы
Ключевое слово async указывается в объявлении метода, как public или static.
Однако спецификатор async не считается частью сигнатуры метода, когда речь заходит о переопределении виртуальных методов, реализации интерфейса или вызове.
То есть в отношении переопределения методов и реализации интерфейсов, слово async полностью игнорируется.
В объявлениях методов интерфейса слово async запрещено просто потому, что в этом нет необходимости. Если в интерфейсе объявлен метод, возвращающий тип Task , то в реализующем интерфейс классе этот метод может быть помечен словом async, а может быть и не помечен – на усмотрение программиста.
Приостановка и возобновление метода
Когда поток исполнения программы доходит до оператора await, должны произойти две вещи:
1) Текущий поток должен быть освобожден, чтобы поведение программы было асинхронным. С привычной, синхронной, точки зрения это означает, что метод должен вернуть управление.
2) Когда задача Task , погруженная в оператор await, завершится, ваш метод должен продолжить выполнение с того места, где перед этим вернул управление, как будто этого возврата никогда не было.
Чтобы добиться такого поведения, метод должен приостановить выполнение, дойдя до await , и возобновить его впоследствии.
Состояние метода
Чтобы стало яснее, сколько работы должен выполнить компилятор C#, встретив в программе оператор await , я перечислю, какие именно аспекты состояния метода необходимо сохранить.
Во-первых, запоминаются все локальные переменные метода, в том числе:
• параметры метода
• все переменные, определенные в текущей области видимости
• все прочие переменные, например счетчики циклов
• переменную this, если метод не статический
В результате после возобновления метода окажутся доступны все переменные-члены класса.
Всё это сохраняется в виде объекта в куче .NET, обслуживаемой сборщиком мусора. Таким образом, встретив await , компилятор выделяет память для объекта, то есть расходует ресурсы, но в большинстве случае это не приводит к потере производительности.
C# также запоминает место, где встретился оператор await .
контекст синхронизации, который среди прочего позволяет возобновить выполнение метода в конкретном потоке.
мое: Task помогает востанавливать контекст синхронизации, перед обратным вызовом
ExecutionContext - это родительский контекст, включающий все остальные контексты. Он не имеет собственного поведения, а служит только для запоминания и передачи контекста и используется такими компонентами .NET, как класс Task.
Когда нельзя использовать await
Оператор
await можно использовать почти в любом месте метода, помеченного ключевым словом
async .
Оператор
await может встречаться внутри блока
try ,
но не внутри блоков catch или finally .
В блоке
catch часто, а в блоке
finally всегда, исключение еще находится в фазе раскрутки стека и позже может быть возбуждено в блоке повторно.
Если использовать в этой точке await, то стек окажется другим, и определить в этой ситуации поведение повторного возбуждения исключения было бы очень сложно.
Напомню, что
await всегда можно поставить не внутри блока catch, а после него, для чего следует либо воспользоваться предложением return, либо завести булевскую переменную, в которой запомнить, возбуждала ли исходная операция исключение. Например, вместо такого некорректного в C# кода:
C#
try
{
page = await webClient.DownloadStringTaskAsync("http://aaa.com" );
}
catch (WebException)
{
page = await webClient.DownloadStringTaskAsync("http://ooo.com" );
}
можно было бы написать:
C#
bool failed = false;
try
{
page = await webClient.DownloadStringTaskAsync("http://aaa.com" );
}
catch (WebException)
{
failed = true;
}
if (failed)
{
page = await webClient.DownloadStringTaskAsync("http://ooo.com" );
}
Блоки lock
Ключевое слово lock позволяет запретить другим потокам доступ к объектам, с которыми в данный момент работает текущий поток.
Поскольку асинхронный метод обычно освобождает поток, в котором начал асинхронную операцию, и через неопределенно долгое время может быть возобновлен в другом потоке, то удерживать блокировку во время выполнения await не имеет смысла.
Запоминание исключений
По завершении операции в объекте Task сохраняется информация о том, завершилась ли она успешно или с ошибкой. Получить к ней доступ проще всего с помощью свойства IsFaulted, которое равно true, если во время выполнения операции произошло исключение.
Оператор await знает об этом и повторно возбуждает исключение, хранящееся в Task.
У читателя, знакомого с системой исключений в .NET, может возникнуть вопрос, корректно ли сохраняется первоначальная трассировка стека исключения при его повторном возбуждении.
Раньше это было невозможно; каждое исключение могло быть возбуждено только один раз. Однако в .NET 4.5 это ограничение снято благодаря новому классу ExceptionDispatchInfo, который взаимодействует с классом Exception с целью запоминания трассировки стека и воспроизведения ее при повторном возбуждении.
Async-методы также знают об исключениях. Любое исключение, возбужденное, но не перехваченное в async-методе, помещается в объект Task, возвращаемый вызывающей программе. Если в этот момент вызывающая программа уже ждет объекта Task, то исключение будет возбуждено в точке ожидания. Таким образом, исключение передается вызывающей программе вместе со сформированной виртуальной трассировкой стека – точно так же, как в синхронном коде.
Я называю это виртуальной трассировкой стека, потому что стек – вообще-то принадлежность потока, а в асинхронной программе реальный стек текущего потока может не иметь ничего общего с трассировкой стека в момент исключения. В исключении запоминается трассировка стека, отражающая намерение программиста, в ней представлены те методы, который программист вызывал сам, а не детали того, как C# исполнял части этих методов в действительности.
Асинхронные методы до поры исполняются синхронно Выше я уже отмечал, что async-метод становится асинхронным , только встретив вызов асинхронного метода внутри оператора await . До этого момента он работает в том потоке, в котором вызван, как обычный синхронный метод.
Использование Task для операций, требующих большого объема вычислений
Иногда длительная операция не отправляет запросов в сеть и не обращается к диску, а просто выполняет продолжительное вычисление.
Разумеется, нельзя рассчитывать на то, что поток быстро выполнит, желательно избежать зависания пользовательского интерфейса.
Для этого мы должны вернуть управление потоку пользовательского интерфейса, чтобы он мог обрабатывать другие события, а длительное вычисление производить в отдельном потоке.
Класс Task позволяет это сделать, а для обновления пользовательского интерфейса по завершении вычисления мы можем, как обычно, использовать await:
C#
Task t = Task.Run(() => MyLongComputation(a, b));
Метод Task.Run исполняет переданный ему делегат в потоке, взятом из пула ThreadPool. В данном случае я воспользовался лямбда-выражением, чтобы упростить передачу счетной задаче локальных переменных. Возвращенная задача Task запускается немедленно, и мы можем дождаться ее завершения, как любой другой задачи:
C#
await Task.Run(() => MyLongComputation(a, b));
Это очень простой способ выполнить некоторую работу в фоновом потоке.
Если необходим более точный контроль над тем, какой поток производит вычисления или как он планируется, в классе Task имеется статическое свойство Factory типа TaskFactory. У него есть метод
StartNew с различными перегруженными вариантами для управления вычислением:
C#
Task t = Task.Factory.StartNew(() => MyLongComputation(a, b),
cancellationToken,
TaskCreationOptions.LongRunning,
taskScheduler);
WhenAll Ожидание завершения нескольких задач.
В разделе «Task и await» выше мы видели, как просто организовать выполнение несколько параллельных асинхронных задач, – нужно запустить их по очереди, а затем ждать завершения каждой. Потом мы узнаем, что необходимо дождаться завершения каждой задачи,
иначе можно пропустить исключения.
Для решения этой задачи можно воспользоваться методом Task.
WhenAll , который принимает несколько объектов Task и порождает агрегированную задачу, которая завершается, когда завершены все исходные задачи. Вот простейший вариант метода WhenAll (имеется также перегруженный вариант для коллекции универсальных объектов Task<T>):
Task WhenAll (IEnumerable<Task> tasks)
Основное различие между использованием WhenAll и самостоятельным ожиданием нескольких задач, заключается в том, что WhenAll корректно работает даже в случае исключений. Поэтому старайтесь всегда пользоваться методом WhenAll .
Универсальный вариант WhenAll возвращает массив, содержащий
результаты отдельных поданных на вход задач Task. Это сделано скорее для удобства, чем по необходимости, потому что доступ к исходным объектам Task сохраняется, и ничто не мешает опросить их свойство Result , так как точно известно, что все задачи уже завершены.
WhenAny Ожидание завершения любой задачи из нескольких.
Часто возникает также ситуация, когда требуется дождаться завершения первой задачи из нескольких запущенных. Например, так бывает, когда вы запрашиваете один и тот же ресурс из нескольких источников и готовы удовлетвориться первым полученным ответом.
Task<Task<T>>
WhenAny (IEnumerable<Task<T>> tasks)
В ситуации, когда возможны исключения, пользоваться методом WhenAny следует с осторожностью. Если вы хотите знать обо всех исключениях, произошедших в программе,
то необходимо ждать каждую задачу, иначе некоторые исключения могут быть потеряны. Воспользоваться методом WhenAny и просто забыть об остальных задачах – всё равно, что перехватить все исключения и игнорировать их.
Это достойное порицания решение, которое может впоследствии привести к тонким ошибкам и недопустимым состояниям программы.
Метод
WhenAny возвращает значение типа Task<Task<T>>. Это означает, что по завершении задачи вы получаете объект типа Task<T>.
Он представляет первую из завершившихся задач и поэтому гарантированно находится в состоянии «завершен». Но почему нам возвращают объект Task, а не просто значение типа T?
Чтобы мы знали, какая задача завершилась первой, и могли отменить все остальные и дождаться их завершения.
C#
Task<Task<Image>> anyTask = Task.WhenAny(tasks);
Task<Image> winner = await anyTask;
Image image = await winner; // Этот оператор всегда завершается синхронно
AddAFavicon(image);
foreach (Task<Image> eachTask in tasks)
{
if (eachTask != winner)
{
await eachTask;
}
}
Нет ничего предосудительного в том, чтобы обновить пользовательский интерфейс, как только будет получен результат первой завершившейся задачи (winner), но после этого необходимо дождаться остальных задач, как сделано в коде выше. При удачном стечении обстоятельств все они завершатся успешно, и на выполнении программы это никак не отразится. Если же какая-то задача завершится с ошибкой, то вы сможете узнать причину и исправить ошибку.
CancellationToken Отмена асинхронных операций.
Отмена асинхронных операций связывается с типом
CancellationToken
По соглашению всякий метод, поддерживающий отмену, должен иметь перегруженный вариант, в котором за обычными параметрами следует параметр типа
CancellationToken
C#
Task<int > ExecuteNonQueryAsync(CancellationToken cancellationToken)
При вызове метода ThrowIfCancellationRequested отмененного объекта
CancellationToken возбуждается исключение типа OperationCanceledException.
C#
foreach (var x in thingsToProcess)
{
cancellationToken.ThrowIfCancellationRequested(); // Обработать x ...
}
Библиотека Task Parallel Library знает, что такое исключение представляет отмену, а не ошибку, и обрабатывает его соответственно. Например, в классе Task имеется свойство
IsCanceled , которое автоматически принимает значение true, если при выполнении
async-метода произошло исключение OperationCanceledException.
Удобной особенностью подхода к отмене, основанного на маркерах
CancellationToken , является тот факт, что один и тот же маркер можно распространить на столько частей асинхронной операции, сколько необходимо, – достаточно просто передать его всем частям.
Неважно, работают они параллельно или последовательно, идет ли речь о медленном вычислении или удаленной операции, – один маркер отменяет всё.
До первого await
До первого await не происходит ничего интересного.
Async не планирует выполнение метода в фоновом потоке. Единственный способ сделать это – воспользоваться методом Task.Run , который специально предназначен для этой цели, или чем-то подобным.
В приложении с пользовательским интерфейсом это означает, что код до первого await работает в потоке пользовательского интерфейса.
А в веб-приложении на базе ASP.NET – в рабочем потоке ASP.NET.
Часто бывает, что выражение в строке, содержащей первый await, содержит еще один async-метод .
Поскольку это выражение предшествует первому await, оно также выполняется в вызывающем потоке.
Таким образом, вызывающий поток продолжает «углубляться» в код приложения, пока не встретит метод, действительно возвращающий объект Task .
Путь до первой реальной точки асинхронности может оказаться довольно длинным, и весь лежащий на этом пути код исполняется в потоке пользовательского интерфейса, а, стало быть, интерфейс не реагирует на действия пользователя.
К счастью, в большинстве случаев он выполняется недолго, но важно помнить, что одно лишь наличие ключевого слова async не гарантирует отзывчивости интерфейса.
Подробнее о классе SynchronizationContext
Текущий контекст SynchronizationContext – это свойство текущего потока. Идея в том, что всякий раз, как код исполняется в каком-то специальном потоке, мы можем получить текущий контекст синхронизации и сохранить его.
Впоследствии этот контекст можно использовать для того, чтобы продолжить исполнение кода в том потоке, в котором оно было начато.
Поэтому нам не нужно точно знать, в каком потоке началось исполнение, достаточно иметь соответствующий объект SynchronizationContext .
В классе SynchronizationContext есть важный метод Post , который гарантирует, что переданный делегат будет исполняться в правильном контексте.
await и SynchronizationContext
Мы знаем, что код, предшествующий первому await , исполняется в вызывающем потоке, но что происходит, когда исполнение вашего метода возобновляется после await ?
На самом деле, в большинстве случаев он также исполняется в вызывающем потоке, несмотря на то, что в промежутке вызывающий поток мог делать что-то еще.
Это существенно упрощает написание кода.
Для достижения такого эффекта используется класс SynchronizationContext .
Важно!!!
В момент приостановки метода при встрече оператора await текущий контекст SynchronizationContext сохраняется.
Далее, когда метод возобновляется, компилятор вставляет вызов Post , чтобы исполнение возобновилось в запомненном контексте.
Взаимодействие с синхронным кодом
В классе
Task имеется свойство
Result , обращение к которому блокирует вызывающий поток до завершения задачи.
Его можно использовать в тех же местах, что
await , но при этом не требуется, чтобы метод был помечен ключевым словом
async или возвращал объект
Task .
И в этом случае один поток занимается – на этот раз вызывающий (то есть тот, что блокируется).
C#
var result = MyMethodAsync().Result;
Исключения в async-методах, возвращающих Task
Большинство написанных вами async-методов возвращают значение типа
Task или
Task<T> . Цепочка таких методов, в которой каждый ожидает завершения следующего, представляет собой асинхронный аналог стека вызовов в синхронном коде.
Компилятор C# прилагает максимум усилий к тому, чтобы исключения, возбуждаемые в этих методах, вели себя так же, как в синхронном случае. В частности, блок
try-catch , окружающий ожидаемый async-метод, перехватывает исключения, возникшие внутри этого метода
C#
async Task Catcher()
{
try
{
await Thrower();
}
catch (AlexsException)
{
// Исключение будет обработано здесь
}
}
async Task Thrower()
{
await Task.Delay(100);
throw new AlexsException();
}
Для этого C# перехватывает все исключения, возникшие в вашем
async-методе . Перехваченное исключение помещается в объект
Task , который был возвращен вызывающей программе. Объект
Task переходит в состояние Faulted. Если задача завершилась с ошибкой, то ожидающий ее метод не возобновится как обычно, а получит исключение, возбужденное в коде внутри
await .
В
async-методе оно возбуждается там, где находится оператор
await , а не в точке фактического вызова метода. Это становится очевидным, если разделить вызов и
await .
C#
Task task = Thrower();
try
{
await task;
}
catch (AlexsException)
{
// Исключение обрабатывается здесь
}
Мне кажется это не совсем так, ведь сигнатура в интерфейсах не включает в себя async, и все равно работает как надо