引言
在开发中,我们会有如下的场景:某个接口中,存在一些业务异常。例如用户输入的参数校验失败、用户名密码不存在等。当触发这些业务异常时,我们需要抛出这些自定义的业务异常,并对其进行处理。一般我们要把这些异常信息的状态码和异常描述,友好地返回给调用者,调用者则利用状态码等信息判断异常的具体情况。
过去,我们可能需要在 controller 层通过 try/catch 处理。首先 catch 自定义异常,然后 catch 其它异常。对于不同的异常,我们需要在 catch 的同时封装将要返回的对象。然而,这么做的弊端就是代码会变得冗长。每个接口都需要做 try/catch 处理,而且一旦需要调整,所有的接口都需要修改一遍,非常不利于代码的维护,如下段代码所示
1 | "/test") (value = |
那么,有没有什么方法可以简便地处理这些异常信息呢?答案是肯定的。Spring 3.2 中,新增了 @ControllerAdvice
注解,可以用于定义 @ExceptionHandler
、@InitBinder
、@ModelAttribute
,并应用到所有 @RequestMapping
中。简单来说就是,可以通过 @ControllerAdvice
注解配置一个全局异常处理类,来统一处理 controller 层中的异常,于此同时 controller 中可以不用再写 try/catch,这使得代码既整洁又便于维护。
使用方法
定义自定义异常
有关自定义异常相关知识点这里就不详细说明了,如果不了解的话自行搜索一下。这里贴上一个简单的自定义业务异常类。
1 | /** |
注:@Data
为 Lombok 插件。自动生成 set/get 方法。具体使用方法这里就不展开介绍了。
@ControllerAdvice+
@ExceptionHand` 配置全局异常处理类
1 | /** |
@ControllerAdvice
定义该类为全局异常处理类。
@ExceptionHandler
定义该方法为异常处理方法。value 的值为需要处理的异常类的 class 文件。在例子中,方法传入两个参数。一个是对应的 Exception 异常类,一个是 HttpServletRequest 类。当然,除了这两种参数,还支持传入一些其他参数。详见文档https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/bind/annotation/ExceptionHandler.html
这样,就可以对不同的异常进行统一处理了。通常,为了使 controller 中不再使用任何 try/catch,也可以在 GlobalExceptionHandler 中对 Exception 做统一处理。这样其他没有用 @ExceptionHandler 配置的异常就都会统一被处理。
遇到异常时抛出异常即可
在业务中,遇到业务异常的地方,直接使用 throw 抛出对应的业务异常即可。例如
1 | throw new BusinessException("3000", "账户密码错误"); |
在 Controller 中的写法
Controller 中,不需要再写 try/catch,除非特殊用途。
1 | "/test") (value = |
结果展示
异常抛出后,返回如下结果。
1 | { |
注意
- 不一定必须在 controller 层本身抛出异常才能被 GlobalExceptionHandler 处理,只要异常最后是从 contoller 层抛出去的就可以被全局异常处理器处理。
- 异步方法中的异常不会被全局异常处理。
- 抛出的异常如果被代码内的 try/catch 捕获了,就不会被 GlobalExceptionHandler 处理了。
总结
本文介绍了在 SpringBoot 中,通过配置全局异常处理器统一处理 Controller 层引发的异常。
优点
减少代码冗余,代码便于维护
缺点
只能处理 controller 层抛出的异常,对例如 Interceptor(拦截器)层的异常、定时任务中的异常、异步方法中的异常,不会进行处理。
以上就是用 @ControllerAdvice
+ @ExceptionHand
实现 SpringBoot 中捕获 controller 层全局异常并处理的方法。
附:项目Demo地址:https://github.com/InterHorse/springboot-globle-exception-demo
有关全局异常的进阶使用,请参阅 SpringBoot 全局异常处理进阶:使用 @ControllerAdvice 对不同的 Controller 分别捕获异常并处理
站在前人的肩膀上前行,感谢以下博客及文献的支持。
@ControllerAdvice + @ExceptionHandler 全局处理 Controller 层异常
Spring Boot 系列(八)@ControllerAdvice 拦截异常并统一处理