如何在 HTTP 客户端库中返回 JSON？

Question

我想创建一个库来执行身份验证工作（在请求中发送一些身份验证参数）并从 API 返回 json 响应。 JSON 通常表示一个字典数组，如下所示：

[
  {"a": 1, "b": 2},
  {"a": 3, "b": 1}
]

我在Python 中做了同样的事情，这很简单，我只返回一个dict，它内置在Python 中。

我想知道Java 的最佳方式是什么？以下是我考虑的一些方法：

1. 返回将由用户处理的流。具体来说，我使用java.net.HttpURLConnection，通过这种方法我将返回connection.getInputStream()，这将由用户处理。这种方法的缺点是用户需要完成大部分工作（读取流并将其转换为类似 json 的对象或其他）。好的部分是用户可以灵活地以他们喜欢的任何方式处理它，从类创建自定义对象，使用第三方 json 库或其他东西。通过这种方法，我不会强迫他们使用某些库，因为整个代码将使用 Java 内置功能。
2. 使用第三方库，如org.json 或GSON 并返回那种对象。这里的缺点是我会强制用户使用第三方库。
3. 我可以为每种对象定义类，大概有 5-6 种类型。缺点是：我需要更多时间来实施解决方案，并且会强制用户使用我的对象。

困扰我的是 Python 开发人员经常使用 dict，而在 Java 中，开发人员通常更喜欢使用特定用户定义类的对象。所以，我无法得出最合适的方法。

Answer 1

HTTP API 的任何端点都具有定义的响应结构（或至少应该如此）。您的库实现的方法应返回表示响应负载的 POJO。最终用户不需要知道 API 会以 JSON 格式格式化负载。如果有一天 API 决定使用 XML，那么该更改对您的库的用户应该是透明的。

编辑：简单地返回字典或地图类型是不好的做法。这样做会强制库的用户在响应中假设每个属性的键字符串和值类型。 POJO 提供了响应属性名称及其值类型的清晰定义。