JAX-RS jersey ExceptionMappers 用户定义的异常

Question

我是新手，试图阅读一些文档但它不起作用，请多多包涵。

我使用ExceptionMappers 创建了一个UserNotFoundMapper，如下所示：

public class UserNotFoundMapper implements ExceptionMapper<UserNotFoundException> {

@Override
public Response toResponse(UserNotFoundException ex) {
    return Response.status(404).entity(ex.getMessage()).type("text/plain").build();
}

}

这在我的服务中：

@GET
@Path("/user")
public Response getUser(@QueryParam("id") String id) throws UserNotFoundException{
    //Some user validation code with DB hit, if not found then
    throw new UserNotFoundException();
}

UserNotFoundException 是一个 User-Defined 异常。

我试过了：

public class UserNotFoundException extends Exception {
       //SOME block of code 
}

但是当我调用服务时，UserDefinedExceptionMapper 没有被调用。看来我可能在UserDefinedException 中遗漏了一些东西。那么如何定义这个异常呢？

请告诉我如何定义UserNotFoundException。

Answer 1

您需要使用 @Provider 注释您的异常映射器，否则它将永远不会注册到 JAX-RS 运行时。

@Provider
public class UserNotFoundMapper implements
        ExceptionMapper<UserNotFoundException> {
    @Override
    public Response toResponse(UserNotFoundException ex) {
        return Response.status(404).entity(ex.getMessage()).type("text/plain")
                .build();
    }
}

Answer 2

我在创建 API 时通常会创建自己的异常，该异常从 RuntimeException 扩展而来，因此我不必捕获我的异常。

这是一个例子：

注意：我在 Jersey 中使用 JAX-RS

首先：创建我自己的从 RuntimeException 扩展的异常。

public class ExceptionName extends RuntimeException {

private int code;
private String message;

public int getCode(){
    return code;
}

public String getMessage(){
    return message;
}

public ExceptionName(int code, String message) {
    this.code = code;
    this.message = message;
}

}

同时实现ExceptionMapper

@Provider
public class ExceptionName implements ExceptionMapper<ExceptionName>{

    @Override
    public Response toResponse(ExceptionName exception) {
        return Response.status(exception.getCode()).entity(exception.getMessage()).build();
    }

}

每次我想抛出异常时，我都会在任何地方这样做，异常映射器会负责向使用 API 的客户端返回响应

throw new ExceptionName(500,"there was an error with something here");

Answer 3

一个小评论，尝试使用 Response.Status.NOT_FOUND 而不是使用 404 等。代码将更具可读性并且不易出现拼写错误，“text/plain”也是如此。下面是处理您提到的异常的代码。 还有一件事记得在你的界面中注释你的方法@Produces(MediaType.TEXT_PLAIN)

公共类 UserNotFoundException 扩展异常 { //... } 公共类 UserServiceImpl 实现 UserService { @覆盖 公共响应 getUser(@QueryParam("id") String id) { 最终响应响应； 尝试{ // 调用用户方法 //如果一切正常 response = Response.status(Response.Status.OK).entity(whateverYouWant).type(MediaType.TEXT_PLAIN).build(); } 捕捉（UserNotFoundException ex）{ response = new UserNotFoundMapper().toResponse(ex); } 返回响应； } } 在客户幻灯片中，您可以检查 public static boolean isUserExists(final Response serverResp) { return serverResp != null && serverResp.getStatus() == Response.Status.NOT_FOUND.getStatusCode(); }