C#异步编程由浅入深细说Awaiter

Posted 2022-03-02 白烟染黑墨

  上一篇末尾提到了Awaiter这个类型，上一篇说了，能await的对象，必须包含GetAwaiter()方法，不清楚的朋友可以看上篇文章。那么，Awaiter到底有什么特别之处呢？
  首先，从上篇文章我们知道，一个Awaiter必须实现INotifyCompletion接口，这个接口定义如下：

namespace System.Runtime.CompilerServices

    /// <summary>
    /// Represents an operation that will schedule continuations when the operation completes.
    /// </summary>
    public interface INotifyCompletion
    
        /// <summary>Schedules the continuation action to be invoked when the instance completes.</summary>
        /// <param name="continuation">The action to invoke when the operation completes.</param>
        /// <exception cref="System.ArgumentNullException">The <paramref name="continuation"/> argument is null (Nothing in Visual Basic).</exception>
        void OnCompleted(Action continuation);
    

  除此之外还必须包含IsCompleted属性和包含GetResult()方法。
  注意OnCompleted的参数是一个Action委托，并且不出意外的话，委托里面总会有一个地方调用一个MoveNext()方法，它推动状态机到达下一个状态，然后执行下一个状态需要执行的代码。
  那么，知道这个有什么用呢？第一，它是你充分了解async/await这套机制的基础，包括与之相关的同步上下文、执行上下文、死锁问题等，第二，它可以实现一些特殊的功能。
  从上一篇我们知道，OnCompleted中的contination的主要目的是推动状态机的执行，也就是推动异步方法中await后面部分的代码执行。从这里看出，continuation的执行是受我们控制的，因此我们可以直接执行它，或是等待某个条件成熟然后执行它，我们可以把它放到线程池执行，也可以单独起一个线程执行。譬如，我们可以让await后面部分的代码直接在线程池上执行。

public static async Task AwaiterTest()

    Console.WriteLine($"是否是线程池线程？Thread.CurrentThread.IsThreadPoolThread");
    await default (SkipToThreadPoolAwaiter);
    Console.WriteLine($"是否是线程池线程？Thread.CurrentThread.IsThreadPoolThread");


static void Main(string[] args)

    _ = AwaiterTest();
    Console.ReadLine();


public struct SkipToThreadPoolAwaiter : INotifyCompletion

    public bool IsCompleted => false;
    public void GetResult() 
    
        Console.WriteLine("调用GetResult以获取结果");
    
    public void OnCompleted(Action continuation)
    
        Console.WriteLine("调用OnCompleted，把Await后面部分要执行的代码传递过来（传递MoveNext，以推动状态机流转）");
        ThreadPool.QueueUserWorkItem(state =>
        
            Console.WriteLine("开始执行Await后面部分的代码");
            continuation();
            Console.WriteLine("后面部分的代码执行完毕");
        );
        Console.WriteLine("返回调用线程");
    

    public SkipToThreadPoolAwaiter GetAwaiter()
    
        Console.WriteLine("获得Awaiter");
        return this;
    

  这是一个控制台程序，输出结果如下。

是否是线程池线程？False
获得Awaiter
调用OnCompleted，把Await后面部分要执行的代码传递过来（传递MoveNext，以推动状态机流转）
返回调用线程
开始执行Await后面部分的代码
调用GetResult以获取结果
是否是线程池线程？True
后面部分的代码执行完毕

  特别注意一下，第五步说明可能有点疑惑，怎么第六步不是打印是否是线程池线程？原因是部分awaiter是有返回值的，在执行await后面部分的代码时，会首先调用GetResult()以获取结果。这对编译器改造异步方法来说是一个固定的模式（上篇文章没有体现这一步）。
  把Awaiter改成有返回值尝试。

public static async Task AwaiterTest()

    Console.WriteLine($"是否是线程池线程？Thread.CurrentThread.IsThreadPoolThread");
    var res = await default (SkipToThreadPoolAwaiter);
    Console.WriteLine($"结果是res");
    Console.WriteLine($"是否是线程池线程？Thread.CurrentThread.IsThreadPoolThread");


static void Main(string[] args)

    _ = AwaiterTest();
    Console.ReadLine();


public struct SkipToThreadPoolAwaiter : INotifyCompletion

    public bool IsCompleted => false;
    public int GetResult() 
    
        Console.WriteLine("调用GetResult以获取结果");
        return 1;
    
    public void OnCompleted(Action continuation)
    
        Console.WriteLine("调用OnCompleted，把Await后面部分要执行的代码传递过来（传递MoveNext，以推动状态机流转）");
        ThreadPool.QueueUserWorkItem(state =>
        
            Console.WriteLine("开始执行Await后面部分的代码");
            continuation();
            Console.WriteLine("后面部分的代码执行完毕");
        );
        Console.WriteLine("返回调用线程");
    

    public SkipToThreadPoolAwaiter GetAwaiter()
    
        Console.WriteLine("获得Awaiter");
        return this;
    

  输出如下

是否是线程池线程？False
获得Awaiter
调用OnCompleted，把Await后面部分要执行的代码传递过来（传递MoveNext，以推动状态机流转）
返回调用线程
开始执行Await后面部分的代码
调用GetResult以获取结果
结果是1
是否是线程池线程？True
后面部分的代码执行完毕

  对照前面的文章来看，相信你应该有所得，能解决你部分的疑惑。前面说到，我们可以控制continuation的执行，那如果当前线程有同步上下文（SychronizationContext），我们是不是可以放到同步上下文中执行？TaskAwaiter是会这么做的，如果你不想它使用同步上下文，你可以在Task实例上调用ConfigureAwait(false)，它表面后面部分的代码将不会使用同步上下文执行。
  另外说一下Task.Yield()这个Awaiter，他的行为是捕捉同步上下文，如果有，则会放到同步上下文中执行，如果没有，则会放到线程池中执行。在窗体程序中，有时候你打开一个模态对话框，会导致主窗体部分的动画没有反应，在模态对话框关闭之后，才会反应。原因是模态对话框阻塞了主窗体的消息循环，也就是阻塞了主线程，如果想让动画先完成，然后再打开模态对话框，则可以在打开模态对话框之前，Await Task.Yield()，这也对应了它的意思，让渡之意。
  后面文章还会说明同步上下文具体是什么、异步代码中使用同步代码会导致死锁的本质原因、如何实现类似Task的类，并且怎么与Async/await这套机制搭配使用等知识。
  觉得有收获的不妨点个赞，有支持才有动力写出更好的文章。（.Net深入学习交流群（617374043），欢迎加入！）

知其然，而后知其所以然。