JAX-RS 中不同的 HTTP 方法返回什么？ 旁白

编程问答 2022-05-28

问题描述

我正在练习使用 RESTEasy 实现构建 RESTFUL API。但是我还是有点迷茫，按照HTTP的方式应该返回什么。这是我目前的做法：

  1. @GET 返回一个实体
  2. @POST 返回包含实际创建实体的 HTTP 响应
  3. @PUT 返回更新了实际实体的 HTTP 响应
  4. @DELETE 返回删除实际实体的 HTTP 响应

这是我的控制器示例，用于说明。

@GET
@Path("/{bookId}")
@Produces(MediaType.APPLICATION_JSON_VALUE)
public Book getBookById(@PathParam("bookId") Integer bookId) {
    return bookService.getBookById(bookId);
}

@POST
@Consumes(MediaType.APPLICATION_JSON_VALUE)
@Produces(MediaType.APPLICATION_JSON_VALUE)
public Response inertBook(@Valid Book book) {
    return bookService.insertBook(book);
}

@DELETE
@Path("/{bookId}")
public Response deleteBook(@PathParam("bookId") Integer bookId) {
    return bookService.deleteBook(bookId);
}

@PUT
@Path("/{bookId}")
@Consumes(MediaType.APPLICATION_JSON_VALUE)
@Produces(MediaType.APPLICATION_JSON_VALUE)
public Response updateBook(@PathParam("bookId") Integer bookId,@Valid Book book) {
    return bookService.updateBook(bookId,book);
}

解决方法

  1. GET - 客户端正在尝试检索资源，或者换句话说，获取 资源。所以是的，你应该返回一个状态码为“200 OK”的实体在大多数情况下，它要么是一个单一的资源，要么是一个集合资源；在你的例子中，要么是一本书，要么是所有的书

  2. POST - 当您创建新资源时，通常客户端会发送要创建的新书的表示。客户端没有的是资源的标识符或以后如何访问资源。通常所做的是将 Location 标头发送回客户端，以便客户端稍后可以访问资源。此响应的状态应为“201 Created”（可选），您可以发送回客户端发送的相同表示，但包括新创建的标识符。您可以在 this post 中看到一个示例。

  3. PUT - 这是一个完整的更新。因此，无论客户端发送什么，都会完全覆盖当前资源（不包括标识符）。所以最终，客户已经掌握了所有信息；无需寄回任何东西。您可以只回复“204 无内容”状态。在代码方面，您可以简单地使用 void 方法或返回 Response 来显式设置状态。

  4. DELETE - 如果删除一切顺利，则无需发送任何内容，只需让客户端知道一切正常。所以简单地发送一个“200 OK”响应是合适的。可选地，包括删除的表示可能没问题。

这些是非常通用的准则。每个人都有自己的风格，但大多数人都试图遵循标准。以下是一些您可以深入了解以了解更多信息的资源

旁白

我正在查看您的服务层实现方式（您的 BookService 类）并且存在一些设计缺陷。通常，在分层应用程序中，较低层不应了解其上层的任何信息。这是层的示例

  WEB
   ↓
SERVICE
   ↓
  DAO
  • WEB 层是 REST 层（JAX-RS 代码）
  • SERVICE 层是业务发生的 BookService
  • DAO 层是稍后发生数据访问的数据

在这个架构中，DAO层不应该知道SERVICE层，SERVICE层不应该知道WEB层。不过，在您的示例中，您的服务知道 Response 对象。 Response 应该只用于 WEB 层。更好的实现可能看起来像

public Response getBook(@PathParam("id") long id) {
    Book book = bookService.findBook(id);
    if (book == null) {
        throw new NotFoundException();
    }
    return book;
}

现在 BookService 只负责找书，资源方法处理所有的网络逻辑。

,

了解 Entity Providers，他们实现了 MessageBodyWriter。

RESTEasy 是 JAX-RS（现在是 Jakarta EE 的子规范）的一个实现。为了了解响应是如何生成的（这是您在考虑资源方法可以返回什么时需要知道的），您应该了解 MessageBodyWriter 的工作原理。

Resource Method 几乎可以返回任何内容，包括 String、Response、一些自定义 bean 等，但与您的方法返回的内容无关，而是如何（作为哪个 MediaType）您的 MessageBodyWriter 实现将输出流转换为 HTTP 响应正文。

从 JAX-RS 资源方法返回的值由实体提供程序（即 MessageBodyWriter 实现）转换为 HTTP 响应正文，具体取决于您指示方法设置为 MIME 类型的内容（使用 @Produces,on top of method) 响应以及您的类路径上是否有相应的转换器（实体提供程序，即 MessageBodyWriter），JAX-RS 将：

  1. 寻找 @Produces 值；
  2. 然后查找相应的转换器/MessageBodyWriter（如果在类路径上找不到所需的实现，将抛出转换异常）；
  3. 将您的输出流序列化为您用 @Produces(MediaType.TypeHere) 指示它返回的任何内容，并将返回它。

请记住，返回非 void Java 类型会导致 200 OK 响应，而 void 方法会导致 204 No Content 响应。

@Produces 通过向响应添加 Content-type 标头来指定您的资源方法应生成的 MIME 类型的响应正文。对于不同的 MIME 类型，您需要一个相应的转换器库（MessageBodyWriter 的实现）来返回您指定的媒体/MIME 类型。

旁注：JAX-RS 是 RESTful Web 服务的规范，这意味着在大多数情况下，您最好使用 JSON。

apiapijavajavajax-rsrestrestresteasy