Spring @ExceptionHandler 注解是如何工作的？

发表于 更新于 分类于 阅读次数： 本文字数： 2.5k 阅读时长 ≈ 2 分钟

大家好呀，我是猿java。

在日常工作中，我们通常会是使用 @ExceptionHandler注解来处理控制器（Controller）层面的异常，从而提高代码的可维护性和复用性。那么，@ExceptionHandler注解是如何工作的？我们需要注意什么？这篇文章，我们来聊一聊。

1. 主要作用

首先，我们看看@ExceptionHandler注解的源码，截图如下：

img

通过源码，我们可以看到@ExceptionHandler注解只能用于方法上。从整体上看，@ExceptionHandler注解的作用主要有下面两点：

  • 局部异常处理：在单个控制器类中使用@ExceptionHandler，只对该控制器内部的方法抛出的异常进行处理。这种方式适用于特定控制器需要独立处理某些异常的场景。

  • 全局异常处理：结合@ControllerAdvice注解，可以定义全局的异常处理逻辑，适用于整个应用程序中所有控制器抛出的异常。这种方式有助于统一的异常处理机制，避免在每个控制器中重复编写异常处理代码。

使用@ExceptionHandler注解的好处有下面几点：

  • 代码简洁：将异常处理逻辑与业务逻辑分离，避免在每个控制器方法中重复编写异常处理代码。
  • 可维护性强：集中管理异常处理逻辑，便于修改和扩展。
  • 灵活性高：支持局部和全局的异常处理，满足不同场景下的需求。

2. 原理

@ExceptionHandler的实现基于Spring的异常处理机制，主要涉及以下几个关键组件：

  • 异常解析器（HandlerExceptionResolver）：Spring MVC使用HandlerExceptionResolver接口来解析控制器方法抛出的异常。@ExceptionHandler是通过这种解析机制实现的。

  • 反射机制：当控制器方法抛出异常时，Spring会扫描该控制器类中带有@ExceptionHandler注解的方法，匹配异常类型，找到合适的异常处理方法。

  • 匹配策略：

    1. 局部优先：首先查找当前控制器内带有@ExceptionHandler注解的方法，匹配异常类型，执行相应的处理逻辑。
    2. 全局处理：如果当前控制器没有匹配的@ExceptionHandler方法，则会查找使用@ControllerAdvice注解的类中定义的全局异常处理方法。
    3. 默认处理：如果没有找到任何匹配的异常处理方法，Spring会使用其默认的异常处理机制，通常会返回一个错误页面或错误响应。

3. 使用方法

在控制器类中定义带有@ExceptionHandler注解的方法，示例如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@Controller
public class TestController {

    @RequestMapping("/tes")
    public String example() {
        // 可能抛出异常的业务逻辑
        if (someCondition) {
            throw new CustomException("自定义异常发生");
        }
        return "success";
    }

    @ExceptionHandler(CustomException.class)
    public ModelAndView handleCustomException(CustomException ex) {
        ModelAndView mav = new ModelAndView("errorView");
        mav.addObject("message", ex.getMessage());
        return mav;
    }
}

在上述示例中，当/test请求处理方法抛出CustomException时，handleCustomException方法会被调用，返回一个指向errorView视图的ModelAndView对象，并将异常信息传递给视图。

另外，我们可以通过结合@ControllerAdvice和@ExceptionHandler两个注解，可以实现全局异常处理，示例如下：

1
2
3
4
5
6
7
8
9
10
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ModelAndView handleAllExceptions(Exception ex) {
        ModelAndView mav = new ModelAndView("globalErrorView");
        mav.addObject("message", ex.getMessage());
        return mav;
    }
}

这样，无论哪个控制器抛出Exception或其子类异常，handleAllExceptions方法都会处理这些异常，从而实现统一的异常处理逻辑。

4. 注意事项

尽管@ExceptionHandler注解在Spring中提供了一种优雅而高效的方式来处理应用中的异常，但是在使用的过程中，我们也需要注意以下几点：

  • @ExceptionHandler方法的返回值可以是ModelAndView、ResponseEntity，或直接返回视图名称，具体取决于应用的需求。
  • 异常处理方法可以接收异常对象作为参数，也可以接收其他与请求相关的参数，如HttpServletRequest、HttpServletResponse等。
  • 在使用全局异常处理时，应合理定义异常层次结构和处理策略，以确保不同类型的异常得到正确的处理。

5. 总结

本文，我们分析了@ExceptionHandler注解的使用方法，了解了@ExceptionHandler注解在Spring中的作用，以及它的优势和注意事项。在实际工作中，我们可以使用@ExceptionHandler注解更优雅地处理异常。

6. 学习交流

如果你觉得文章有帮助，请帮忙转发给更多的好友，或关注公众号：猿java，持续输出硬核文章。

drawing