如何在 Tomcat 上的 JAX-RS (Jersey) 中返回 HTTP 404 JSON/XML 响应？

Question

我有以下代码：

@Path("/users/{id}")
public class UserResource {

    @Autowired
    private UserDao userDao;

    @GET
    @Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
    public User getUser(@PathParam("id") int id) {
        User user = userDao.getUserById(id);
        if (user == null) {
            throw new NotFoundException();
        }
        return user;
    }

如果我使用“Accept: application/json”请求不存在的用户（例如 /users/1234），则此代码会像预期的那样返回 HTTP 404 响应，但返回的 Content-Type 设置为 text/html和一个html的正文消息。注释@Produces 被忽略。

是代码问题还是配置问题？

Answer 1

您的 @Produces 注释将被忽略，因为 jax-rs 运行时使用预定义（默认）ExceptionMapper 处理未捕获的异常987654323@处理它。在您的情况下，您需要一个处理 NotFoundException 异常并查询请求类型的响应的“接受”标头：

@Provider
public class NotFoundExceptionHandler implements ExceptionMapper<NotFoundException>{

    @Context
    private HttpHeaders headers;

    public Response toResponse(NotFoundException ex){
        return Response.status(404).entity(yourMessage).type( getAcceptType()).build();
    }

    private String getAcceptType(){
         List<MediaType> accepts = headers.getAcceptableMediaTypes();
         if (accepts!=null && accepts.size() > 0) {
             //choose one
         }else {
             //return a default one like Application/json
         }
    }
}

Answer 2

您可以使用响应返回。示例如下：

@GET
@Path("{id}")
@Produces(MediaType.APPLICATION_JSON)
public Response get(@PathParam("id") Long id) {
    ExampleEntity exampleEntity = getExampleEntityById(id);

    if (exampleEntity != null) {
        return Response.ok(exampleEntity).build();
    }

    return Response.status(Status.NOT_FOUND).build();
}

Answer 3

您的服务器返回 404，因为预计您将按照以下形式传递内容

/users/{id}

但您将其传递为

/users/user/{id}

哪个资源根本不存在

尝试以/users/1234 访问资源

编辑：

创建一个类

class RestResponse<T>{
private String status;
private String message;
private List<T> objectList;
//gettrs and setters
}

现在如果您想回复User，您可以按以下方式创建它

RestResponse<User> resp = new RestResponse<User>();
resp.setStatus("400");
resp.setMessage("User does not exist");

您的休息方法的签名如下

public RestResponse<User> getUser(@PathParam("id") int id)

如果响应成功，您可以设置类似

RestResponse<User> resp = new RestResponse<User>();
List<User> userList = new ArrayList<User>();
userList.add(user);//the user object you want to return
resp.setStatus("200");
resp.setMessage("User exist");
resp.setObjectList(userList);