C# async/await異步編程深入理解

異步函數簡介

一般指 async 修飾符聲明得、可包含await表達式得方法或匿名函數。

 

聲明方式

異步方法的聲明語法與其他方法完全一樣, 只是需要包含 async 關鍵字。async可以出現在返回值之前的任何位置, 如下示例:

 async public static void GetInfoAsync()
        {
           //...
        }

        public async static void GetInfoAsync()
        {
           //...
        }

        public static async void GetInfoAsync()
        {
            //...
        }

異步方法的返回類型

異步函數的返回類型只能為: void、Task、Task<TResult>。

Task<TResult>: 代表一個返回值T類型的操作。

Task: 代表一個無返回值的操作。

void: 為了和傳統的事件處理程序兼容而設計。

 

await(等待)

await等待的是什么? 可以是一個異步操作(Task)、亦或者是具備返回值的異步操作(Task<TResult>)的值, 如下:

        public async static void GetInfoAsync()
        {
            await GetData(); // 等待異步操作, 無返回值
            await GetData<int>(1); //等待異步操作, 返回值 int
        }

        static Task GetData()
        {
            //...
            return null;
        }

        static Task<T> GetData<T>(int a)
        {
            //...
            return null;
        }

注: await 最終操作的是一個值, 當然, 也可以是無值,  如上GetData() , 否則就是一個 Task<T>  如上:  GetData<T>()

await執行過程

TaskAwaiter 獲取執行結果

一般而言, await等待的一個異步操作, 無論是具備返回值還是否, 那么最終都會獲得該操作是否已完成、具備返回值得異步操作可以獲取他得返回結果。

所以這個時候, TaskAwaiter出現了, 無論是Task、還是Task<TResult>操作, 都具備GetAwaiter() 方法。

用於獲取改操作得狀態、返回結果, 及部分操作, 如下TaskAwaiter結構: 

    //
    // 摘要:
    //     提供等待異步任務完成的對象。
    public struct TaskAwaiter : ICriticalNotifyCompletion, INotifyCompletion
    {
        //
        // 摘要:
        //     獲取一個值，該值指示是否已完成的異步任務。
        //
        // 返回結果:
        //     true 如果任務已完成;否則為 false。
        //
        // 異常:
        //   T:System.NullReferenceException:
        //     System.Runtime.CompilerServices.TaskAwaiter 對象未正確初始化。
        public bool IsCompleted { get; }

        //
        // 摘要:
        //     結束異步任務完成之前的等待。
        //
        // 異常:
        //   T:System.NullReferenceException:
        //     System.Runtime.CompilerServices.TaskAwaiter 對象未正確初始化。
        //
        //   T:System.Threading.Tasks.TaskCanceledException:
        //     任務已取消。
        //
        //   T:System.Exception:
        //     在完成的任務 System.Threading.Tasks.TaskStatus.Faulted 狀態。
        [TargetedPatchingOptOut("Performance critical to inline across NGen image boundaries")]
        public void GetResult();
        //
        // 摘要:
        //     設置時應執行的操作 System.Runtime.CompilerServices.TaskAwaiter 對象停止等待異步任務完成。
        //
        // 參數:
        //   continuation:
        //     要在等待操作完成時執行的操作。
        //
        // 異常:
        //   T:System.ArgumentNullException:
        //     continuation 為 null。
        //
        //   T:System.NullReferenceException:
        //     System.Runtime.CompilerServices.TaskAwaiter 對象未正確初始化。
        [SecuritySafeCritical]
        public void OnCompleted(Action continuation);
        //
        // 摘要:
        //     計划程序與此等待異步任務的延續任務操作。
        //
        // 參數:
        //   continuation:
        //     要等待操作完成時調用的操作。
        //
        // 異常:
        //   T:System.ArgumentNullException:
        //     continuation 為 null。
        //
        //   T:System.InvalidOperationException:
        //     該等待程序未正確初始化。
        [SecurityCritical]
        public void UnsafeOnCompleted(Action continuation);
    }

 接下來, 演示如何通過等待去獲取異步操作的返回結果, 如下代碼所示:

        public async static void GetInfoAsync()
        {
            Task<bool> task = Task.Run<bool>(() =>
            {
                Thread.Sleep(10000); //模擬耗時
                return true;
            });
            
            //以下兩種方式
            bool taskResult1 = await task;  //內部自己執行了GetAwaiter() bool taskResult = task.GetAwaiter().GetResult();  //自己手動執行Awaiter(), 但是阻塞UI
　　　　　　　Console.WriteLine(taskResult);         }

  注: 對於一個await表達式, 編譯器生成的代碼會先調用GetAwaiter(), 然后通過awaiter得成員來等待結果, 所以以上兩種方式等效( 不考慮阻塞的情況下)

為了驗證以上猜測, 通過反編譯工具查看得到如下代碼:

編譯器最終生成兩個密封類, 一個類( <>c )我們展開分析:

<GetInfoAsync>b__1_0()  正是模擬耗時的一個操作委托生成的方法。 

        [CompilerGenerated]
        [Serializable]
        private sealed class <>c
        {
            public static readonly Program.<>c <>9 = new Program.<>c();
            public static Func<bool> <>9__1_0;
            internal bool <GetInfoAsync>b__1_0()
            {
                Thread.Sleep(10000);
                return true;
            }
        }

第二個類 <GetInfoAsync>d__1 分析:

該類分別實現了接口  IAsyncStateMachine 的MoveNext() 與 SetStateMachine() ,另外 注意,

還特別定義了一個 <>t__builder, 先記住他, 下面講會對他講到, 為什么編譯器生成的代碼會默認先調用GetAwaiter()

[CompilerGenerated]
        private sealed class <GetInfoAsync>d__1 : IAsyncStateMachine
        {
            public int <>1__state;
            public AsyncVoidMethodBuilder <>t__builder;
            private Task<bool> <task>5__1;
            private bool <result>5__2;
            private bool <>s__3;
            private TaskAwaiter<bool> <>u__1;
            void IAsyncStateMachine.MoveNext()
            {
                int num = this.<>1__state;
                try
                {
                    TaskAwaiter<bool> awaiter;
                    if (num != 0)
                    {
                        Func<bool> arg_2F_0;
                        if ((arg_2F_0 = Program.<>c.<>9__1_0) == null)
                        {
                            arg_2F_0 = (Program.<>c.<>9__1_0 = new Func<bool>(Program.<>c.<>9.<GetInfoAsync>b__1_0));
                        }
                        this.<task>5__1 = Task.Run<bool>(arg_2F_0);
                        awaiter = this.<task>5__1.GetAwaiter();
                        if (!awaiter.IsCompleted)
                        {
                            this.<>1__state = 0;
                            this.<>u__1 = awaiter;
                            Program.<GetInfoAsync>d__1 <GetInfoAsync>d__ = this;
                            this.<>t__builder.AwaitUnsafeOnCompleted<TaskAwaiter<bool>, Program.<GetInfoAsync>d__1>(ref awaiter, ref <GetInfoAsync>d__);
                            return;
                        }
                    }
                    else
                    {
                        awaiter = this.<>u__1;
                        this.<>u__1 = default(TaskAwaiter<bool>);
                        this.<>1__state = -1;
                    }
                    this.<>s__3 = awaiter.GetResult();
                    this.<result>5__2 = this.<>s__3;
                    Console.WriteLine(this.<result>5__2);
                }
                catch (Exception exception)
                {
                    this.<>1__state = -2;
                    this.<>t__builder.SetException(exception);
                    return;
                }
                this.<>1__state = -2;
                this.<>t__builder.SetResult();
            }
            [DebuggerHidden]
            void IAsyncStateMachine.SetStateMachine(IAsyncStateMachine stateMachine)
            {
            }
        }

 

接下來, 看GetInfoAsync()方法, 這個是自己編寫的, 但是實現的細節,最終轉換成了編譯器執行代碼:

        [AsyncStateMachine(typeof(Program.<GetInfoAsync>d__1)), DebuggerStepThrough]
        public static void GetInfoAsync()
        {
            Program.<GetInfoAsync>d__1 <GetInfoAsync>d__ = new Program.<GetInfoAsync>d__1();
            <GetInfoAsync>d__.<>t__builder = AsyncVoidMethodBuilder.Create();
            <GetInfoAsync>d__.<>1__state = -1;
            AsyncVoidMethodBuilder <>t__builder = <GetInfoAsync>d__.<>t__builder;
            <>t__builder.Start<Program.<GetInfoAsync>d__1>(ref <GetInfoAsync>d__); //注意到該代碼, 調用了Start(),也許這就是默認實現的地方
        }

通過查看Start泛型方法的實現, 最終找到了, 該泛型的條件限制於必須實現與 IAsyncStateMachine 接口, 所以通過查看, 該類最終調用了 MoveNext(), 而MoveNext中正

調用了GetAwaiter()。關於Start的實現如下所示:

[SecuritySafeCritical, DebuggerStepThrough, __DynamicallyInvokable]
public void Start<TStateMachine>(ref TStateMachine stateMachine) where TStateMachine : IAsyncStateMachine
{
    if (stateMachine == null)
    {
        throw new ArgumentNullException("stateMachine");
    }
    ExecutionContextSwitcher executionContextSwitcher = default(ExecutionContextSwitcher);
    RuntimeHelpers.PrepareConstrainedRegions();
    try
    {
        ExecutionContext.EstablishCopyOnWriteScope(ref executionContextSwitcher);
        stateMachine.MoveNext();
    }
    finally
    {
        executionContextSwitcher.Undo();
    }
}

剖析MoveNext

 對比IDE中的代碼, 如下所示:

 

總結

await等待的是任務的操作值, 最終返回是異步操作的返回結果。而這一切都是因為編譯器創建了一系列復雜的狀態機制, 以達到其實現。