重新認識 async/await 語法糖

xboo發表於2019-07-19
AI

提起.Net中的 async/await，相信很多.neter 第一反應都會是非同步程式設計，其本質是語法糖，但繼續追查下去，既然是語法糖，那麼經過編譯之後，真正的程式碼是什麼樣的，如何執行的？帶著這些疑問，通過網上資料的查詢，可以瞭解到編譯之後，是通過實現 IAsyncStateMachine 的一個狀態機來實現的，部落格園裡大神Jeffcky 已經說得很清楚了，傳送門： https://www.cnblogs.com/CreateMyself/p/5983208.html

上述知識對我們理解 async/await 非常重要，但不是本文討論的側重點，觸發筆者寫這篇文章的初衷是：

1.只有Task可以被await嗎，await之後就一定是非同步執行嗎？

答案當然不是，google了一圈後發現，當一個類可以被await，必須滿足以下條件：

a.它必須包含 GetAwaiter() 方法（例項方法或者擴充套件方法） // 手動劃重點:擴充套件方法，聰明的你是不是立馬有些思想火花
b.GetAwaiter() 返回awatier例項，並且這個例項包含如下條件：

  • 必須實現 INotifyCompletion 或者 ICriticalNotifyCompletion 介面
  • 必須包含 IsCompleted 公共屬性
  • 必須包含 GetResult() 方法，返回void或者其他返回值

上述條件中INotifyCompletion 介面資訊如下：

    //
    // 摘要:
    //     Represents an operation that schedules continuations when it completes.
    public interface INotifyCompletion
    {
        //
        // 摘要:
        //     Schedules the continuation action that's invoked when the instance completes.
        //
        // 引數:
        //   continuation:
        //     The action to invoke when the operation completes.
        //
        // 異常:
        //   T:System.ArgumentNullException:
        //     The continuation argument is null (Nothing in Visual Basic).
        void OnCompleted(Action continuation);
    }

重點上述對於引數 continuation 的解釋：委託在操作完成之後呼叫。此處遺留一個問題：在誰的操作完成之後呼叫，是怎麼呼叫的？

先把上述問題放一邊，我們來自己寫一個可以被await的類，並且觀察前後執行的順序以及是否存線上程切換：

 public class Program {
        static async Task Main (string[] args) {
            Console.WriteLine ($"Begin awati,thread id is {Thread.CurrentThread.ManagedThreadId}");
            int result = await new CustomAwaitable ();
            Console.WriteLine ($"End await，result is {result},thread id is {Thread.CurrentThread.ManagedThreadId}");
            await Task.Delay (Timeout.Infinite);
        }
    }

    public class CustomAwaitable : INotifyCompletion {
        public void OnCompleted (Action continuation) {
            Console.WriteLine ($"Invoke continuation action on completed,thread id is {Thread.CurrentThread.ManagedThreadId}");
            continuation?.Invoke ();
        }

        public int GetResult () {
            Console.WriteLine ($"Get result,thread id is {Thread.CurrentThread.ManagedThreadId}");
            return 100;
        }

        public bool IsCompleted { get; set; }

        public CustomAwaitable GetAwaiter(){
            return this;
        }
    }

上述程式碼中，CustomAwaitable 例項滿足了可被await的所有條件，並且正常通過編譯，執行後發現結果如下：

PS D:\git\awaitable\src> dotnet run
Begin main,thread id is 1
Get awatier,thread id is 1
Begin Invoke continuation action on completed,thread id is 1
Get result,thread id is 1
End main，result is 100,thread id is 1
End Invoke

根據上述日誌，可以看出：

  1. 執行前後執行緒並未發生切換，所以當我們不假思索的回答 await/async 就是非同步程式設計時，至少是一個不太嚴謹的答案
  2. 最後執行日誌 "End Invoke" 表明：continuation action 這個委託，根據上述呼叫日誌順序可以大致理解為：編譯器將await之後的程式碼封裝為這個 action，在例項完成後呼叫OnCompleted方法執行了await 之後的程式碼（注：實際情況比較複雜，如果有多行await，會轉換為一個狀態機，具體參看文章開頭給出的連線）。

2.瞭解了上述知識之後，那麼我們常規所說的await Task非同步程式設計又是怎麼回事呢？

  1. 先來看Task部分原始碼(傳送門)：

重新認識 async/await 語法糖

上述紅框程式碼顯示，Task在GetAwaiter中建立了 TaskAwaiter物件，並將this傳遞。

  1. 再來看TaskAwaiter原始碼(傳送門)：
    重新認識 async/await 語法糖
    重新認識 async/await 語法糖

看到此處，有了前面的知識，我們會對await task有了更加深入的理解：
Task通過增加一個GetAwatier()函式，同時將自身傳遞給TaskAwaiter類來實現了await語法糖的支援，同時在執行時，呼叫GetResult()函式的本質是通過 Task.Wait等待非同步執行緒的執行完成，然後通過回撥進行後續的操作。

總結

本文主要對 async/await 語法糖進行分析驗證，同時通過對Task原始碼分析，更加深入的理解此語法糖本身的語法，相信通過通過此文，對大家從多個角度去理解非同步程式設計有幫助，我自己也在不停的學習。

本文程式碼示例地址：https://github.com/xBoo/awaitable

相關文章