- 1 项目异常分类
- 2 项目异常处理方案
- 3 项目异常处理代码实现
- 3.1 根据异常分类自定义异常类
- 3.1.1 自定义项目系统级异常
- 3.2 自定义异常编码（持续补充）
- 3.3 触发自定义异常
- 3.4 在异常通知类中拦截并处理异常
- 【举例】
- 全局异常处理器
- 【方式一】在Controller方法中加入 try...catch 进行异常捕获
- 【方式二】使用异常处理器进行全局异常捕获
-
1 项目异常分类
- 业务异常（BusinessException）
- 规范的用户行为产生的异常
- 不规范的用户行为操作产生的异常
- 系统异常（SystemException）
- 项目运行过程中可预计且无法避免的异常
- 其他异常（Exception）
- 编程人员未预期到的异常
- 业务异常（BusinessException）
- 发送对应消息传递给用户，提醒规范操作
- 系统异常（SystemException）
- 发送固定消息传递给用户，安抚用户
- 发送特定消息给运维人员，提醒维护
- 记录日志
- 其他异常（Exception）
- 发送固定消息传递给用户，安抚用户
- 发送特定消息给编程人员，提醒维护（纳入预期范围内）
- 记录日志
//自定义异常处理器，用于封装异常信息，对异常进行分类
public class SystemException extends RuntimeException{
private Integer code;
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public SystemException(Integer code, String message) {
super(message);
this.code = code;
}
public SystemException(Integer code, String message, Throwable cause) {
super(message, cause);
this.code = code;
}
}
3.2 自定义异常编码（持续补充）
public class Code {
//之前其他状态码省略没写，以下是新补充的状态码，可以根据需要自己补充
public static final Integer SYSTEM_ERR = 50001;
public static final Integer SYSTEM_TIMEOUT_ERR = 50002;
public static final Integer SYSTEM_UNKNOW_ERR = 59999;
public static final Integer BUSINESS_ERR = 60002;
}
3.3 触发自定义异常
@Service
public class BookServiceImpl implements BookService {
@Autowired
private BookDao bookDao;
//在getById演示触发异常，其他方法省略没有写进来
public Book getById(Integer id) {
//模拟业务异常，包装成自定义异常
if(id <0){
throw new BusinessException(Code.BUSINESS_ERR,"好了我知道你很nb!");
}
}
}
3.4 在异常通知类中拦截并处理异常
@RestControllerAdvice //用于标识当前类为REST风格对应的异常处理器
public class ProjectExceptionAdvice {
//@ExceptionHandler用于设置当前处理器类对应的异常类型
@ExceptionHandler(SystemException.class)
public Result doSystemException(SystemException ex){
//记录日志
//发送消息给运维
//发送邮件给开发人员,ex对象发送给开发人员
return new Result(ex.getCode(),null,ex.getMessage());
}
@ExceptionHandler(BusinessException.class)
public Result doBusinessException(BusinessException ex){
return new Result(ex.getCode(),null,ex.getMessage());
}
//除了自定义的异常处理器，保留对Exception类型的异常处理，用于处理非预期的异常
@ExceptionHandler(Exception.class)
public Result doOtherException(Exception ex){
//记录日志
//发送消息给运维
//发送邮件给开发人员,ex对象发送给开发人员
return new Result(Code.SYSTEM_UNKNOW_ERR,null,"系统繁忙，请稍后再试！");
}
}
【举例】
通用返回结果，服务端响应的数据最终都会封装成此对象
@Data public class Rimplements Serializable { private Integer code; //编码：1成功，0和其它数字为失败 private String msg; //错误信息 private T data; //数据 private Map map = new HashMap(); //动态数据 public static R success(T object){ R r = new R (); r.data = object; r.code = 1; return r; } public static R error(String msg){ R r = new R(); r.msg = msg; r.code = 0; return r; } public R add(String key, Object value) { this.map.put(key, value); return this; } }
全局异常处理器
在项目中自定义一个全局异常处理器，在异常处理器上加上注解 @ControllerAdvice,可以通过属性annotations指定拦截哪一类的Controller方法。 并在异常处理器的方法上加上注解 @ExceptionHandler 来指定拦截的是那一类型的异常。
【方式一】在Controller方法中加入 try…catch 进行异常捕获异常处理方法逻辑:
- 指定捕获的异常类型为 SQLIntegrityConstraintViolationException
- 解析异常的提示信息, 获取出是那个值违背了唯一约束
- 组装错误信息并返回
形式如下（示例）：
try {
} catch (Exception e){
e.printStackTrace();
return R.error("信息错误");
}
如果采用这种方式，虽然可以解决，但是存在弊端，需要我们在保存其他业务数据时，也需要在Controller方法中加上try…catch进行处理，代码冗余，不通用。
【方式二】使用异常处理器进行全局异常捕获在项目中自定义一个全局异常处理器，在异常处理器上加上注解 @ControllerAdvice,可以通过属性annotations指定拦截哪一类的Controller方法。 并在异常处理器的方法上加上注解 @ExceptionHandler 来指定拦截的是那一类型的异常。
自定义异常
public class BusinessException extends RuntimeException {
public BusinessException(String message){
super(message);
}
}
@Slf4j
@ResponseBody //该类返回的数据全部都会转换为json字符串
@ControllerAdvice(annotations = {Controller.class, RestController.class}) // 表示该类是一个异常处理类
public class GlobalExceptionHandler {
// 只处理 BusinessException 异常
@ExceptionHandler(value = BusinessException.class)
public R handlerBusinessException(Exception ex){
// 打印异常信息
ex.printStackTrace();
// 记录日志
log.warn(ex.getMessage());
// 生成响应
return R.error(ex.getMessage());
}
//@ExceptionHandler(value = Exception.class) 代表了该方法会处理所有的异常， 只要controller那边出现了异常都会给方法方法处理
@ExceptionHandler(value = Exception.class)
public R handlerException(Exception e){ //一旦controller出现了异常会把异常对象传递给形参
log.info("========异常处理======");
e.printStackTrace();
return R.error("服务器异常:"+e.getMessage());
}
}
注解说明:
- 上述的全局异常处理器上使用了的两个注解:
- @ControllerAdvice : 指定拦截那些类型的控制器;
- @ResponseBody: 将方法的返回值 R 对象转换为json格式的数据, 响应给页面;
- 上述使用的两个注解, 也可以合并成为一个注解 @RestControllerAdvice
