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()

 1 [CompilerGenerated]
 2         private sealed class <GetInfoAsync>d__1 : IAsyncStateMachine
 3         {
 4             public int <>1__state;
 5             public AsyncVoidMethodBuilder <>t__builder;
 6             private Task<bool> <task>5__1;
 7             private bool <result>5__2;
 8             private bool <>s__3;
 9             private TaskAwaiter<bool> <>u__1;
10             void IAsyncStateMachine.MoveNext()
11             {
12                 int num = this.<>1__state;
13                 try
14                 {
15                     TaskAwaiter<bool> awaiter;
16                     if (num != 0)
17                     {
18                         Func<bool> arg_2F_0;
19                         if ((arg_2F_0 = Program.<>c.<>9__1_0) == null)
20                         {
21                             arg_2F_0 = (Program.<>c.<>9__1_0 = new Func<bool>(Program.<>c.<>9.<GetInfoAsync>b__1_0));
22                         }
23                         this.<task>5__1 = Task.Run<bool>(arg_2F_0);
24                         awaiter = this.<task>5__1.GetAwaiter();
25                         if (!awaiter.IsCompleted)
26                         {
27                             this.<>1__state = 0;
28                             this.<>u__1 = awaiter;
29                             Program.<GetInfoAsync>d__1 <GetInfoAsync>d__ = this;
30                             this.<>t__builder.AwaitUnsafeOnCompleted<TaskAwaiter<bool>, Program.<GetInfoAsync>d__1>(ref awaiter, ref <GetInfoAsync>d__);
31                             return;
32                         }
33                     }
34                     else
35                     {
36                         awaiter = this.<>u__1;
37                         this.<>u__1 = default(TaskAwaiter<bool>);
38                         this.<>1__state = -1;
39                     }
40                     this.<>s__3 = awaiter.GetResult();
41                     this.<result>5__2 = this.<>s__3;
42                     Console.WriteLine(this.<result>5__2);
43                 }
44                 catch (Exception exception)
45                 {
46                     this.<>1__state = -2;
47                     this.<>t__builder.SetException(exception);
48                     return;
49                 }
50                 this.<>1__state = -2;
51                 this.<>t__builder.SetResult();
52             }
53             [DebuggerHidden]
54             void IAsyncStateMachine.SetStateMachine(IAsyncStateMachine stateMachine)
55             {
56             }
57         }

View Code

 

接下来, 看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等待的是任务的操做值, 最终返回是异步操做的返回结果。而这一切都是由于编译器建立了一系列复杂的状态机制, 以达到其实现。