48.3. 微调应用程序响应

当资源方法返回普通 Java 结构时，RESTful 服务通常需要更精确地控制返回到消费者的响应。JAX-RS 响应 类允许资源方法对发送至使用者的返回状态具有一些控制，并在响应中指定 HTTP 消息标头和 cookies。

响应 对象嵌套代表返回到使用者实体的对象。响应 对象使用 ResponseBuilder 类作为工厂来实例化。

ResponseBuilder 类还有许多用于操作响应元数据的方法。例如，ResonseBuilder 类包含设置 HTTP 标头和缓存控制指令的方法。

响应 类具有受保护的构造器，因此无法直接实例化。它们是使用 Response 类括起的 ResponseBuilder 类创建的。response Builder 类是所有信息的拥有者，它将封装在从其创建的响应中。ResponseBuilder 类还具有负责在消息上设置 HTTP 标头属性的所有方法。

Response 类提供了一些方法来轻松设置正确的响应代码并嵌套实体。每个常见响应状态代码都有方法。与状态对应的方法（包括实体正文或所需元数据）包括允许直接设置信息到关联的响应构建器的版本。

response Builder 类的 build （） 方法返回一个响应对象，其包含在调用方法时存储在响应构建器中的信息。返回响应对象后，响应构建器将返回到干净的状态。

获取响应构建器有两种方法：

有关 Response 类的更多信息，请参阅 Response 类的 Javadoc。

有关 ResponseBuilder 类的更多信息，请参阅 ResponseBuilder 类的 Javadoc。

有关 Apache CXF ResponseBuilderIml 类的更多信息，请参阅 response BuilderImpl Javadoc。

Response 类提供了处理 RESTful 服务需要的更常见响应的快捷方式方法。这些方法处理使用提供的值或默认值设置正确的标头。它们也适当处理实体正文。

当请求成功处理时，需要发送响应来确认请求已达到。该响应可能包含实体。

成功完成响应时的最常见响应是 OK。确定 响应通常包含与请求对应的实体。Response 类具有超载的 ok （） 方法，可将响应状态设置为 200，并将提供的实体添加到括起的响应构建器中。ok （） 方法有五个版本。最常用的变体是：

创建 200 响应的响应 显示使用 OK 状态创建响应的示例。

import javax.ws.rs.core.Response;
import demo.jaxrs.server.Customer;
...

Customer customer = new Customer("Jane", 12);

return Response.ok(customer).build();

对于请求者并不预期实体正文的情况，最好发送 204 No Content status 而不是 200 OK 状态。Response.noContent （） 方法将创建一个适当的响应对象。

创建具有 204 状态的响应 显示创建具有 204 状态的响应的示例。

import javax.ws.rs.core.Response;

return Response.noContent().build();

Response 类提供了处理三个重定向响应状态的方法。

创建具有 304 状态的响应 显示创建具有 304 状态的响应的示例。

import javax.ws.rs.core.Response;

return Response.notModified().build();

Response 类提供了为两个基本处理错误创建响应的方法：

创建 500 状态的响应 显示创建 500 状态的响应示例。

import javax.ws.rs.core.Response;

return Response.serverError().build();

响应 类方法提供了为常见情况创建响应的短期。当您需要解决更复杂的情形时，如指定缓存控制指令、添加自定义 HTTP 标头或发送不由 Response 类处理的状态，您需要使用 ResponseBuilder 类方法在使用 build （） 方法生成响应对象前填充响应。

如 “获取响应构建器”一节 中所述，您可以使用 Apache CXF ResponseBuilderImpl 类创建可直接操作的响应构建器实例。

使用 ResponseBuilder 类的 header （） 方法将自定义标头添加到响应中。header （） 方法采用两个参数：

您可以通过重复调用 header （） 方法，在消息上设置多个标头。

在响应中添加标头 显示将标头添加到响应的代码。

import javax.ws.rs.core.Response;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.header("username", "joe");
Response r = builder.build();

使用 response Builder 类的 cookie （） 方法将自定义标头添加到响应中。Cookie （） 方法采用一个或多个 Cookie。每个 Cookie 存储在 javax.ws.rs.core.NewCookie 对象中。使用 NewCookie 类的 contructors 的最简单方法是取两个参数：

您可以通过重复调用 cookie （） 方法来设置多个 Cookie。

将 Cookie 添加到响应中 显示将 Cookie 添加到响应的代码。

import javax.ws.rs.core.Response;
import javax.ws.rs.core.NewCookie;

NewCookie cookie = new NewCookie("username", "joe");

Response r = Response.ok().cookie(cookie).build();

如果要返回 响应 类帮助程序方法支持的状态以外的状态，您可以使用 ResponseBuilder 类的 status （） 方法来设置响应的状态代码。status （） 方法有两个变体。一个需要指定响应代码的 int。另外一个使用 Response.Status 对象来指定响应代码。

Response.Status 类是一个包括在 Response 类中的枚举。它具有大多数定义的 HTTP 响应代码条目。

在响应中添加标头 显示将响应状态设置为 404 Not Found 的代码。

import javax.ws.rs.core.Response;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.status(404);
Response r = builder.build();

通过 ResponseBuilder 类的 cacheControl （） 方法，您可以在响应上设置缓存控制标头。cacheControl （） 方法采用 javax.ws.rs.CacheControl 对象，该对象指定响应的缓存控制指令。

CacheControl 类具有与 HTTP 规范支持的所有缓存控制指令对应的方法。其中 指令是简单的 on 或 off 值，则 setter 方法采用 布尔值。如果 指令需要数字值，如 max-age 指令，则设置器会采用 int 值。

在响应中添加标头 显示用于设置 no-store 缓存控制指令的代码。

import javax.ws.rs.core.Response;
import javax.ws.rs.core.CacheControl;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

CacheControl cache = new CacheControl();
cache.setNoCache(true);

ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.cacheControl(cache);
Response r = builder.build();