C# Async 当还需要支持同步调用时

Question

我的情况是，我们有一些通过用户输入（按钮单击）运行的代码，这些代码通过一系列函数调用运行并导致生成一些数据（这是一个非常繁重的操作，需要几分钟） .我们想为此使用异步，这样它就不会在我们执行此操作时锁定 UI。

但同时我们也有一个要求，即这些函数也可以通过一个最好是同步的 API 来使用。

可视化/示例（伪代码）：

public async void Button_Click() // from UI context
{
  await instanceOfClassA.FuncA();

  // some code
}

public async Task ClassA.FuncA()
{
  await instanceOfClassB.FuncB()

  // some code
}

public async Task ClassB.FuncB()
{
  await instanceOfClassC.SomeHeavyFunc()

  // some code
}

public async Task ClassC.SomeHeavyFunc()
{
  // some heavy calculations
}


// Also need to provide a public synchronous API function
public void SomeClass.SynchronousAPIFunc()
{
  // need to call differentInstanceOfClassB.FuncB()
}

有没有办法让公共 API 函数在内部等待异步操作？

编辑： 在此post 中，用户 Rachel 提供了该问题的两个答案。两者似乎都很有趣，但我不确定哪一个会提供最少的风险/副作用。

编辑2： 请注意，我们使用的是 .NET v4.6.1。

提前致谢。

Answer 1

制作只调用异步版本的方法的“同步”版本的问题在于it can cause deadlocks，特别是如果调用此代码的人不知道这是正在发生的事情。

如果你真的想制作同步版本，那就跟随微软的脚步，编写不使用任何异步代码的全新方法。例如，File.ReadAllLines() 的实现不使用任何与File.ReadAllLinesAsync() 相同的代码。

如果您不想这样做，那么就不要提供方法的同步版本。让调用者决定如何处理它。如果他们想在上面同步阻塞，那么他们可以降低死锁的风险。

Answer 2

但同时我们也有一个要求，即这些函数也可以通过一个最好是同步的 API 来使用。

如果您需要同时公开同步和异步 API，我推荐boolean argument hack。这看起来像：

public Task<T> FuncBAsync() => FuncBAsync(sync: false);
public T FuncB() => FuncBAsync(sync: true).GetAwaiter().GetResult();
public async Task<T> FuncBAsync(bool sync)
{
  // Note: is `sync` is `true`, this method ***must*** return a completed task.
  ...
}

有没有办法让公共 API 函数在内部等待异步操作？

我不建议使用直接阻塞（例如，GetAwaiter().GetResult()），因为直接实现会lead to deadlocks。

编辑：在这个post 中，用户 Rachel 提供了两个问题的答案。

我强烈建议不要使用该解决方案。它使用带有自定义SynchronizationContext 的嵌套消息循环，但不执行COM 泵送。这可能会导致问题，尤其是从 UI 线程调用时。即使泵送不是问题，这种解决方案也可能导致意外的重入，这是无数、极其微妙且难以发现的错误的根源。

Answer 3

您可以使用.GetAwaiter().GetResult()

根据您的示例，它看起来像：

public void SomeClass.SynchronousAPIFunc()
{
  // need to call differentInstanceOfClassB.FuncB()
  ClassB.FuncB().GetAwaiter().GetResult();
}

另外，关于何时不使用上述内容的一个很好的参考可以在Dont Block on Async Code找到