没有 ConfigureAwait(false) 的等待在不同的线程上继续

Question

我有一个 WinForms 应用程序，并且我有一些代码需要在 UI 线程上运行。但是，await 之后的代码在不同的线程上运行。

protected override async void OnHandleCreated(EventArgs e)
{
    base.OnHandleCreated(e);

    // This runs on the UI thread.
    mainContainer.Controls.Clear();

    var result = await DoSomethingAsync();

    // This also needs to run on the UI thread, but it does not.
    // Instead it throws an exception:
    // "Cross-thread operation not valid: Control 'mainContainer' accessed from a thread other than the thread it was created on"
    mainContainer.Controls.Add(new Control());
}

我也尝试过显式添加ConfigureAwait(true)，但这并没有什么区别。我的理解是，如果我省略ConfigureAwait(false)，那么继续应该在原始线程上运行。在某些情况下这是不正确的吗？

我还注意到，如果我在等待之前将控件添加到集合中，那么延续会神奇地在正确的线程上运行。

protected override async void OnHandleCreated(EventArgs e)
{
    base.OnHandleCreated(e);

    // This runs on the UI thread.
    mainContainer.Controls.Add(new Control());
    mainContainer.Controls.Clear();

    var result = await DoSomethingAsync();

    // This also runs on the UI thread now. Why?
    mainContainer.Controls.Add(new Control());
}

我的问题是：

1. 为什么会这样？
2. 我如何说服 continuation 在 UI 线程上运行（最好不要像我那样添加和删除控件）？

作为参考，这里是DoSomethingAsync的重要部分。它使用 RestSharp 提交 HTTP 请求。

protected async Task DoSomethingAsync()
{
    IRestRequest request = CreateRestRequest();

    // Here I await the response from RestSharp.
    // Client is an IRestClient instance.
    // I have tried removing the ConfigureAwait(false) part, but it makes no difference.
    var response = await Client.ExecuteTaskAsync(request).ConfigureAwait(false);

    if (response.ResponseStatus == ResponseStatus.Error)
        throw new Exception(response.ErrorMessage ?? "The request did not complete successfully.");

    if (response.StatusCode >= HttpStatusCode.BadRequest)
        throw new Exception("Server responded with an error: " + response.StatusCode);

    // I also do some processing of the response here; omitted for brevity.
    // There are no more awaits.
}

Answer 1

OnHandleCreated 似乎发生了一些奇怪的事情。我的解决方案是改用OnLoad。我对这个解决方案非常满意，因为在我的情况下确实没有理由使用 OnHandleCreated。

我仍然很好奇为什么会发生这种情况，所以如果有人知道，请随时发布另一个答案。

编辑：

我发现了真正的问题：原来我在ConfigureAwait(false) 之后调用了Form.ShowDialog()。因此，表单是在 UI 线程上构建的，但后来我在非 UI 线程上调用 ShowDialog。我很惊讶这完全有效。

我已经删除了 ConfigureAwait(false)，所以现在 ShowDialog 在 UI 线程上被调用。

Answer 2

我的理解是，如果我省略 ConfigureAwait(false)，那么延续应该在原始线程上运行。在某些情况下这是不正确的吗？

实际发生的是await默认会捕获当前上下文，并使用这个上下文来恢复async方法。这个上下文是SynchronizationContext.Current，除非它是null，在这种情况下它是TaskScheduler.Current（通常是线程池上下文）。大多数时候，UI 线程都有一个 UI SynchronizationContext - 在 WinForms 的情况下，WinFormsSynchronizationContext 的一个实例。

我还注意到，如果我在等待之前将控件添加到集合中，那么延续会神奇地在正确的线程上运行。

没有线程自动以SynchronizationContext 开头。 WinForms SynchronizationContext 在创建第一个控件时按需安装。这就是为什么您在创建控件后看到它在 UI 线程上恢复的原因。

由于迁移到 OnLoad 是一个可行的解决方案，我建议您直接使用它。唯一的其他选择（在创建控件之前在 UI 线程上恢复）是在您的第一个 await 之前手动创建一个控件。