[译]Async/Await - Best Practices in Asynchronous Programming

原文

避免async void

async void异步方法只有一个目的：使得event handler异步可行，也就是说async void只能用于event handler。

async void方法有不同的错误处理机制。当async Task或者async Task<T>方法里面抛出异常时，异常会被捕捉到，并放在Task对象里面。在async void方法里面没有Task对象，因此发生在async void方法里面的异常会直接raised到SynchronizationContext 中。发生在async void方法里面的异常不会被正常捕捉到。

private async void ThrowExceptionAsync()
{
  throw new InvalidOperationException();
}

public void AsyncVoidExceptions_CannotBeCaughtByCatch()
{
  try
  {
    ThrowExceptionAsync();
  }
  catch (Exception)
  {
    // 不会捕捉到这个异常
    throw;
  }
}

返回Task或者Task<T>的异步方法，可以使用await, Task.WhenAny, Task.WhenAll观察到异步方法是什么时候结束的。async void方法不容易观察到什么时候完成的。async void方法完成后会通知到他们的SynchronizationContext，但是太麻烦了。

Async void方法不利于测试。

死锁

public static class DeadlockDemo
{
  private static async Task DelayAsync()
  {
    await Task.Delay(1000);
  }

  // 在GUI和ASP.NET下这个方法会导致死锁
  public static void Test()
  {
    // Start the delay.
    var delayTask = DelayAsync();
    // Wait for the delay to complete.
    delayTask.Wait();
  }
}

死锁的根本原因是await的处理上下文的方式。默认情况下，当一个未完成的Task处于等待时，会捕捉到当前的上下文用于当Task完成时回到该方法。这个上下文就是SynchronizationContext。GUI 和ASP.NET 应用的SynchronizationContext一次只允许一段代码运行。当await完成，它企图在捕捉到的上下文中执行async方法剩下来的代码。但是这个上下文已经有一个线程在跑了，这个线程就是等待这个async方法运行完的方法（在这里就是Test这个同步方法）。这两个方法相互等待对方完成，因此发生了死锁。

控制台应用不会发生死锁。因为它有一个线程池的SynchronizationContext而不是GUI 和ASP.NET 应用一次只允许一段代码运行的SynchronizationContext。

解决这个死锁的最好的方案是让Test这个方法也是异步的。控制台方法不能用这个方案，因为Main方法不能是异步的。如果Main方法是异步的，它会在调用的异步方法前返回。

控制台的Main方法是少有的可以调用异步方法的非异步方法。

class Program
{
  static void Main()
  {
    MainAsync().Wait();
  }

  static async Task MainAsync()
  {
    try
    {
      // Asynchronous implementation.
      await Task.Delay(1000);
    }
    catch (Exception ex)
    {
      // Handle exceptions.
    }
  }
}

Configure Context

回到上面死锁的问题，当一个未完成的Task处于await的时候，默认会捕捉到上下文，捕捉到的这个上下文用于重回异步方法。context的行为会导致另外一个问题---性能问题。As asynchronous GUI applications grow larger, you might find many small parts of async methods all using the GUI thread as their context. This can cause sluggishness as responsiveness suffers from “thousands of paper cuts.”

减少这个导致的性能问题，可以通过ConfigureAwait来实现。

async Task MyMethodAsync()
{
  // 代码在最初的上下文中运行
  await Task.Delay(1000);

  // 代码在最初的上下文中运行
  await Task.Delay(1000).ConfigureAwait(continueOnCapturedContext: false);

  // 代码不在最初的上下文中运行了
  // 现在的上下文在线程池
}

除了性能外，ConfigureAwait的另外一个重要的作用是可以避免死锁。