编写设计良好的异步/非异步API

Question

我正面临着一个问题，即设计能够执行网络I/O的方法（用于可重用库）。我读过这个问题

API设计中C#5Await/Async模式

以及其他与我的问题更接近的问题。

所以，问题是，如果我想同时提供异步和非异步方法，我必须如何设计这些？

例如，要公开方法的非异步版本，我需要执行如下操作

public void DoSomething() {
  DoSomethingAsync(CancellationToken.None).Wait();
}

我觉得这不是个好设计。我想要一个关于如何定义私有方法的建议（例如），这些私有方法可以包装在公共方法中以提供两个版本。

Answer 1

如果您想要最易维护的选项，那么只提供一个asyncAPI，它在不进行任何阻塞调用或使用任何线程池线程的情况下实现。

如果您确实希望同时拥有async和同步API，那么您将遇到可维护性问题。您确实需要实现两次：一次async和一次synchronous。这两个方法看起来几乎完全相同，所以初始实现很容易，但是最终会得到两个几乎完全相同的方法，所以维护是有问题的。

特别是，没有一种好的简单的方法只制作async或同步“包装器”。Stephen Toub有关于这个主题的最佳信息：

1. 是否应该公开同步方法的异步包装？
2. 是否应该公开异步方法的同步包装？

（两个问题的简短答案都是“否”）