前言:
当不同方法执行时,抛出相同异常。为了简约代码和避免重复使用try{}catch{}。此时使用统一异常处理。但局部的统一异常处理只能为所在类所调用。因此产生全局异常处理,该类中统一异常处理方法可以作用于整个controller。(以下以自定义异常类为示例)
创建状态码枚举类,用于自定义异常返回状态:
public enum ServiceCode {
OK(2000),
ERR_BAD_REQUEST(4000),//错误请求
ERR_NOT_FOUND(4040),//没有发现
ERR_UNAUTHORIZED(4010),//未经授权
ERR_UNAUTHORIZED_DISABLED(4011),//未经授权禁止
ERR_FORBIDDEN(4030),//被禁止的
ERR_CONFLICT(4090),//冲突
ERR_INSERT(5000),//插入异常
ERR_DELETE(5010),//删除异常
ERR_UPDATE(5020),//更新异常
ERR_SELECT(5030),//搜索异常
ERR_JWT_EXPIRED(6000),//jwt过期
ERR_JWT_MALFORMED(6010),//jwt格式不对
ERR_JWT_SIGNATURE(6020),//jwl签名错误
ERR_UNKNOWN(9999);//未知错误
private Integer value;
ServiceCode(Integer value) {
this.value = value;
}
public Integer getValue() {
return value;
}
}
自定义异常类:
public class ServiceException extends RuntimeException {
private ServiceCode serviceCode;
public ServiceException(ServiceCode serviceCode, String message) {
super(message);
this.serviceCode = serviceCode;
}
public ServiceCode getServiceCode() {
return serviceCode;
}
}
(重点)全局统一异常处理类:
@RestControllerAdvice //可以将此类中特定方法作用于整个controller
public class GlobalExceptionHandler {
public GlobalExceptionHandler() {
log.debug("创建全局异常处理器对象:GlobalExceptionHandler");
}
@ExceptionHandler//统一异常处理,若只想某个类中单独共同处理,可以直接使用该注解到某个统一异常处理方法中,如下面方法为统一异常处理方法。
public xxx handleServiceException(ServiceException e) {
//ServiceException e是多个方法执行时抛出相同的异常类,在这里进行统一处理
log.warn("程序运行过程中出现ServiceException,将统一处理!");
log.warn("异常信息:{}", e.getMessage());
return ;
}
}
尾语:
只要抛出ServiceException错误时,无论在那个controller类中都能GlobalExceptionHandler捕获处理而不再需要在每个调用有ServiceException异常抛出的方法中进行捕获。