c# - 从非异步代码调用异步方法

Question

我正在更新一个库，该库具有在 .NET 3.5 中构建的 API 图面。因此，所有方法都是同步的。我无法更改 API(即，将返回值转换为任务)，因为这需要所有调用方都进行更改。所以我只剩下如何以同步方式最好地调用异步方法。这是在 ASP.NET 4、ASP.NET Core 和 .NET/.NET Core 控制台应用程序的上下文中。

我可能还不够清楚 - 情况是我有不支持异步的现有代码，我想使用新的库，例如 System.Net.Http 和仅支持异步方法的 AWS SDK。所以我需要弥合差距，并能够拥有可以同步调用但随后可以在其他地方调用异步方法的代码。

我读了很多书，这个问题已经被问过很多次了。

Calling async method from non async method

Synchronously waiting for an async operation, and why does Wait() freeze the program here

Calling an async method from a synchronous method

How would I run an async Task<T> method synchronously?

Calling async method synchronously

How to call asynchronous method from synchronous method in C#?

问题是大多数答案都不一样!我见过的最常见的方法是使用 .Result，但这可能会导致死锁。我已经尝试了以下所有方法，它们都有效，但我不确定哪种方法是避免死锁的最佳方法，具有良好的性能，并且与运行时配合得很好(在尊重任务调度程序、任务创建选项等方面) ).有确定的答案吗？什么是最好的方法？

private static T taskSyncRunner<T>(Func<Task<T>> task)
    {
        T result;
        // approach 1
        result = Task.Run(async () => await task()).ConfigureAwait(false).GetAwaiter().GetResult();

        // approach 2
        result = Task.Run(task).ConfigureAwait(false).GetAwaiter().GetResult();

        // approach 3
        result = task().ConfigureAwait(false).GetAwaiter().GetResult();

        // approach 4
        result = Task.Run(task).Result;

        // approach 5
        result = Task.Run(task).GetAwaiter().GetResult();


        // approach 6
        var t = task();
        t.RunSynchronously();
        result = t.Result;

        // approach 7
        var t1 = task();
        Task.WaitAll(t1);
        result = t1.Result;

        // approach 8?

        return result;
    }

Answer 1

So I'm left with how to best call async methods in a synchronous way.

首先，这是一件可以做的事情。我之所以这么说，是因为在 Stack Overflow 上，不考虑具体案例，将其作为一种笼统的声明指出这是魔鬼的行为是很常见的。

正确性不需要一直异步。阻塞一些异步的东西以使其同步会产生性能成本，这可能很重要，也可能完全无关紧要。视具体情况而定。

死锁来自两个线程试图同时进入同一个单线程同步上下文。任何避免这种情况的技术都能可靠地避免阻塞引起的死锁。

在您的代码片段中，所有对 .ConfigureAwait(false) 的调用都是毫无意义的，因为没有等待返回值。 ConfigureAwait 返回一个结构，该结构在等待时表现出您请求的行为。如果简单地删除该结构，它什么都不做。

RunSynchronously 使用无效，因为并非所有任务都能以这种方式处理。此方法适用于基于 CPU 的任务，在某些情况下可能无法工作。

.GetAwaiter().GetResult() 与 Result/Wait() 的不同之处在于它模仿了 await 异常传播行为。你需要决定你是否想要那个。 (因此研究该行为是什么；无需在此重复。)如果您的任务包含单个异常，那么 await 错误行为通常很方便并且几乎没有缺点。如果有多个异常，例如来自失败的 Parallel 循环，其中多个任务失败，则 await 将丢弃除第一个异常之外的所有异常。这使调试变得更加困难。

所有这些方法都具有相似的性能。他们将以一种或另一种方式分配操作系统事件并阻止它。那是昂贵的部分。与此相比，其他机器相当便宜。我不知道哪种方法绝对最便宜。

如果抛出异常，那将是最昂贵的部分。在 .NET 5 上，在快速 CPU 上以每秒最多 200,000 个的速度处理异常。深度堆栈速度较慢，并且任务机制倾向于重新抛出异常，使其成本成倍增加。有一些方法可以在不重新抛出异常的情况下阻止任务，例如 task.ContinueWith(_ => { }, TaskContinuationOptions.ExecuteSynchronously).Wait();。

我个人喜欢 Task.Run(() => DoSomethingAsync()).Wait(); 模式，因为它明确地避免了死锁，它很简单并且没有隐藏一些异常 GetResult() 可能会隐藏。但是您也可以使用 GetResult()。