一、什么是统一异常处理
项目对外的接口要一致,异常输出格式也要一致。我们想让异常结果也显示为统一的返回结果对象,并且统一处理系统的异常信息,那么需要统一异常处理
二、统一异常处理
1、创建统一异常处理器
guli-framework-common中的com.guli.common.handler包中,
创建统一异常处理类GlobalExceptionHandler.java:
package com.guli.common.handler;
/**
* 统一异常处理类
*/
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
@ResponseBody
public R error(Exception e){
e.printStackTrace();
return R.error();
}
}
2、扫描异常处理器
确认EduApplication.java上添加了注解@ComponentScan
@SpringBootApplication
@ComponentScan(basePackages={"com.guli.edu","com.guli.common"})
public class EduApplication {
3、测试
返回统一错误结果
三、处理特定异常
1、添加异常处理方法
GlobalExceptionHandler.java中添加
@ExceptionHandler(BadSqlGrammarException.class)
@ResponseBody
public R error(BadSqlGrammarException e){
e.printStackTrace();
return R.setResult(ResultCodeEnum.BAD_SQL_GRAMMAR);
}
2、测试
3、恢复制造的异常
@TableField(value = "is_deleted")
private Boolean deleted;
四、另一个例子
1、制造异常
在swagger中测试新增讲师方法,输入非法的json参数,得到
HttpMessageNotReadableException
2、添加异常处理方法
GlobalExceptionHandler.java中添加
@ExceptionHandler(HttpMessageNotReadableException.class)
@ResponseBody
public R error(JsonParseException e){
e.printStackTrace();
return R.setResult(ResultCodeEnum.JSON_PARSE_ERROR);
}
3、测试
五、自定义异常
1、创建自定义异常类
common模块中创建com.guli.common.exception包,
创建GuliException.java通用异常类 继承 RuntimeException
RuntimeException 对代码没有侵入性
package com.guli.common.exception;
@Data
@ApiModel(value = "全局异常")
public class GuliException extends RuntimeException {
@ApiModelProperty(value = "状态码")
private Integer code;
/**
* 接受状态码和消息
* @param code
* @param message
*/
public GuliException(Integer code, String message) {
super(message);
this.code=code;
}
/**
* 接收枚举类型
* @param resultCodeEnum
*/
public GuliException(ResultCodeEnum resultCodeEnum) {
super(resultCodeEnum.getMessage());
this.code = resultCodeEnum.getCode();
}
}
2、业务中需要的位置抛出GuliException
讲师controller中分页查询方法中判断参数是否合法
public R pageQuery(......){
if(page <= 0 || limit <= 0){
//throw new GuliException(21003, "参数不正确1");
throw new GuliException(ResultCodeEnum.PARAM_ERROR);
}
......
}
3、添加异常处理方法
GlobalExceptionHandler.java中添加
@ExceptionHandler(GuliException.class)
@ResponseBody
public R error(GuliException e){
e.printStackTrace();
return R.error().message(e.getMessage()).code(e.getCode());
}