在REST web服务中设置HTTP状态代码有几个用例,现有的答案中至少有一个没有充分记录(例如,当您使用JAXB使用自动神奇的JSON/XML序列化时,并且您希望返回一个要序列化的对象,但状态代码也不同于默认的200)。
所以让我试着列举不同的用例和每个用例的解决方案:
1. 错误码(500,404,…)
当您希望返回不同于200 OK的状态代码时,最常见的用例是发生错误时。
例如:
请求一个实体,但它不存在(404)
请求在语义上不正确(400)
用户未被授权(401)
数据库连接有问题(500)
等。
a)抛出异常
在这种情况下,我认为处理问题的最干净的方法是抛出异常。该异常将由ExceptionMapper处理,它将异常转换为带有适当错误代码的响应。
您可以使用与Jersey一起预先配置的默认ExceptionMapper(我想它与其他实现一样),并抛出javax.ws.rs.WebApplicationException的任何现有子类。这些是预先定义的异常类型,被预先映射到不同的错误代码,例如:
BadRequestException (400)
InternalServerErrorException (500)
NotFoundException (404)
等。你可以在这里找到列表:API
或者,您可以定义自己的自定义异常和ExceptionMapper类,并通过@Provider注释(本例的来源)将这些映射器添加到Jersey:
public class MyApplicationException extends Exception implements Serializable
{
private static final long serialVersionUID = 1L;
public MyApplicationException() {
super();
}
public MyApplicationException(String msg) {
super(msg);
}
public MyApplicationException(String msg, Exception e) {
super(msg, e);
}
}
供应商:
@Provider
public class MyApplicationExceptionHandler implements ExceptionMapper<MyApplicationException>
{
@Override
public Response toResponse(MyApplicationException exception)
{
return Response.status(Status.BAD_REQUEST).entity(exception.getMessage()).build();
}
}
注意:您还可以为您使用的现有异常类型编写ExceptionMappers。
b)使用Response构建器
设置状态代码的另一种方法是使用Response构建器来使用预期的代码构建响应。
在这种情况下,方法的返回类型必须是javax.ws.rs.core.Response。这一点在其他各种回答中都有描述,比如他的“公认答案”,看起来是这样的:
@GET
@Path("myresource({id}")
public Response retrieveSomething(@PathParam("id") String id) {
...
Entity entity = service.getById(uuid);
if(entity == null) {
return Response.status(Response.Status.NOT_FOUND).entity("Resource not found for ID: " + uuid).build();
}
...
}
2. 成功,但不是200
另一种希望设置返回状态的情况是,当操作成功时,但希望返回不同于200的成功代码,以及在主体中返回的内容。
一个常见的用例是当您创建一个新实体(POST请求)并希望返回关于这个新实体或实体本身的信息,以及201 Created状态代码时。
一种方法是像上面描述的那样使用响应对象,并自己设置请求的主体。但是,这样做就失去了使用JAXB提供的自动序列化到XML或JSON的能力。
这是返回一个将被JAXB序列化为JSON的实体对象的原始方法:
@Path("/")
@POST
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
public User addUser(User user){
User newuser = ... do something like DB insert ...
return newuser;
}
这将返回新创建用户的JSON表示形式,但返回状态将是200,而不是201。
现在的问题是,如果我想使用Response构建器来设置返回代码,我必须在方法中返回一个Response对象。我如何仍然返回用户对象被序列化?
a)在servlet响应上设置代码
解决这个问题的一种方法是获取一个servlet请求对象,并手动设置响应代码,就像garrett Wilson的回答中演示的那样:
@Path("/")
@POST
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
public User addUser(User user, @Context final HttpServletResponse response){
User newUser = ...
//set HTTP code to "201 Created"
response.setStatus(HttpServletResponse.SC_CREATED);
try {
response.flushBuffer();
}catch(Exception e){}
return newUser;
}
该方法仍然返回一个实体对象,状态代码将是201。
注意,为了使它工作,我必须刷新响应。这是JAX_RS资源中低级Servlet API代码令人不快的重新出现,更糟糕的是,它导致在此之后头不可修改,因为它们已经通过网络发送了。
b)与实体一起使用响应对象
在这种情况下,最好的解决方案是使用Response对象并将实体设置为在此响应对象上序列化。在这种情况下,最好将Response对象设为泛型,以指示有效负载实体的类型,但目前不是这样。
@Path("/")
@POST
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
public Response addUser(User user){
User newUser = ...
return Response.created(hateoas.buildLinkUri(newUser, "entity")).entity(restResponse).build();
}
在这种情况下,我们使用Response构建器类的已创建方法来将状态代码设置为201。我们通过entity()方法将实体对象(用户)传递给响应。
结果是HTTP代码是我们想要的401,响应的主体是与我们之前返回User对象时完全相同的JSON。它还添加了一个位置标头。
Response类有许多用于不同状态的构建器方法(stati ?),例如:
Response.accepted ()
Response.ok ()
Response.noContent ()
Response.notAcceptable ()
注意:hateoas对象是一个助手类,我开发它来帮助生成资源uri。你需要想出你自己的机制;)
差不多就是这样。
我希望这个冗长的回答能帮助到一些人:)