简而言之：.NET中的Async / Await最佳实践

异步/等待-简介

状态机（IAsyncStateMachine）

using System.Diagnostics;

namespace AsyncAwait
{
    public class AsyncAwait
    {

        public async Task AsyncAwaitExample()
        {
            int myVariable = 0;

            await DummyAsyncMethod();
            Debug.WriteLine("Continuation - After First Await");
            myVariable = 1;

            await DummyAsyncMethod();
            Debug.WriteLine("Continuation - After Second Await");
            myVariable = 2;

        }

        public async Task DummyAsyncMethod()
        {
            // 
        }

    }
}

何时使用异步/等待

• 与I / O相关的工作：您的代码将期望某些东西，例如来自数据库的数据，读取文件，调用Web服务。在这种情况下，您应该使用异步/等待，而不是任务并行库。
• 与CPU相关的工作：您的代码将执行复杂的计算。在这种情况下，您应该使用Async / Await，但是您需要使用Task.Run在另一个线程中开始工作。您也可以考虑使用Task Parallel Library。

一路异步

如果该方法声明为异步，请确保有一个等待！

避免异步无效

public async void AsyncVoidMethod()
{
    //!
}

public async Task AsyncTaskMethod()
{
    //!
}

• 异步void方法中引发的异常无法在此方法之外捕获：

public async void AsyncVoidMethodThrowsException()
{
    throw new Exception("Hmmm, something went wrong!");
}

public void ThisWillNotCatchTheException()
{
    try
    {
        AsyncVoidMethodThrowsException();
    }
    catch(Exception ex)
    {
        //     
        Debug.WriteLine(ex.Message);
    }
}

public async Task AsyncTaskMethodThrowsException()
{
    throw new Exception("Hmmm, something went wrong!");
}

public async Task ThisWillCatchTheException()
{
    try
    {
        await AsyncTaskMethodThrowsException();
    }
    catch (Exception ex)
    {
        //    
        Debug.WriteLine(ex.Message);
    }
}

• 如果调用方不希望异步方法无效，则异步void方法可能会导致不良的副作用：如果您的异步方法未返回任何内容，请使用异步Task（对于Task，不带“ <T >”）作为返回类型。
• 异步void方法非常难以测试：由于错误处理和布局上的差异，编写调用异步void方法的单元测试很困难。异步MSTest测试仅适用于返回Task或Task <T的异步方法>。

优先选择return Task而不是return等待

public async Task<string> AsyncTask()

{
   //  !
   //...  -  
   //await -   ,  await  

   return await GetData();

}

public Task<string> JustTask()

{
   //!
   //...  -  
   // Task

   return GetData();

}

不要将return Task包装在try..catch {}内或使用{}块

public Task<string> ReturnTaskExceptionNotCaught()

{
   try
   {
       // ...

       return GetData();

   }
   catch (Exception ex)

   {
       //     

       Debug.WriteLine(ex.Message);
       throw;
   }

}

public Task<string> ReturnTaskUsingProblem()

{
   using (var resource = GetResource())
   {

       // ...  ,     , ,    

       return GetData(resource);
   }
}

避免使用.Wait()或.Result-改为使用GetAwaiter().GetResult()

public void GetAwaiterGetResultExample()

{
   // ,    ,     AggregateException  

   string data = GetData().Result;

   // ,   ,      

   data = GetData().GetAwaiter().GetResult();
}

如果该方法是异步的，请在其名称后添加Async后缀

异步库方法应使用Task.ConfigureAwait（false）来提高性能

public async Task ConfigureAwaitExample()

{
   //   ConfigureAwait(false)   .

   var data = await GetData().ConfigureAwait(false);
}

异步任务进度报告

取消异步任务

1. 调用方创建一个CancellationTokenSource对象。
2. 调用方调用已取消的异步API，并从CancellationTokenSource（CancellationTokenSource.Token）传递CancellationToken。
3. 调用方使用CancellationTokenSource（CancellationTokenSource.Cancel（））对象请求取消。
4. 该任务通常使用CancellationToken.ThrowIfCancellationRequested方法确认取消并自行取消。

进度和取消报告-示例

using System;
using System.Threading.Tasks;
using System.Windows.Forms;
using System.Threading;
namespace TestAsyncAwait
{
   public partial class AsyncProgressCancelExampleForm : Form
   {
       public AsyncProgressCancelExampleForm()
       {
           InitializeComponent();
       }

       CancellationTokenSource _cts = new CancellationTokenSource();

       private async void btnRunAsync_Click(object sender, EventArgs e)

       {

           //   .

            <int>   ,          ,   ,    , ETA  . .

           var progressIndicator = new Progress<int>(ReportProgress);

           try

           {
               //   ,         

               await AsyncMethod(progressIndicator, _cts.Token);

           }

           catch (OperationCanceledException ex)

           {
               // 

               lblProgress.Text = "Cancelled";
           }
       }

       private void btnCancel_Click(object sender, EventArgs e)

       {
          // 
           _cts.Cancel();

       }

       private void ReportProgress(int value)

       {
           //    

           lblProgress.Text = value.ToString();

       }

       private async Task AsyncMethod(IProgress<int> progress, CancellationToken ct)

       {

           for (int i = 0; i < 100; i++)

           {
              //   ,     

               await Task.Delay(1000);

               //   

               if (ct != null)

               {

                   ct.ThrowIfCancellationRequested();

               }

               //   

               if (progress != null)

               {

                   progress.Report(i);
               }
           }
       }
   }
}

等待一段时间

等待几个异步任务完成