我应该让我的 REST 客户端 API 库异步（Java 8）

Question

我正在为我们的 REST 服务器创建客户端库。对于 C# 库，我使用 HttpClient.PostAsync() 效果很好，它返回一个对象，调用者可以等待（使其同步），他们可以完成一些其他操作然后等待，或者他们可以使用 C# 等待机制。很好的解决方案。

对于 Java，我必须为 Java 8 编写库，因为这是使用最多的版本。使用 Java 8，我们覆盖了 98% 的程序员。 （如果我们有足够的需求，我也会做一个 Java 11 的，然后我们有本地异步调用。）

所以这是我的问题，There are ways to get async behavior，使用 DeferredResult 或一些 3rd 方类。但是我围绕这个构建我的 API 并强制它有什么好处吗？因为如果我创建一个同步 API，调用者仍然可以在他们自己的 DeferredResult 代码中调用它。这是相同的最终结果。

所以在我看来，提供一个简单直接的 API 的方法是提供一个同步的。而那些想要异步的人将其包装在他们喜欢使其异步的任何机制中。这里的一个重要优势是我不会强制使用他们不使用的机制或第 3 方库。

这种方法有什么缺点吗？

更新：这里更详细。

如果我只有一个同步 API，那么调用者可以包装我的同步 API in many different ways。最简单的使用 vanilla Java 8 是：

// API is: public Metrics postMetrics(Template template)    
CompletableFuture<Metrics> completableFuture = CompletableFuture.supplyAsync(() -> { return client.postMetrics(template); });

如果我创建一个异步 API，那么我将选择这些方法中的哪一种（我将使用 CompletableFuture），因此 API 变为：

// API is: public CompletableFuture<Metrics> postMetrics(Template template)
CompletableFuture<Metrics> completableFuture = client.postMetricsAsync(template);

当然，使用异步 API 会更容易一些。但差别很小。不利的一面是我现在对它们强制使用异步方法。我是否错过了提供异步 API 的更大优势？

Answer 1

最终结果不一样。

同步 I/O 会为阻塞线程消耗大量内存。这是同步方法的主要缺点。将同步 I/O 设为主要，您的异步 I/O 仍然需要同步 I/O，因此会消耗大量资源。

合理的方法是使异步接口成为主要的，并用同步方法对其进行扩充。然后，用户可以选择是否有能力为阻塞线程花费内存或使用最少的资源使用多个 I/O 操作。

Answer 2

也许你应该从这些方面考虑，如果明天有另一个竞争库提供开箱即用的异步行为和同步呢？

如果我是一名开发人员，我可能会选择一个允许我开箱即用的异步行为并提供配置选项的选项。

我所说的只有在您考虑易于开发人员采用和内置易于进行异步 API 调用时才有意义。

我希望这会有所帮助。