如何在异步方法中实现 InvokeRequired UI 模式？

Question

假设我有一个尝试处理多线程环境的Form；因此，它会在完成任何 UI 修改之前检查它是否在 UI 线程上运行：

partial class SomeForm : Form
{
    public void DoSomethingToUserInterface()
    {
        if (InvokeRequired)
        {
            BeginInvoke(delegate { DoSomethingToUserInterface() });
        }
        else
        {
            … // do the actual work (e.g. manipulate the form or its elements)
        }
    }
}

现在假设我在该方法的… 部分执行了一些冗长的操作；因此，我想使用 async/await 使其异步。

鉴于我应该更改方法签名以返回Task 而不是void（以便可以捕获异常），我将如何实现执行BeginInvoke 的部分？它应该返回什么？

public async Task DoSomethingToUserInterfaceAsync()
{
    if (InvokeRequired)
    {
        // what do I put here?
    }
    {
        … // like before (but can now use `await` expressions)
    }
}

Answer 1

当使用async-await 和自定义awaiter（例如常见的TaskAwaiter）时，SynchronizationContext 会为您隐式捕获。稍后，当异步方法完成时，将使用 SynchronizationContext.Post 将延续（await 之后的任何代码）封送回相同的同步上下文。

这完全消除了使用InvokeRequired 和其他用于在 UI 线程上执行工作的技术的需要。为了做到这一点，您必须将您的方法调用一直跟踪到顶级方法调用，并将它们重构为可能使用async-await。

但是，要按原样解决具体问题，您可以做的是在 Form 初始化时捕获 WinFormSynchronizationContext：

partial class SomeForm : Form
{
    private TaskScheduler _uiTaskScheduler;
    public SomeForm()
    {
        _uiTaskScheduler = TaskScheduler.FromCurrentSynchronizationContext();
    }
}

以后想用的时候用await:

if (InvokeRequired)
{
    Task uiTask = new Task(() => DoSomethingToUserInterface());
    uiTask.RunSynchronously(_uiTaskScheduler);
}
else
{
    // Do async work
}

Answer 2

您可以使用TaskScheduler.FromCurrentSynchronizationContext 获取当前同步上下文的任务调度程序（用于 UI 线程），并将其存储在一个字段中以供以后使用。

然后，当您有兴趣在 UI 线程中启动任何任务时，您必须将 uiScheduler 传递给 StartNew 方法，以便 TPL 将在提供的调度程序中调度任务（本例中为 UI 线程） .

不管怎样，你决定在 UI 线程中运行这些东西，所以只需将它安排到 UIScheduler，你不需要检查InvokeRequired。

public async Task DoSomethingToUserInterfaceAsync()
{
    await Task.Factory.StartNew(() => DoSomethingToUserInterface(), CancellationToken.None, TaskCreationOptions.None, uiScheduler);
    ...
}

要检索 UI 调度器，可以使用以下代码

private TaskScheduler uiScheduler = TaskScheduler.FromCurrentSynchronizationContext();

注意： 非常重要的是，TaskScheduler.FromCurrentSynchronizationContext 只能从 UI 线程调用，否则会抛出异常，或者你会得到一个 TaskScheduler 用于其他一些 SynchronizationContext这不会满足您的需求。

另外请注意，如果您已从 UI 线程本身启动异步操作，则不需要上述任何魔法。 await 将在它开始的上下文中恢复。