小编点评

本文介绍了JAX-RS中的ExceptionMapper接口及其在处理异常时的优先级和选择。为实现自定义异常，我们创建了一个DbViolationExceptionMapper类，并在spring配置中注册。在业务代码中，我们抛出自定义异常，并通过异常处理器返回相应的HTTP响应。 1. **异常处理重要性与优先级**：本文首先提到，JAX-RS 使用 ExceptionMapper 接口来将 Java 异常映射到 HTTP 响应。为实现自定义异常，我们创建了 UniqueException 类，并通过实现 ExceptionMapper 接口来自定义异常处理。 2. **实现ExceptionMapper接口**：在文章中，我们看到了 DbViolationExceptionMapper 的实现，该类对应于一个自定义的异常类型——DbViolationException。在这个类中，我们重写了 toResponse(Exception ex) 方法以处理特定类型的异常，并生成相应的 HTTP 响应。请注意，如果有多个 Exception Mapper 可用于处理同一类型的异常，JAX-RS 会选择最具体的那个。例如，处理 NullPointerExcetion 的.mapper 覆盖会优先于处理 RuntimeException 的mapper。 3. **注册ExceptionMapper**：为了使自定义异常处理器的功能生效，我们在应用程序的配置文件中添加了刚刚实现的DbViolationExceptionMapper。这样，当出现 UniqueException 时，JAX-RS 会使用这个异常处理器来处理并返回适当的 HTTP 响应。 4. **业务代码中的异常抛出与日志记录**：示例代码展示了如何抛出自定义的 UniqueException 异常，并在业务代码中捕获该异常。同时，我们可以看到如何在一个过滤器中设置状态码和响应头，从而影响返回给客户的 HTTP 响应格式。 5. **状态码为200时的响应类型**：文章中指出，当异常处理器返回的 Response 对象的状态码为 200 时，响应类型应为 "application/json"。这是为什么我们可以在 toResponse 方法中指定 "application/json" 类型的原因。 6. **排版归纳总结**：最后，文章总结了异常处理的重要性、优先级和选择机制，以及如何自定义 ExceptionMapper 和注册到 Spring Boot 应用程序中。同时也指出了业务代码中的异常抛出、日志记录以及在过滤器中控制响应头设置的排版方式。 总之，本文详细解释了JAX-RS中使用ExceptionMapper接口来处理自定义异常的方法和步骤，包括实现 ExceptionMapper 接口、注册自定义异常处理器、异常在业务代码中的抛出和处理，以及如何控制状态码和响应类型。

正文

异常拦截器ExceptionMapper

在JAX-RS（Java API for RESTful Web Services）中，ExceptionMapper接口用于将Java异常映射到HTTP响应。通过实现ExceptionMapper接口，你可以自定义如何处理特定类型的异常，并生成相应的HTTP响应。

优先级和选择

当有多个ExceptionMapper可用于处理同一类型的异常时，JAX-RS会选择最具体的那个。例如，如果你有一个处理RuntimeException的ExceptionMapper和一个处理NullPointerException的ExceptionMapper，那么当抛出NullPointerException时，会选择处理NullPointerException的ExceptionMapper。

定义自定义异常

    public class UniqueException extends RuntimeException {

	public UniqueException(Throwable cause) {
		super(cause);
	}

	public UniqueException(String message) {
		super(message);
	}

	public UniqueException(String message, Throwable cause) {
		super(message, cause);
	}

}

实现ExceptionMapper

/**
 * 数据表约束异常处理器.
 *
 * @author lind
 * @date 2024/6/4 10:45
 * @since 1.0.0
 */
@Provider
public class DbViolationExceptionMapper implements ExceptionMapper<UniqueException> {

	@Override
	public Response toResponse(UniqueException exception) {

		return Response.status(Response.Status.BAD_REQUEST)
				.entity(MapUtil.builder().put("error", exception.getMessage()).build()).type(MediaType.APPLICATION_JSON)
				.encoding("utf-8").build();// 非200的请求，这个type无效，一直是text/plain

		/*
		 * return Response.status(Response.Status.OK)
		 * .entity(MapUtil.builder().put("error", exception.getMessage()).build())
		 * .type("application/json; charset=UTF-8").build();//
		 * 200的请求，是可以使用application/json的
		 *
		 */
	}

}

注册ExceptionMapper

在文件resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports添加内容

com.xx.exception.handler.DbViolationExceptionMapper

业务代码直接抛出异常

if (getCurrentUserId() == null || !getCurrentUserId().equals(userId)) {
	throw new UniqueException("权限不足");
 }

相关问题

• 当在ExceptionMapper中返回的Response对象，状态码为200时，可以响应为application/json
• 当Response对象状态码非200时，响应一直是text/plain

经过调试与排查，发现当非200时，在这个过滤器里，它出现了两个content-type,text/plain不知道是什么时间被加进去的，如图

方法执行到这里时，为响应头添加了text/plain

setStatus()方法如下

  public void setStatus(int status) {
        if (status > 200) {
            this.addOutputHeaders(RestHeaderEnum.CONTENT_TYPE.getHeader(), MediaType.TEXT_PLAIN.value);
        }

        this.status = status;
    }

这也是业务代码中，直接报出自定义异常，在ExceptionMapper捕获返回json没有生效的原因，这块感觉dubbo设计的不太好。