java - 哪个更好 : returning a Response object or an Object representing the rest resource?

Question

在一些书籍中，其余的 API 通常返回一个 Response 对象，该对象包装了一些其他表示负载、状态等的对象。

另一方面，我看到和编写的许多 API 都返回一个 POJO(或称其为 DTO)作为客户端使用的 JSON。

这可能是基于意见的，但我想知道在高可扩展性环境中使用两者哪个更好，在这种环境中，某些请求会成功，而其他请求会失败/数据未返回。

我想知道是否有公认的更好的做法。这将帮助我设计一些 API 并在我的团队面前正确看待事情。但如果“两者中的更好”过于基于意见，我可以接受这个问题被关闭。

谢谢。

更新:两个 rest API 看起来像这样。避免使用@Path、@Get、@PathParam、@Produces 等代码

public Response myCustomerObject(int id){...} 

这将返回一个包装在 Response 对象中的 Customer 对象。响应也可能出错。

下面的方法将直接返回 Customer 实体:

public Customer myCustomerObject(int id){...} 

Answer 1

我会投票支持为您提供 Response 对象的 API。这使您可以在代码中完全控制响应，并且很清楚响应是什么。如果您想编写一个无法轻易用 POJO 表示的响应，您不必被迫使用不直观的解决方法。

从 rest 处理程序方法返回一个对象，然后将其转换为响应，这对我的口味来说是太多的框架魔法了。

最糟糕的 - 恕我直言 - 是从 rest 处理程序方法返回 String 的做法，然后将其解释为模板引用(例如，JSP 资源的路径)，然后将其写入响应。魔法又太多了。