C#當中使用async和await

 

最近在寫程序的時候，常常遇到大量須要異步訪問的狀況，可是對於async和await到底怎麼寫，還不是很是明確。因而參考《C#圖解教程》了異步編程一節。

1.普通的程序怎麼寫？

class Program
{
    static void Main(string[] args)
    {
        MyDownLoadString ds = new MyDownLoadString();
        ds.DoRun();
        Console.ReadKey();
    }

    class MyDownLoadString
    {
        Stopwatch sw = new Stopwatch();
        public void DoRun()
        {
            const int LargeNumber = 6000000;
            sw.Start();

            int t1 = CountCharacters(1, "http://www.microsoft.com");
            int t2 = CountCharacters(2, "http://www.illustratedcsharp.com");

            CountToALargeNumber(1, LargeNumber);
            CountToALargeNumber(2, LargeNumber);
            CountToALargeNumber(3, LargeNumber);
            CountToALargeNumber(4, LargeNumber);
          
            Console.WriteLine("Chars in Call1:{0}",t1);
            Console.WriteLine("Chars in Call1:{0}",t2);
        }

        private int CountCharacters(int id, string uriString)
        {
            WebClient wc1 = new WebClient();
            Console.WriteLine("Call {0} start: {1:N0}ms ", id, sw.Elapsed.TotalMilliseconds);
            string result = wc1.DownloadString(new Uri(uriString));
            Console.WriteLine("Call {0} completed: {1:N0}ms", id, sw.Elapsed.TotalMilliseconds);
            return result.Length;
        }

        private void CountToALargeNumber(int id, int value)
        {
            for (long i = 0; i < value; i++) ;
            Console.WriteLine("End CountToALargeNumber {0} : {1:N0}ms", id, sw.Elapsed.TotalMilliseconds);
        }
    }
}

結果：

Call 1 start: 1ms
Call 1 completed: 903ms
Call 2 start: 903ms
Call 2 completed: 1,355ms
End CountToALargeNumber 1 : 1,375ms
End CountToALargeNumber 2 : 1,399ms
End CountToALargeNumber 3 : 1,417ms
End CountToALargeNumber 4 : 1,435ms
Chars in Call1:161702
Chars in Call1:5164

從運行結果能夠看到，同步執行的時間主要花在了兩次請求外部地址上，計算長度並不費時，用圖來表示就像下面

　　

2.使用async和await怎麼寫？

修改上面代碼，以下

class MyDownLoadString
{
    Stopwatch sw = new Stopwatch();
    public void DoRun()
    {
        const int LargeNumber = 6000000;
        sw.Start();
         // Task<int> 保存結果對象，後面t1.Result則是獲取結果
         Task<int> t1 = CountCharactersAsync(1, "http://www.microsoft.com");
        Task<int> t2 = CountCharactersAsync(2, "http://www.illustratedcsharp.com");
      
        //無需等待CountCharactersAsync執行完成
        CountToALargeNumber(1, LargeNumber);
        CountToALargeNumber(2, LargeNumber);
        CountToALargeNumber(3, LargeNumber);
        CountToALargeNumber(4, LargeNumber);
        
        //t1.Result獲取結果
        Console.WriteLine("Chars in Call1:{0}",t1.Result);
        Console.WriteLine("Chars in Call1:{0}",t2.Result);
    }

    private async Task<int> CountCharactersAsync(int id, string uriString)
    {
        WebClient wc = new WebClient();
        Console.WriteLine("Call {0} start: {1:N0}ms ", id, sw.Elapsed.TotalMilliseconds);
        string result = await wc.DownloadStringTaskAsync(new Uri(uriString));
        Trace.TraceInformation("Taceing Async Call {0} @time:{1:N0}ms", id, sw.Elapsed.TotalMilliseconds);
        Console.WriteLine("Call {0} completed: {1:N0}ms", id, sw.Elapsed.TotalMilliseconds);
        return result.Length;
    }

    private void CountToALargeNumber(int id, int value)
    {
        for (long i = 0; i < value; i++) ;
        Console.WriteLine("End CountToALargeNumber {0}: {1:N0}ms", id, sw.Elapsed.TotalMilliseconds);
    }
}

運行結果：

Call 1 start: 2ms
Call 2 start: 253ms
End CountToALargeNumber 1: 288ms
End CountToALargeNumber 2: 359ms
End CountToALargeNumber 3: 560ms
Call 1 completed: 770ms
End CountToALargeNumber 4: 844ms
Call 2 completed: 887ms
Chars in Call1:162262
Chars in Call2:5164

修改如上面的代碼以後，咱們就能夠無需等待兩次CountCharactersAsync返回結果，而是直接調用了下面的CountToALargeNumber，在CountCharactersAsync請求返回的時候再獲取結果。

 

3.async和await的細節

 

async和await能夠建立和使用異步方法，這個特性的由三個部分組成：

①調用方法(calling method)：該方法調用異步方法，而後在異步方法（可能使用同一個線程也可能不在一個線程）執行其任務的時候繼續執行

②異步方法（async）: 該方法異步執行其工做，而後當即方法到調用方法

③await表達式：用於異步方法內部，指明須要異步執行的惹怒我。一個異步方法能夠包含任意多個await表達式，若是一個都不包含編譯器會發出警告

舉例說明一個async/await方法：

//1.調用方法
static void Main(string[] args)
{
    Task<int> t = DoSumAsync(1, 2);
    Console.WriteLine("結果:{0}", t.Result);
    Console.ReadKey();
}

//2.異步方法
public static async Task<int> DoSumAsync(int a, int b)
{
    //3.await 表達式
    int sum = await Task.Run(() => { return a + b; });
    return sum;
}

4.什麼是異步方法？

上面簡單舉例了什麼是異步方法，下面就詳細學習一下：

異步方法在完成其工做以前返回到調用方法，並在調用方法繼續執行的時候完成其工做。語法上有以下特徵：

① 方法使用async做爲修飾符

② 方法內部包含一個或者多個await表達式，表示能夠異步完成的任務

③ 必須具有如下三種返回類型 void 、Task 、Task<T> ,其中後兩種的返回對象標識講座將來完成的工做，調用方法和異步方法能夠繼續執行。

④異步方法的參數能夠任意類型，可是不能爲out和ref參數

⑤約定俗成，通常異步方法都是以 Async做爲後綴的。

⑥ 除了方法以外，Lambda表達式和匿名函數也能夠做爲異步對象。

像代碼：

private async Task<int> CountCharactersAsync(int id, string uriString)
{
    WebClient wc = new WebClient();
    Console.WriteLine("Call {0} start: {1:N0}ms ", id, sw.Elapsed.TotalMilliseconds);
    string result = await wc.DownloadStringTaskAsync(new Uri(uriString));
    Trace.TraceInformation("Taceing Async Call {0} @time:{1:N0}ms", id, sw.Elapsed.TotalMilliseconds);
    Console.WriteLine("Call {0} completed: {1:N0}ms", id, sw.Elapsed.TotalMilliseconds);
    return result.Length;
}

詳細說明：

①async關鍵字是一個上下文關鍵字，也就是說除了作爲方法（lambda和匿名函數）的修飾符以外，還能夠作標識符。

②返回類型

Task類型：若是調用方法不須要從異步方法中返回某個值，但須要檢查異步方法的狀態，能夠返回一個Task，此時就算異步方法中出現了return語句，也不會返回任何東西。

Task<T>類型，除了上面Task的功能，還能夠經過 Return屬性來獲取返回的T類型的值。

void類型：若是僅僅是執行異步方法，而不須要與它作任何進一步的交互（「調用並忘記」），此時能夠用void，和Task同樣，就算有return語句，也得不到任何東西。

 

5.異步方法的控制流

首先要明確「異步方法」的三個部分，以下圖所示：

①首先是第一個await以前的部分，這部分應該是少許且無需長時間等待的代碼。

②await表達式，表示須要被異步執行的任務，這裏有兩個await表達式，第二個await和以前的同步部分和第一個await以及以前的部分是同樣的。

③後續部分：在await表達式以後出現的方法中的其他代碼。

執行過程，能夠參考下面的圖

有幾個注意的地方：

① await以前的部分是同步執行的

② 當達到awati的時候，會將異步方法的控制返回給調用方法。若是方法返回的類型是Task或者Task<T>，將建立一個Task對象，表示需異步完成的任務和後續，而後將該Task返回到調用方法。 這裏的返回值並非await表達式的返回值，而是異步方法中聲明的返回值類型。

③ 異步方法內部須要完成如下工做：

　　- 異步執行await表達是的空閒任務

       - 當await表達式執行完成以後，執行後續部分。後續自己也多是await表達式，處理過程和上一個一致。

　　- 後續部分若是遇到 return 或者 方法達到末尾，將作以下的事情：

　　　　l  若是返回的類型是void,控制流就退出了

　　　　l  若是返回的類型是Task，後續部分設置Task對象的屬性並退出。

　　　　l  若是返回的類型是Task<T>，不只要設置Task對象屬性，還要設置Task對象的Return屬性。

  　　這個點要注意下：並非遇到return或者達到方法末尾，就能獲取到返回值，它只是退出了。

④ 調用方法繼續執行，會從異步方法獲取Task對象。當須要其實際值的時候，就引用Task對象中的Result屬性。屆時，若是異步方法設置了該屬性，調用方法獲取其值並繼續。不然就等待該屬性被設置，而後再繼續執行。

 

6. await表達式

 

await表達式指定了一個異步執行的任務。語法由 await關鍵字 + 一個空閒對象(稱爲任務)組成。這個任務多是一個Task對象，也能夠不是，默認狀況下由該線程異步執行。

一個空閒對象 指的是一個awaitable類型的實例，awaitable類型是指包含了GetAwaiter方法的類型，方法沒有參數，返回一個稱爲awaiter類型的對象。

 

 一個awaiter對象包含了以下成員：

 

通常狀況下咱們不須要本身構建一個awaiter對象，使用.net 本身的Task就能夠了。最簡單的方法就是使用Task.Run()來返回一個Task對象。關於Task.Run()有一個很是重要的點，他將在不一樣的線程上運行你的方法。

6.異常處理和await表達式

先看下面這個例子，直接在異步方法內部使用了try..catch。

static void Main(string[] args)
{

    Task t = BadAsync();
    t.Wait();
    Console.WriteLine("Task Status:       {0}", t.Status );
    Console.WriteLine("Task IsFaulted:    {0}", t.IsFaulted );
    Console.WriteLine("Please enter a key to exit!");
    Console.ReadKey();

}

static async Task BadAsync()
{
    try
    {
        await Task.Run(() => { throw new Exception(); });
    }
    catch
    {
        Console.WriteLine("Exception in BadAsync");
    }
}

執行結果：

Exception in BadAsync
Task Status:       RanToCompletion
Task IsFaulted:    False
Please enter a key to exit!

從結果能夠看到，雖然在異步方法內部進行了try..catch，而且也catch到了異常，可是對於調用函數，返回的Task狀態依然爲 RanToCompletion 。

爲何這個亞子？，緣由以下：

① Task沒有被取消掉

② 沒有未處理的異常。相似的IsFaulted是false。

 

7.在調用方法中同步的等待任務（WaitAll、WaitAny）

對於單個Task ，能夠經過task對象的wait()方法來進行等待。

Task<int> t = CountCharactersAsync("http://www.163.com");
t.Wait();

對於多個Task，可使用WaitAll()或者waitAny()方法，進行同步。

 WaitAll是等待因此的任務完成才繼續操做

Task<int> t1 = CountCharactersAsync(1, "http://www.163.com");
Task<int> t2 = CountCharactersAsync(2, "http://www.microsoft.com");
Task<int>[] tasks = new Task<int>[] { t1, t2 };
Task.WaitAll(tasks);

WaitAny是隻要一個完成就能夠繼續操做

Task<int> t1 = CountCharactersAsync(1, "http://www.163.com");
Task<int> t2 = CountCharactersAsync(2, "http://www.microsoft.com");
Task<int>[] tasks = new Task<int>[] { t1, t2 };
Task.WaitAny(tasks);

8.在異步方法中異步的等待任務 （WhenAll、.WhenAny）

上面說明了如何在「調用方法」中，同步等待Task的完成。 可是有時候，咱們在一個異步方法中也會存在多個任務，想要讓它們經過await表達式等待。咱們能夠經過Task.WhenAll() 和 Task.WhenAny() 方法實現。 這兩個方法稱爲組合子（combinator）。

private async Task<int> CountCharactersAsync(string site1, string site2)
{
    WebClient wc1 = new WebClient();
    WebClient wc2 = new WebClient();

    Task<string> t1 = wc1.DownloadStringTaskAsync(new Uri(site1));
    Task<string> t2 = wc2.DownloadStringTaskAsync(new Uri(site2));

    List<Task<string>> tasks = new List<Task<string>>();
    tasks.Add(t1);
    tasks.Add(t2);

    //組合子
    await Task.WhenAll(tasks);
    //await Task.WhenAny(tasks);

    Console.WriteLine("   CCA:  T1 {0} Finished", t1.IsCompleted ? "" : "Not");
    Console.WriteLine("   CCA:  T2 {0} Finished", t2.IsCompleted ? "" : "Not");

    return t1.IsCompleted? t1.Result.Length: t2.Result.Length;
}

9.使用Task.Delay 暫停線程處理

通常咱們都使用Thread.Sleep(xxxx) 進行線程的延時，可是 Thread.Sleep會阻塞線程。而Task.Delay則不會阻塞線程，線程能夠繼續處理其餘的工做。

class Simple
{
    Stopwatch sw = new Stopwatch();
    public void DoRun()
    {
        Console.WriteLine("Caller: Before call");
        ShowDelayAsync();
        Console.WriteLine("Caller: After call");

    }
    private async void ShowDelayAsync()
    {
        sw.Start();
        Console.WriteLine("   Before Delay:  {0} ", sw.Elapsed.Milliseconds );
        await Task.Delay(1000);
        Console.WriteLine("   After  Delay:  {0} ", sw.Elapsed.Milliseconds);
    }
}