C# async/await 链与 ConfigureAwait(false)

Question

根据包括this excellent one here在内的大量书籍和博客，很明显，当一个dll库公开辅助异步方法（即包装方法）时，通常认为在内部完成实际的I/O任务是一种最佳实践。像这样的线程池线程上的异步方法（为简洁起见，下面显示了伪代码，我以HttpClient 为例）

public Async Task<HttpResponseMessage> MyMethodAsync(..)
{
    ...
    var httpClient = new HttpClient(..);
    var response = await httpClient.PostAsJsonAsync(..).ConfigureAwait(false);
    ...
    return response;
}

这里的关键是ConfigureAwait(false) 的使用，这样IO 任务完成发生在线程池线程上，而不是在原始线程上下文上，从而潜在地防止死锁。

我的问题是从来电者的角度出发的。我对调用者和上述方法调用之间存在多层方法调用的场景特别感兴趣，如下例所示。

CallerA -> Method1Async -> Method2Async -> finally the above MyMethodAsync

仅在最终方法上使用ConfigureAwait(false) 是否足够，或者是否还应该确保Method1Async 和Method2Async 也在内部使用ConfigureAwait(false) 调用它们的异步方法？ 将它包含在所有这些中间方法中似乎很愚蠢，特别是如果Method1Async 和Method2Async 只是最终调用MyMethodAsync 的重载。 有什么想法，请赐教！

使用示例更新 因此，如果我有一个具有以下私有异步方法的库，

private async Task<string> MyPrivateMethodAsync(MyClass myClass)
{
    ...
    return await SomeObject.ReadAsStringAsync().ConfigureAwait(false);
}

我是否应该确保以下公共重载方法都包括 ConfigureAwait(false)，如下所示？

public async Task<string> MyMethodAsync(string from)
{
        return await MyPrivateMethodAsync(new (MyClass() { From = from, To = "someDefaultValue"}).ConfigureAwait(false);
}
public async Task<string> MyMethodAsync(string from, string to)
{
        return await MyPrivateMethodAsync(new (MyClass() { From = from, To = to }).ConfigureAwait(false);
}

Answer 1

绝对不是。 ConfigureAwait 顾名思义就是配置await。它只影响与之结合的await。

ConfigureAwait 实际上返回一个不同的等待类型，ConfiguredTaskAwaitable 而不是 Task 反过来又返回一个不同的等待类型 ConfiguredTaskAwaiter 而不是 TaskAwaiter

如果您想忽略所有awaits 的SynchronizationContext，您必须为每个ConfigureAwait(false) 使用。

如果你想限制ConfigureAwait(false)的使用，你可以在最顶部使用我的NoSynchronizationContextScope（见here）：

async Task CallerA()
{
    using (NoSynchronizationContextScope.Enter())
    {
        await Method1Async();
    }
}

Answer 2

当等待任务时，它会创建一个对应的TaskAwaiter 来跟踪同时捕获当前SynchronizationContext 的任务。任务完成后，等待者在捕获的上下文上运行等待（称为延续）之后的代码。

您可以通过调用 ConfigureAwait(false) 来防止这种情况发生，这会创建一种不同类型的 wiatable (ConfiguredTaskAwaitable) 及其相应的等待者 (ConfiguredTaskAwaitable.ConfiguredTaskAwaiter)，不会在捕获的上下文上运行延续。

关键是对于每个await，都会创建一个不同的等待者实例，它不是在方法或程序中的所有等待者之间共享的东西。所以最好为每个await 语句调用ConfigureAwait(false)。

你可以看到等待者的源代码here。