使用Async和Await进行异步编程(C#版 适用于VS2015)

你可以使用异步编程来避免你的应用程序的性能瓶颈并且加强总体的响应。然而,用传统的技术来写异步应用是复杂的,同时编写,调试和维护都很困难。

VS2012介绍了简单的方法,那就是异步编程,它在.Net Framework 4.5和Windows 运行时提供了异步支持。编译器做了开发者以前做的困难的工作,而且你的应用保持了类似于异步代码的逻辑结构。结果,你轻易地就获得了所有异步编程的优势。

 

异步提升响应

异步对于可能阻塞的活动是至关重要的。例如当你的应用访问Web的时候,访问web资源有时有点慢或者延时,如果这样一个活动在同步进程中阻塞了,整个应用就必须等待。在异步进程中,此应用可以继续其他的工作,而不依赖于web资源直到这个可能阻塞的任务完成。

下表展示了异步编程提升响应的典型领域。陈列的来自Framework 4.5 和the Windows Runtime 的APIs包含了支持async编程的方法。

应用领域 包含异步方法的APIs
Web 访问 HttpClientSyndicationClient
处理文件 StorageFileStreamWriterStreamReaderXmlReader
处理图片 MediaCaptureBitmapEncoderBitmapDecoder
WCF编程 Synchronous and Asynchronous Operations

对于访问UI线程的应用,异步被证明是特别有价值的,因为所有Ui相关的活动通常共享一个线程。如果同步应用的任何一个进程被阻塞了,那么所有进程都被阻塞了。届时你的应用停止了响应,你可能推断它出错了,然而它却仅仅在等待。

当你使用异步方法的时候,应用会继续响应UI。你可以调整或者最小化窗口,或者如果你不想等待应用完成,那就关了它。

基于异步的方法相当于在设计异步操作时,向可供你选择的选项增加了自动的传输装置。那就是说,你以更少的付出却获得了所有传统异步编程的好处。

异步方法更容易编写

关键字async和await是异步编程的核心。通过使用这两个关键字,可以使用.NET Framework 或者Windows Runtime的资源来创建异步方法,这就像创建同步方法一样简单。使用await和async定义的方法为异步方法。

 

下面是一个异步方法的例子。代码中的所有你都应该看着很熟悉。

// 签名中需要注意的三件事:
//  -方法有一个async修饰符. 
//  - 返回值是 Task 或 Task<T>. 
//    这里返回一个Task<int>,因为return语句返回int类型
//  - 方法名以 "Async"结尾。
async Task<int> AccessTheWebAsync()
{ 
    // 先要添加 System.Net.Http引用来声明 client.
    HttpClient client = new HttpClient();

    // GetStringAsync 返回 Task<string>. 这意味着当你等待这个任务的时候,你将获得一个字符串(urlContents)。
    Task<string> getStringTask = client.GetStringAsync("http://msdn.microsoft.com");


    //这里你可以处理任务,它不依赖来自GetStringAsync的字符串
    DoIndependentWork();

    // await 操作符延缓了AccessTheWebAsync.
    //  - AccessTheWebAsync 直到 getStringTask完成才继续执行。
    //  - 同时, 控制返回到 AccessTheWebAsync的调用者.
    //  - 当getStringTask完成时,控制恢复. 
    //  - await 操作符然后检索来自 getStringTask的字符串.
    string urlContents = await getStringTask;

    //  return 语句表明返回一个整数.
    return urlContents.Length;
}

如果AccessTheWebAsync在调用GetStringAsync 和等待完成之间没有其他要处理的代码,可以用下面一条单句简化代码。

string urlContents = await client.GetStringAsync();

下面总结了一些上面的异步方法的例子的特点:

  • 方法签名包括async修饰符
  • 异步方法的命名,按照惯例,以“Async”后缀结尾
  • 返回类型只能是这三种:Task<TResult>,Task或void
  • 方法通常至少包括一个await表达式,await标记了一个点,这个点就是直到异步操作完成后异步方法才继续执行。同时,方法是延迟的,控制返回到方法的调用者。

异步方法中发生什么?

理解异步编程最重要的事情是 控制流如何从一个方法移动到另一个方法。下图带你理解这个过程。

对应数字序号的解释如下:

 

  1. 事件句柄调用并等待AccessTheWebAsync 异步方法。
  2. AccessTheWebAsync 创建一个HttpClient实例,并调用GetStringAsync异步方法来下载website的内容,保存到字符串。
  3. GetStringAsync发生了一些事情,延迟了方法的进度。也许必须等待站点下载或者一些其他的阻塞活动。为避免阻塞资源,GetStringAsync转让控制权给它的调用者AccessTheWebAsync 。
  4. 因为getStringTask还没有被await,所以AccessTheWebAsync 可以不依赖GetStringAsync返回的最终结果继续工作。这项工作是一个同步方法DoIndependentWork。
  5. DoIndependentWork是一个处理一些事情的同步方法,并且返回给它的调用者。
  6. AccessTheWebAsync 已经完成了它能做的事情,但getStringTask还没有返回结果。AccessTheWebAsync 下一步想要计算并返回已经下载的字符串的长度,但是该方法直到有字符串时才能计算那个值。
    因此,AccessTheWebAsync 使用了一个await操作符来延迟它的进度,并且转让控制权给调用AccessTheWebAsync 的方法。AccessTheWebAsync 返回一个Task<int>给调用者。这个task代表一种产生一个整数结果的允诺,这个整数结果就是下载字符串的长度。
    【注意:如果GetStringAsync(并且从而getStringTask)在AccessTheWebAsync等待它之前完成,那么控制权保留在AccessTheWebAsync中。如果调用的异步过程(getStringTask)已经完成了,延迟和后来返回到AccessTheWebAsync的代价将会被浪费,因而AccessTheWebAsync没必要等待最终的结果了。】
    在调用者内部(这个例子中的事件句柄),处理模式继续执行。在等待异步返回的结果之前,调用者可能处理其他的工作而不依赖来自AccessTheWebAsync的结果,或者调用者可能会立即等待。事件句柄等待AccessTheWebAsync,AccessTheWebAsync等待GetStringAsync。
  7. GetStringAsync完成并产生了字符串结果。这个字符串结果可能没有按你期望的那样通过GetStringAsync的调用被返回。(记住步骤3中该方法已经返回了一个task。)相反,这个字符串被保存到代表这个方法完成的任务对象getStringTask中。Await操作符检索来自getStringTask的结果。赋值语句将检索的结果赋值给urlContent变量。
  8. 当AccessTheWebAsync获得字符串结果时,该方法可以计算这个字符串的长度。然后AccessTheWebAsync的工作也完成了,等待中的事件句柄可以恢复了。

API异步方法

你可能想知道在哪里找到支持异步的像GetStringAsync的方法。.NET Framework 4.5包含了许多对async和await有效的成员。你可以通过“Async”后缀和Task或Task<TResult>的返回类型来识别这些成员。比如,System.IO.Stream类中,在同步方法CopyTo, Read和 Write的旁边包含了很多像CopyToAsync, ReadAsync和WriteAsync的方法。

线程

async方法规定为非阻塞操作。当等待的task运行的时候,async方法的await表达式不会阻塞当前线程。相反,该表达式注册当前方法的剩余作为延续,并且返回控制权给async方法的调用者。

async和await关键字不会造成额外的线程被创建。async方法不会要求多线程是因为async方法没有运行在它自己的线程上。该方法运行在当前的同步上下文上,只有该方法激活的时候才会在该线程上使用时间。你可以使用Task.Run()来将CPU受限的工作移动到后台线程中,但是后台线程不会帮助处理仅仅等待结果变成可利用的。

异步和等待  

可以查看我的这篇博客Async and Await 异步和等待

返回类型和参数

请查看我的这篇博客Async and Await 异步和等待

命名惯例

按照惯例,给方法添加async修饰符,给方法名追加“Async”后缀。

复杂案例

下面的代码来自WPF应用的MainWindow.xaml.cs。

 

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;

// 添加 System.Net.Http的using指令和引用;
using System.Net.Http;

namespace AsyncFirstExample
{
    public partial class MainWindow : Window
    {
        // 给事件句柄添加 async标记,为的是可在方法体内使用 await .
        private async void StartButton_Click(object sender, RoutedEventArgs e)
        {
            // 分别调用和await.
            //Task<int> getLengthTask = AccessTheWebAsync();
            //// 可以在这里做一些独立的工作.
            //int contentLength = await getLengthTask;

            int contentLength = await AccessTheWebAsync();

            resultsTextBox.Text +=
                String.Format("\r\nLength of the downloaded string: {0}.\r\n", contentLength);
        }

        // 签名中需要注意的三件事:
        //  -方法有一个async修饰符. 
        //  - 返回值是 Task 或 Task<T>. 
        //    这里返回一个Task<int>,因为return语句返回int类型
        //  - 方法名以 "Async"结尾。
        async Task<int> AccessTheWebAsync()
        { 
            // 先要添加 System.Net.Http引用来声明 client.
            HttpClient client = new HttpClient();

            // GetStringAsync 返回 Task<string>. 这意味着当你等待这个任务的时候,你将获得一个字符串(urlContents)。
            Task<string> getStringTask = client.GetStringAsync("http://msdn.microsoft.com");


            //这里你可以处理任务,它不依赖来自GetStringAsync的字符串
            DoIndependentWork();

            // await 操作符延缓了AccessTheWebAsync.
            //  - AccessTheWebAsync 直到 getStringTask完成才继续执行。
            //  - 同时, 控制返回到 AccessTheWebAsync的调用者.
            //  - 当getStringTask完成时,控制恢复. 
            //  - await 操作符然后检索来自 getStringTask的字符串.
            string urlContents = await getStringTask;

            //  return 语句表明返回一个整数.
            return urlContents.Length;
        }

        void DoIndependentWork()
        {
            resultsTextBox.Text += "Working . . . . . . .\r\n";
        }
    }
}