Question

在C＃中使用async/await时，一般规则是避免async void，因为这几乎是一场火灾而忘记，如果没有从{0}发送返回值，则应使用Task方法。说得通。但奇怪的是，在本周早些时候，我正在为我编写的一些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);
        }
    }
}

运行上面的代码时，您会注意到“完成睡眠和完成等待”消息显示之前按任意键继续消息，这意味着异步方法以某种方式等待。

我的问题是，有人可以解释这里发生了什么吗？究竟是什么SynchronizationContext（我知道它用于将工作从一个线程发布到另一个线程）但我仍然对如何等待所有工作完成感到困惑。在此先感谢!!

Answer 1

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

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

此外，WaitForPendingOperationsToComplete() / async功能会调用await / OperationStarted()方法，以便在OperationCompleted()方法启动时通知SynchronizationContext或完成执行。

async void使用这些通知来计算正在运行且尚未完成的AsyncSynchronizationContext方法的数量。当此计数达到零时，async方法停止运行消息循环，控制流返回给调用者。

要在调试器中查看此过程，请在同步上下文的WaitForPendingOperationsToComplete()，Post和OperationStarted方法中设置断点。然后单步执行OperationCompleted调用：

调用AsyncMethod时，.NET首先调用AsyncMethod
- 这会将OperationStarted()设置为1。
然后_operationCount的主体开始运行（并启动后台任务）
在AsyncMethod语句中，await在任务尚未完成时产生控制权
AsyncMethod被称为
队列中没有可用的操作，因此主线程在currentContext.WaitForPendingOperationsToComplete();
在后台线程上：
- 在任何时候任务结束睡眠
- 输出：_operationsAvailable.WaitOne();
- 委托完成执行，任务标记为完成
- 调用Done sleeping!方法，将代表Post()
主线程因为队列不再为空而醒来
消息循环运行continuation，从而恢复执行AsyncMethod
输出：AsyncMethod
Done awaiting完成执行，导致.NET调用AsyncMethod
- OperationComplete()递减为0，这标志着消息循环完整
控制返回消息循环
消息循环结束，因为它已标记为完成，_operationCount返回给调用者
输出：WaitForPendingOperationsToComplete

nunit如何成功等待异步void方法完成？

1 个答案: