async 與 await

using System;
using System.Net;

namespace Ex01_Sync
{
    class Program
    {
        static void Main(string[] args)
        {
            string content = MyDownloadPage("http://huan-lin.blogspot.com");

            Console.WriteLine("網頁內容總共為 {0} 個字元。", content.Length);
            Console.ReadKey();
        }

        static string MyDownloadPage(string url)
        {
            var webClient = new WebClient();  // 須引用 System.Net 命名空間。
            string content = webClient.DownloadString(url);
            return content;
        }
    }
}

static async Task<string> MyDownloadPageAsync(string url)
{
    var webClient = new WebClient(); 
    Task<string> task = webClient.DownloadStringTaskAsync(url);
    string content = await task;
    return content;
}

1. 在宣告方法時，前面加上關鍵字 async，表示這是一個非同步方法，裡面會用到 await 關鍵字。
2. 以 async 關鍵字宣告的方法若有回傳值，回傳的型別須以泛型 Task 表示。原先同步版本的方法是傳回 string，故此處改為 Task。非同步方法若不需要傳回值，則回傳型別應寫成 Task，而不要寫 void（原因後述）。
3. 一般而言，非同步方法的名稱會以「Async」結尾，所以方法名稱現在改為 MyDownloadPageAsync。

string content = webClient.DownloadString(url);

string content = await webClient.DownloadStringAsync(url);

Task<string> task = webClient.DownloadStringTaskAsync(url); // (1) 
string content = await task; // (2)

1. 原本呼叫 WebClient 類別的 DownloadString 方法，現在改呼叫它提供的非同步版本：DownloadStringTaskAsync。與其他非同步 I/O 方法類似，DownloadStringTaskAsync 方法的內部會起始一個非同步 I/O 工作，而且不等該工作完成便立即返回呼叫端；此時傳回的物件是個 Task，代表一個將傳回 string 的非同步 I/O 工作。 
2. 使用 await 關鍵字來等待非同步工作執行完畢，然後取得其執行結果。這裡的「等待」，是採取「非同步等待」的作法。意思是說，使用了關鍵字 await 的地方會暫且記住 await 敘述所在的程式碼位置，並且令程式控制流程立刻返回呼叫端；等到 await 所等待的那個非同步工作執行完畢，控制流才又會切回來繼續執行剛才保留而未執行的程式碼。 

static void Main(string[] args)
{
    Task<string> task = MyDownloadPageAsync("http://huan-lin.blogspot.com");

    string content = task.Result; // 取得非同步工作的結果。

    Console.WriteLine("網頁內容總共為 {0} 個字元。", content.Length);
    Console.ReadKey();
}

1. 在 Main 中呼叫 MyDownloadPageAsync 方法。
2. 在 MyDownloadPageAsync 方法中，呼叫 WebClient.DownloadStringTaskAsync 方法時，該方法會在內部起始一個非同步 I/O 工作來取得指定 URL 的網頁內容。
3. WebClient.DownloadStringTaskAsync 方法一旦起始了內部的非同步 I/O 工作，就會立刻返回呼叫端，並傳回一個代表那件非同步工作的 Task 物件。
4. 碰到 await 時，立刻返回呼叫端（Main 函式），並傳回一個 Task 物件。
5. 在 Main 函式中以原先的控制流繼續執行程式。此時碰到了 task.Result，欲取得非同步工作的結果。這是個阻斷式呼叫，必須等待目標工作完成才能繼續往下執行。
6. 在某個時間點，WebClient.DownloadStringTaskAsync 方法終於完成了它內部的非同步 I/O 工作，並且取得了結果，於是控制流切回來先前 (4) 所在之 await 敘述所保留的程式區塊並繼續執行。
7. 把 WebClient.DownloadStringTaskAsync 的結果指派給 content 變數，然後返回呼叫端。
8. 回到 Main 函式，把非同步工作的執行結果輸出至螢幕。

1 static async Task<string> MyDownloadPageAsync(string url)
2 {
3     var webClient = new WebClient();  
4     string content = await webClient.DownloadStringTaskAsync(url);
5     return content;
6 }

錯誤觀念：程式執行時，一旦進入以 async 關鍵字修飾的方法，就會執行在另一條工作執行緒上面。

錯誤觀念：await 會阻斷當前所在的程式碼，直到欲等待的工作完成時才會繼續執行。

• Task： 適用於非同步工作沒有傳回值的場合。
• Task<T> ：適用於非同步工作有傳回值的場合。回傳值的型別帶入泛型參數 T，例如 Task<String>。
• void：雖然能夠通過編譯，但此寫法應該只用於事件處理常式的場合，而不該用來宣告沒有回傳值的非同步工作。

using System;
using System.Net;
using System.Threading;
using System.Threading.Tasks;

namespace Ex02_Async
{
    class Program
    {
        leanpub-start-insert
        static void ShowThreadInfo(int num, string msg)
        {
            Console.WriteLine("({0}) T{1}: {2}", 
                              num, Thread.CurrentThread.ManagedThreadId, msg);
        }
        leanpub-end-insert

        static void Main(string[] args)
        {
            ShowThreadInfo(1, "正要起始非同步工作 MyDownloadPageAsync()。");

            Task<string> task = MyDownloadPageAsync("http://huan-lin.blogspot.com");

            ShowThreadInfo(3, "已經起始非同步工作 MyDownloadPageAsync()，但尚未取得工作結果。");

            string content = task.Result;

            ShowThreadInfo(5, "已經取得 MyDownloadPageAsync() 的結果。");

            Console.WriteLine("網頁內容總共為 {0} 個字元。", content.Length);
            Console.ReadKey();
        }

        static async Task<string> MyDownloadPageAsync(string url)
        {
            ShowThreadInfo(2, "正要呼叫 WebClient.DownloadStringTaskAsync()。");

            var webClient = new WebClient();  
            Task<string> task = webClient.DownloadStringTaskAsync(url);
            string content = await task;

            ShowThreadInfo(4, "已經取得 WebClient.DownloadStringTaskAsync() 的結果。");

            return content;
        }
    }
}

• 步驟 (1) 至 (3) 的程式碼都是在同一條執行緒 T1 上面執行，也就是主執行緒。
• 在 MyDownloadPage() 方法中，步驟 (2) 之後，碰到帶有 await 關鍵字的這行程式碼，就如稍早提過的，可以解讀為程式執行流程由此處切開，先返回呼叫端，等到目前等待的非同步工作（即 DownloadStringTaskAsync 完成後，才切回來接著執行 await 之後的程式碼。因此，在步驟 (2) 之後是回到 Main 函式中輸出步驟 (3) 的文字訊息。
• DownloadStringTaskAsync 正忙著以非同步 I/O 擷取遠端網頁內容的時候，此時程式流程已經回到 Main，並接著執行原先 Main 函式區塊的下一行程式碼，也就是 string content = task.Result;。於是在此處等待非同步工作完成，然後才能繼續往下執行。
• 過了一段時間，先前以非同步呼叫的 DownloadStringTaskAsync 已經完成任務，並返回執行結果。此時程式流程會切回來 MyDownloadPageAsync 方法中的 await 敘述的下一行程式碼，並繼續執行剩下的程式碼。於是此時輸出步驟 (4) 的文字訊息，然後傳回執行結果給呼叫端。注意步驟 (4) 輸出的訊息顯示當時的程式碼是執行在執行緒 T7 上，而不是原先的 T1。這是因為 DownloadStringTaskAsync 內部發起的非同步工作完成時，會從執行緒集區裡面取一條執行緒（即 T7）出來負責執行這個「完成」（completion）的動作，然後繼續執行先前因 await 而暫時保留、尚未執行的程式碼，所以在 await 底下的程式碼都是由 T7 這條執行緒來執行。
• Main 函式取得非同步工作的執行結果，接著輸出步驟 (5) 的訊息，程式結束。