c# - 我应该在每个等待的操作上调用 ConfigureAwait(false)

Question

我读了这篇文章https://blog.stephencleary.com/2012/07/dont-block-on-async-code.html - 但是我看到了一个矛盾:

我知道 UI 线程死锁的问题，因为 UI 线程阻塞等待异步操作完成，但相同的异步操作同步到 UI 线程上下文 - 因此异步操作无法进入 UI 线程，因此 UI 线程不会停止等待。

文章告诉我们解决方法是不要在 UI 线程上阻塞，否则您需要使用 ConfigureAwait(false) everywhere:

You would have to use for every await in the transitive closure of all methods called by the blocking code, including all third- and second-party code.

然而作者在文章后面写道:

Preventing the Deadlock
There are two best practices (both covered in my intro post) that avoid this situation:

1. In your “library” async methods, use ConfigureAwait(false) wherever possible.
2. Don’t block on Tasks; use async all the way down.

我在这里看到一个矛盾 - 在“不要这样做”部分中，他写道必须在任何地方使用 ConfigureAwait(false) 将是阻塞 UI 线程的结果 - 但是在他的“最佳实践”列表中，他告诉我们要做到这一点:“尽可能使用 ConfigureAwait(false)”。 - 尽管我认为“只要有可能”就会排除第三方代码，但在没有第三方代码的情况下，无论是否阻塞 UI 线程，结果都是一样的。

至于我的具体问题，这是我当前在 WPF MVVM 项目中的代码:

MainWindowViewModel.cs

private async void ButtonClickEventHandler()
{
    WebServiceResponse response = await this.client.PushDinglebopThroughGrumbo();

    this.DisplayResponseInUI( response );
}

WebServiceClient.cs

public class PlumbusWebServiceClient {

    private static readonly HttpClient _client = new HttpClient();

    public async Task<WebServiceResponse> PushDinglebopThroughGrumbo()
    {
        try
        {
            using( HttpResponseMessage response = await _client.GetAsync( ... ) )
            {
                if( !response.IsSuccessStatusCode ) return WebServiceResponse.FromStatusCode( response.StatusCode );

                using( Stream versionsFileStream = await response.Content.ReadAsStreamAsync() )
                using( StreamReader rdr = new StreamReader( versionsFileStream ) )
                {
                    return await WebServiceResponse.FromResponse( rdr );
                }
            }
        }
        catch( HttpResponseException ex )
        {
            return WebServiceResponse.FromException( ex );
        }
    }
}

如果我对文档的理解正确，我应该将 ConfigureAwait(false) 添加到 every await 没有代码的方法中需要在 UI 线程上运行 - 这是我的 PushDinglebopThroughGrumbo 方法中的每个方法，还有 WebServiceResponse.FromResponse 中的所有代码(调用 await StreamReader.ReadLineAsync )。但是我调用的任何第三方代码也对 StreamReader 执行 await 操作呢？我无法访问他们的源代码，所以那是不可能的。

我也有点推迟必须在任何地方放置 ConfigureAwait(false) - 我认为 await 关键字的目的是消除显式任务库调用 - 不应该有一个不同的关键字用于 resume-context-free 等待吗？ (例如 awaitfree)。

那么我的代码应该是这样的吗？

MainWindowViewModel.cs

(unmodified, same as above)

WebServiceClient.cs

public class PlumbusWebServiceClient {

    private static readonly HttpClient _client = new HttpClient();

    public async Task<WebServiceResponse> PushDinglebopThroughGrumbo()
    {
        try
        {
            using( HttpResponseMessage response = await _client.GetAsync( ... ).ConfigureAwait(false) ) // <-- here
            {
                if( !response.IsSuccessStatusCode ) return WebServiceResponse.FromStatusCode( response.StatusCode );

                using( Stream versionsFileStream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false) )  // <-- and here
                using( StreamReader rdr = new StreamReader( versionsFileStream ) )
                {
                    return await WebServiceResponse.FromResponse( rdr ).ConfigureAwait(false);  // <-- and here again, and inside `FromResponse` too
                }
            }
        }
        catch( HttpResponseException ex )
        {
            return WebServiceResponse.FromException( ex );
        }
    }
}

...我原以为调用 ConfigureAwait(false) 只需要在 PlumbusWebServiceClient 方法中调用最顶层的 await - 即 GetAsync 调用。

如果我确实需要在任何地方应用它，我可以将它简化为一个扩展方法吗？

public static ConfiguredTaskAwaitable<T> CF<T>(this Task<T> task) {
    return task.ConfigureAwait(false);
}

using( HttpResponseMessage response = await _client.GetAsync( ... ).CF() )
{
    ...
}

...虽然这并不能减轻所有的繁琐。

更新:第二个例子

这是我编写的一些异步代码，可将我的应用程序设置导出到一个简单的文本文件 - 我忍不住认为这感觉不对，这真的是正确的方法吗？

class Settings
{
    public async Task Export(String fileName)
    {
        using( StreamWriter wtr = new StreamWriter( fileName, append: false ) )
        {
            await ExportSetting( wtr, nameof(this.DefaultStatus     ), this.DefaultStatus                         ).ConfigureAwait(false);
            await ExportSetting( wtr, nameof(this.ConnectionString  ), this.ConnectionString                      ).ConfigureAwait(false);
            await ExportSetting( wtr, nameof(this.TargetSystem      ), this.TargetSystem.ToString("G")            ).ConfigureAwait(false);
            await ExportSetting( wtr, nameof(this.ThemeBase         ), this.ThemeBase                             ).ConfigureAwait(false);
            await ExportSetting( wtr, nameof(this.ThemeAccent       ), this.ThemeAccent                           ).ConfigureAwait(false);
            await ExportSetting( wtr, nameof(this.ShowSettingsButton), this.ShowSettingsButton ? "true" : "false" ).ConfigureAwait(false);
            await ExportSetting( wtr, nameof(this.ShowActionsColumn ), this.ShowActionsColumn  ? "true" : "false" ).ConfigureAwait(false);
            await ExportSetting( wtr, nameof(this.LastNameFirst     ), this.LastNameFirst      ? "true" : "false" ).ConfigureAwait(false);
            await ExportSetting( wtr, nameof(this.TitleCaseCustomers), this.TitleCaseCustomers ? "true" : "false" ).ConfigureAwait(false);
            await ExportSetting( wtr, nameof(this.TitleCaseVehicles ), this.TitleCaseVehicles  ? "true" : "false" ).ConfigureAwait(false);
            await ExportSetting( wtr, nameof(this.CheckForUpdates   ), this.CheckForUpdates    ? "true" : "false" ).ConfigureAwait(false);
        }
    }

    private static async Task ExportSetting(TextWriter wtr, String name, String value)
    {
        String valueEnc = Uri.EscapeDataString( value ); // to encode line-breaks, etc.

        await wtr.WriteAsync( name ).ConfigureAwait(false);
        await wtr.WriteAsync( '=' ).ConfigureAwait(false);
        await wtr.WriteLineAsync( valueEnc ).ConfigureAwait(false);
    }
}

Answer 1

If I understand the document correctly, I should add ConfigureAwait(false) to every await that is not in a method that has code that needs to run on the UI thread

是的。 UI 应用程序中的默认行为是 await 之后的代码在 UI 线程上继续。当 UI 线程繁忙，但您的代码不需要访问 UI 时，等待 UI 线程可用是没有意义的。

(注意:这里有意遗漏了一些与此处无关的细节。)

But what about any third-party code I call which also performs await operations on the StreamReader?

只要通过其他方式避免死锁，这只会影响性能，不会影响正确性。第三方代码可能表现不佳的问题并不是一个新问题。

换句话说:遵循两种最佳实践。

I'm also a bit put-off by having to place ConfigureAwait(false) everywhere - I thought the point of the await keyword was to eliminate explicit task library calls - shouldn't there be a different keyword for resume-context-free awaiting then? (e.g. awaitfree).

ConfigureAwait 不是 TPL 方法。

await 是通用的，因此它可以用于任意类型，只要它们支持所需的方法。举一个随机的例子，您可以为 Task 添加一个扩展方法来返回一个类型，该类型允许 await 之后的代码在新的专用线程中继续。这不需要带有新关键字的新版本编译器。

但是，是的，这是一个很长的名字。

If I do need to apply it everywhere, could I simplify it to an extension method?

是的，那很好。

---

Here is some async code I wrote that exports my application's settings to a simple text file - I can't help but think it doesn't feel right, is this really the correct way to do this?

正如我在评论中所写的那样，我自己根本不会使用这种方法……但如果您确实愿意，您可以消除其中的大量代码重复。随着它的消失，它看起来不再那么糟糕了。

/* SettingsCollection omitted, but trivially implementable using
   Dictionary<string, string>, NameValueCollection,
   List<KeyValuePair<string, string>>, whatever. */

SettingsCollection GetAllSettings()
{
     return new SettingsCollection
     {
         { nameof(this.DefaultStatus     ), this.DefaultStatus                         },
         { nameof(this.ConnectionString  ), this.ConnectionString                      },
         { nameof(this.TargetSystem      ), this.TargetSystem.ToString("G")            },
         { nameof(this.ThemeBase         ), this.ThemeBase                             },
         { nameof(this.ThemeAccent       ), this.ThemeAccent                           },
         { nameof(this.ShowSettingsButton), this.ShowSettingsButton ? "true" : "false" },
         { nameof(this.ShowActionsColumn ), this.ShowActionsColumn  ? "true" : "false" },
         { nameof(this.LastNameFirst     ), this.LastNameFirst      ? "true" : "false" },
         { nameof(this.TitleCaseCustomers), this.TitleCaseCustomers ? "true" : "false" },
         { nameof(this.TitleCaseVehicles ), this.TitleCaseVehicles  ? "true" : "false" },
         { nameof(this.CheckForUpdates   ), this.CheckForUpdates    ? "true" : "false" }
     };
}

public async Task Export(String fileName)
{
    using( StreamWriter wtr = new StreamWriter( fileName, append: false ) )
        foreach (var setting in GetAllSettings())
            await ExportSetting( wtr, setting.Key, setting.Value ).ConfigureAwait(false);
}