SpringBoot 如何进行全局异常捕获和处理?
- 一,为什么要用全局异常处理?
- 二,应用场景是什么?
- 三、如何进行全局异常捕获和处理?
- 四、@ControllerAdvice和@ExceptionHandler怎么用?
- 六、@Validated 校验器注解的异常?
- 七、自定义异常以及事务回滚
一,为什么要用全局异常处理?
在日常开发中,为了不抛出异常堆栈信息给前端页面,每次编写Controller层代码都要尽可能的catch住所有service层、dao层等异常,代码耦合性较高,且不美观,不利于后期维护。
为解决该问题,计划将Controller层异常信息统一封装处理,且能区分对待Controller层方法返回给前端的String、Map、JSONObject、ModelAndView等结果类型。
推荐下自己做的 Spring Boot 的实战项目:
https://github.com/YunaiV/ruoyi-vue-pro
二,应用场景是什么?
- 非常方便的去掉了try catch这类冗杂难看的代码,有利于代码的整洁和优雅
- 自定义参数校验时候全局异常处理会捕获异常,将该异常统一返回给前端,省略很多if else代码
- 当后端出现异常时,需要返回给前端一个友好的界面的时候就需要全局异常处理
- 因为异常时层层向上抛出的,为了避免控制台打印一长串异常信息
推荐下自己做的 Spring Cloud 的实战项目:
https://github.com/YunaiV/onemall
三、如何进行全局异常捕获和处理?
一共有两种方法:
- Spring的AOP(较复杂)
@ControllerAdvice
结合@ExceptionHandler
(简单)
四、@ControllerAdvice和@ExceptionHandler怎么用?
1、Controller Advice字面上意思是“控制器通知”,Advice除了“劝告”、“意见”之外,还有“通知”的意思。
可以将@ExceptionHandler(标识异常类型对应的处理方法)标记的方法提取出来,放到一个类里,并将加上@ControllerAdvice
,这样,所有的控制器都可以用了
@ControllerAdvice
public class ControllerHandlers(){
@ExceptionHandler
public String errorHandler(Exception e){
return "error";
}
}
2、 因为@ControllerAdvice
被@Componen
标记,所以他可以被组件扫描到并放入Spring容器
3、 如果只想对一部分买QQ平台地图控制器通知,比如某个包下边的控制器,就可以这样写:
@ControllerAdvice("com.labor")
public class ControllerHandlers(){}
也可以直接写类名
@ControllerAdvice(basePackageClasses = ***.class)
public class ControllerHandlers(){}
也可以传多个类
@ControllerAdvice(assignableTypes = {***.class,***.class})
public class ControllerHandlers(){}
4、 控制器通知还有一个兄弟,@RestControllerAdvice
,如果用了它,错误处理方法的返回值不会表示用的哪个视图,而是会作为HTTP body处理,即相当于错误处理方法加了@ResponseBody
注解。
@RestControllerAdvice
public class ControllerHandlers(){
@ExceptionHandler
public String errorHandler(Exception e){
return "error";
}
}
5、@ExceptionHandler
注解的方法只能返回一种类型,在前后端分离开发中我们通常返回,统一返回类型和优化错误的提示,我们可以封装我们自己的返回Map
public class AjaxResult extends HashMap<String, Object> {
private static final long serialVersionUID = 1L;
public static final String CODE_TAG = "code";
public static final String MSG_TAG = "msg";
public static final String DATA_TAG = "data";
/**
* 状态类型
*/
public enum Type {
/**
* 成功
*/
SUCCESS(1),
/**
* 警告
*/
WARN(2),
/**
* 错误
*/
ERROR(),
/**无权限*/
UNAUTH(3),
/**未登录、登录超时*/
UNLOGIN(4);
private final int value;
Type(int value) {
this.value = value;
}
public int value() {
return this.value;
}
}
/**
* 状态类型
*/
private Type type;
/**
* 状态码
*/
private int code;
/**
* 返回内容
*/
private String msg;
/**
* 数据对象
*/
private Object data;
/**
* 初始化一个新创建的 AjaxResult 对象,使其表示一个空消息。
*/
public AjaxResult() {
}
/**
* 初始化一个新创建的 AjaxResult 对象
* @param type 状态类型
* @param msg 返回内容
*/
public AjaxResult(Type type, String msg) {
super.put(CODE_TAG, type.value);
super.put(MSG_TAG, msg);
}
/**
* 初始化一个新创建的 AjaxResult 对象
* @param type 状态类型
* @param msg 返回内容
* @param data 数据对象
*/
public