JAX-RS异常处理：自定义ExceptionMapper实践

最新推荐文章于 2024-12-23 21:45:31 发布

t0_54manong

最新推荐文章于 2024-12-23 21:45:31 发布

阅读量487

点赞数 12

文章标签： python 开发语言个人开发

本文链接：https://blog.csdn.net/m0_74337424/article/details/144387831

版权

JAX-RS异常处理：自定义ExceptionMapper实践

在构建RESTful API时，异常处理是一个重要的环节。JAX-RS提供了一种灵活的方式来处理异常，即通过ExceptionMapper接口。本文将详细介绍如何实现和使用ExceptionMapper，并通过一个具体实例来展示其在实际项目中的应用。

什么是ExceptionMapper？

在JAX-RS中，ExceptionMapper接口用于将检查型异常或运行时异常映射到Response实例。要提供异常映射，我们需要编写一个实现ExceptionMapper<E extends Throwable>接口的类。这个类可以被@Provider注解标注，以便自动发现和注册。

实现ExceptionMapper

以下是一个ExceptionMapper的实现示例，它处理自定义异常InvalidIdException：

@Provider
public class InvalidIdExceptionMapper implements ExceptionMapper<InvalidIdException> {
    @Override
    public Response toResponse(InvalidIdException exception) {
        return Response.status(Response.Status.NOT_FOUND)
                       .entity(prepareMessage(exception))
                       .type("text/plain")
                       .build();
    }

    private String prepareMessage(InvalidIdException exception) {
        String m = exception.getMessage();
        String r = "Invalid request.\n";
        r += String.format("Error Message: %s.%nError Type: %s.%n"
                          + "You may contact admin@example.com for more questions.",
                  m, exception.getClass());
        return r;
    }
}

public class InvalidIdException extends RuntimeException {
    public InvalidIdException(String message) {
        super(message);
    }
}

在这个例子中，当InvalidIdException被抛出时，InvalidIdExceptionMapper会被JAX-RS运行时调用，将异常信息转换为HTTP 404响应，并返回一个包含错误信息的文本实体。

编写JAX-RS资源

接下来，我们来看一个JAX-RS资源的实现，它可能会抛出InvalidIdException：

@Path("/employees")
public class EmployeeResource {
    @GET
    @Path("{id}")
    public String getEmployeeId(@PathParam("id") String employeeId) {
        return EmployeeService.Instance.getEmployeeById(employeeId);
    }
}

public enum EmployeeService {
    Instance;
    public String getEmployeeById(String id) {
        try {
            long l = Long.parseLong(id);
            //just a dummy response
            return "employee" + l;
        } catch (NumberFormatException e) {
            throw new InvalidIdException("Employee id is not valid, " + id);
        }
    }
}