35

在 C# 中使用async/await时,一般规则是避免async void,因为这几乎是一劳永逸,Task如果没有从方法发送返回值,则应该使用 a。说得通。奇怪的是,本周早些时候我正在为我编写的一些async方法编写一些单元测试,并注意到 NUnit 建议将async测试标记为要么void或返回Task。然后我试了一下,果然成功了。这看起来很奇怪,因为 nunit 框架如何能够运行该方法并等待所有异步操作完成?如果它返回Task,它可以只是等待任务,然后做它需要做的事情,但是如果它返回void,它怎么能把它拉下来呢?

所以我破解了源代码并找到了它。我可以在一个小样本中重现它,但我根本无法理解他们在做什么。我想我对 SynchronizationContext 及其工作原理知之甚少。这是代码:

class Program
{
    static void Main(string[] args)
    {
        RunVoidAsyncAndWait();

        Console.WriteLine("Press any key to continue. . .");
        Console.ReadKey(true);
    }

    private static void RunVoidAsyncAndWait()
    {
        var previousContext = SynchronizationContext.Current;
        var currentContext = new AsyncSynchronizationContext();
        SynchronizationContext.SetSynchronizationContext(currentContext);

        try
        {
            var myClass = new MyClass();
            var method = myClass.GetType().GetMethod("AsyncMethod");
            var result = method.Invoke(myClass, null);
            currentContext.WaitForPendingOperationsToComplete();
        }
        finally
        {
            SynchronizationContext.SetSynchronizationContext(previousContext);
        }
    }
}

public class MyClass
{
    public async void AsyncMethod()
    {
        var t = Task.Factory.StartNew(() =>
        {
            Thread.Sleep(1000);
            Console.WriteLine("Done sleeping!");
        });

        await t;
        Console.WriteLine("Done awaiting");
    }
}

public class AsyncSynchronizationContext : SynchronizationContext
{
    private int _operationCount;
    private readonly AsyncOperationQueue _operations = new AsyncOperationQueue();

    public override void Post(SendOrPostCallback d, object state)
    {
        _operations.Enqueue(new AsyncOperation(d, state));
    }

    public override void OperationStarted()
    {
        Interlocked.Increment(ref _operationCount);
        base.OperationStarted();
    }

    public override void OperationCompleted()
    {
        if (Interlocked.Decrement(ref _operationCount) == 0)
            _operations.MarkAsComplete();

        base.OperationCompleted();
    }

    public void WaitForPendingOperationsToComplete()
    {
        _operations.InvokeAll();
    }

    private class AsyncOperationQueue
    {
        private bool _run = true;
        private readonly Queue _operations = Queue.Synchronized(new Queue());
        private readonly AutoResetEvent _operationsAvailable = new AutoResetEvent(false);

        public void Enqueue(AsyncOperation asyncOperation)
        {
            _operations.Enqueue(asyncOperation);
            _operationsAvailable.Set();
        }

        public void MarkAsComplete()
        {
            _run = false;
            _operationsAvailable.Set();
        }

        public void InvokeAll()
        {
            while (_run)
            {
                InvokePendingOperations();
                _operationsAvailable.WaitOne();
            }

            InvokePendingOperations();
        }

        private void InvokePendingOperations()
        {
            while (_operations.Count > 0)
            {
                AsyncOperation operation = (AsyncOperation)_operations.Dequeue();
                operation.Invoke();
            }
        }
    }

    private class AsyncOperation
    {
        private readonly SendOrPostCallback _action;
        private readonly object _state;

        public AsyncOperation(SendOrPostCallback action, object state)
        {
            _action = action;
            _state = state;
        }

        public void Invoke()
        {
            _action(_state);
        }
    }
}

运行上述代码时,您会注意到 Done Sleeping 和 Done awaiting 消息显示Press any key to continue 消息之前,这意味着异步方法正在等待。

我的问题是,有人可以解释一下这里发生了什么吗?究竟是什么SynchronizationContext(我知道它用于将工作从一个线程发布到另一个线程)但我仍然对我们如何等待所有工作完成感到困惑。提前致谢!!

4

1 回答 1

35

ASynchronizationContext允许将工作发布到由另一个线程(或线程池)处理的队列——通常 UI 框架的消息循环用于此目的。async/await功能在您等待的任务完成后在内部使用当前同步上下文返回到正确的线程。

该类AsyncSynchronizationContext实现了自己的消息循环。发布到此上下文的工作将添加到队列中。当您的程序调用WaitForPendingOperationsToComplete();时,该方法通过从队列中获取工作并执行它来运行消息循环。如果在 上设置断点Console.WriteLine("Done awaiting");,您将看到它在WaitForPendingOperationsToComplete()方法内的主线程上运行。

此外,async/await功能调用OperationStarted()/OperationCompleted()方法来通知方法SynchronizationContext何时async void开始或完成执行。

使用这些通知来记录正在运行但尚未完成AsyncSynchronizationContext的方法的数量。async当此计数达到零时,该WaitForPendingOperationsToComplete()方法停止运行消息循环,并且控制流返回给调用者。

要在调试器中查看此过程,请在同步上下文的PostOperationStarted和方法中设置断点。OperationCompleted然后逐步AsyncMethod调用:

  • AsyncMethod被调用时,.NET 首先调用OperationStarted()
    • 这会将 设置_operationCount为 1。
  • 然后主体AsyncMethod开始运行(并启动后台任务)
  • await语句中,AsyncMethod由于任务尚未完成,让出控制权
  • currentContext.WaitForPendingOperationsToComplete();被调用
  • 队列中还没有可用的操作,所以主线程在_operationsAvailable.WaitOne();
  • 在后台线程上:
    • 在某个时候任务完成睡眠
    • 输出:Done sleeping!
    • 委托完成执行,任务被标记为完成
    • Post()方法被调用,将表示剩余部分的延续加入队列AsyncMethod
  • 主线程被唤醒,因为队列不再为空
  • 消息循环运行延续,从而恢复执行AsyncMethod
  • 输出:Done awaiting
  • AsyncMethod完成执行,导致 .NET 调用OperationComplete()
    • the_operationCount减为 0,这将消息循环标记为完成
  • 控制返回到消息循环
  • 消息循环结束,因为它被标记为完成,并WaitForPendingOperationsToComplete返回给调用者
  • 输出:Press any key to continue. . .
于 2013-02-22T19:56:48.123 回答