没有ConfigureAwait(false)的await在另一个线程上继续

时间:2015-08-25 18:37:50

标签: c# .net winforms async-await

我有一个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),那么继续应该在原始线程上运行。在某些情况下这是不正确的吗?

我还注意到,如果我在await之前向集合添加一个控件,那么延续会在正确的线程上神奇地运行。

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. 我如何说服继续在UI线程上运行(理想情况下,我没有添加控件并将其删除)?
  3. 供参考,以下是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.
    }
    

2 个答案:

答案 0 :(得分:8)

  

我的理解是,如果省略ConfigureAwait(false),则继续应该在原始线程上运行。在某些情况下这是不正确的吗?

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

  

我还注意到,如果我在await之前向集合添加一个控件,那么延续会在正确的线程上神奇地运行。

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

由于转移到OnLoad是一个可行的解决方案,我建议您继续使用它。唯一的其他选项(在创建控件之前在UI线程上恢复)是在第一个await之前手动创建控件。

答案 1 :(得分:2)

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

我仍然很好奇为什么会这样,所以如果有人知道,请随意发布另一个答案。

编辑:

我发现了真正的问题:事实证明我在Form.ShowDialog()后呼叫ConfigureAwait(false)。因此,表单是在UI线程上构建的,但后来我在非UI线程上调用ShowDialog。我很惊讶这种情况起作用了。

我已删除了ConfigureAwait(false),因此现在在UI线程上调用了ShowDialog