Spring Boot 全局异常捕获 ControllerAdvice 无法捕获 过滤器（Filter）和拦截器（Interceptor）中的异常
2024年02月27日 12:34:59
本文共 1,995
字阅读时间约 7分钟
1,292 次浏览
在 Spring Boot 中我们常用 @RestControllerAdvice 和 @ControllerAdvice 来全局捕获异常来优雅的处理异常，但并不是真的能捕获全部异常，我遇到的一次情况是：自定义过滤器继承 OncePerRequestFilter，在过滤器中会交验 Token，当 Token 过期后会抛出一个 ExpiredJwtException 异常，但无法被捕获。
问题其实就出在了 Filter 中抛出的异常，我们来看下 Spring Boot 对过滤器、拦截器和 Controller 的执行顺序。
Spring Boot Filter过滤器、Interceptor拦截器和 ControllerAdvice 的执行顺序
在一个请求进来以后，会以如下的顺序进行执行和传递：
-
过滤器（Filter）：过滤器是 Java Web 中的一种技术，它在请求到达 Servlet 之前或之后进行处理。因此，过滤器是最先执行的拦截器。
-
拦截器（Interceptor）：拦截器是 Spring MVC 框架提供的一种技术，它在请求到达 Controller 之前或之后进行处理。因此，拦截器在过滤器之后执行，但在请求到达 Controller 之前。
-
ControllerAdvice：ControllerAdvice 是 Spring MVC 提供的一个注解，用于定义一个全局的异常处理器、数据绑定器和模型处理器。
总的来说，拦截方式的执行顺序是过滤器->拦截器->ControllerAdvice。
ControllerAdvice 无法捕获过滤器和拦截器的异常
根据上面说的执行顺序，如果在过滤器和拦截器中抛出异常，那么 ControllerAdvice 无法捕获，因为还没执行到 ControllerAdvice 就抛出异常停止执行了。
所以如果是在 Controller 层或更下面的 Service 层和 DAO 层，是可以被捕获异常的，但是在 Controller 层之前抛出了异常就无法捕获。
使用 ControllerAdvice 对过滤器（Filter）中的异常捕获
我们明白运行的原理以后，想要使用 ControllerAdvice 对过滤器（Filter）中的异常捕获，就需要抛出异常以后继续向后面传递执行，而不是在过滤器（Filter）中抛出异常。
根据运行原理，我们这样做：
-
在过滤器（Filter）中 try 捕获异常，将异常对象设置到 Attribute 属性中，并且明确设置告诉 Dispatcher 处理的 Controller。
-
新建一个接收异常的 Controller，从 Attribute 属性中取出异常对象，重新在 Controller 层抛出。
代码案例如下：
在过滤器（Filter）中：
public class DemoFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
// 假设在这里会抛出一个 ExpiredJwtException 异常
filterChain.doFilter(servletRequest, servletResponse);
}catch (ExpiredJwtException e){
// 将异常对象设置到 Attribute 属性中
servletRequest.setAttribute("filter.error", e);
// 告诉 Dispatcher 处理的 Controller
servletRequest.getRequestDispatcher("/error/exthrow").forward(servletRequest, servletResponse);
}
新建一个接收异常的 Controller：
@Controller
public class ExceptionThrowController {
@RequestMapping("/error/exthrow")
public void returnThrow(HttpServletRequest request) throws Exception {
// 从 Attribute 属性中取出异常对象，重新在 Controller 层抛出
throw ((Exception) request.getAttribute("filter.error"));
}
到这里，ControllerAdvice 就可以捕获这个异常了：
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(value = ExpiredJwtException.class)
public ApiResult<?> expiredJwtExceptionHandler(ExpiredJwtException e){
return ApiResult.builder()
.code(HttpStatus.UNAUTHORIZED)
.message("JWT expired")
.build();
}
明白其原理，你写代码会游刃有余。或者你有更好的解决办法吗？欢迎在评论区中分享你的方案。
点赞(0)
点踩(0)
