前言
软件开发springboot项目过程中，不可避免的需要处理各种异常,spring mvc 架构中各层会出现大量的try {...} catch {...} finally {...}代码块，不仅有大量的冗余代码，而且还影响代码的可读性。这样就需要定义个全局统一异常处理器，以便业务层再也不必处理异常。推荐理由
- 代码复制到项目中通过简单的配置即可实现
- 可以灵活的根据自己的业务异常进行更细粒度的扩展
实践
1 封装统一返回结果类
实现代码：
publicclassAjaxResult {
//是否成功
private Boolean success;
//状态码
private Integer code;
//提示信息
private String msg;
//数据
private Object data;
publicAjaxResult() {
}
//自定义返回结果的构造方法
publicAjaxResult(Boolean success,Integer code, String msg,Object data) {
this.success = success;
this.code = code;
this.msg = msg;
this.data = data;
}
//自定义异常返回的结果
publicstatic AjaxResult defineError(BusinessException de){
AjaxResult result = new AjaxResult();
result.setSuccess(false);
result.setCode(de.getErrorCode());
result.setMsg(de.getErrorMsg());
result.setData(null);
return result;
}
//其他异常处理方法返回的结果
publicstatic AjaxResult otherError(ErrorEnum errorEnum){
AjaxResult result = new AjaxResult();
result.setMsg(errorEnum.getErrorMsg());
result.setCode(errorEnum.getErrorCode());
result.setSuccess(false);
result.setData(null);
return result;
}
// 省略getter/setter方法
}
2 自定义异常封装类
实现源码：
publicclassBusinessExceptionextendsRuntimeException {
privatestaticfinallong serialVersionUID = 1L;
/**
* 错误状态码
*/
protected Integer errorCode;
/**
* 错误提示
*/
protected String errorMsg;
publicBusinessException(){}
publicBusinessException(Integer errorCode, String errorMsg) {
this.errorCode = errorCode;
this.errorMsg = errorMsg;
}
public Integer getErrorCode() {
return errorCode;
}
publicvoidsetErrorCode(Integer errorCode) {
this.errorCode = errorCode;
}
public String getErrorMsg() {
return errorMsg;
}
publicvoidsetErrorMsg(String errorMsg) {
this.errorMsg = errorMsg;
}
}
3 错误枚举，拒绝硬编码
publicenum ErrorEnum {
// 数据操作错误定义
SUCCESS(200, "成功"),
NO_PERMISSION(403,"你没得权限"),
NO_AUTH(401,"未登录"),
NOT_FOUND(404, "未找到该资源!"),
INTERNAL_SERVER_ERROR(500, "服务器异常请联系管理员"),
;
/** 错误码 */
private Integer errorCode;
/** 错误信息 */
private String errorMsg;
ErrorEnum(Integer errorCode, String errorMsg) {
this.errorCode = errorCode;
this.errorMsg = errorMsg;
}
public Integer getErrorCode() {
return errorCode;
}
public String getErrorMsg() {
return errorMsg;
}
}
4 全局异常处理类
/**
* 全局异常处理器
*
*/
@RestControllerAdvice
publicclassGlobalExceptionHandler{
privatestaticfinal Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
/**
* 处理自定义异常
*
*/
@ExceptionHandler(value = BusinessException.class)
publicAjaxResultbizExceptionHandler(BusinessExceptione) {
log.error(e.getMessage(), e);
return AjaxResult.defineError(e);
}
/**
*处理其他异常
*
*/
@ExceptionHandler(value = Exception.class)
publicAjaxResultexceptionHandler( Exceptione) {
log.error(e.getMessage(), e);
return AjaxResult.otherError(ErrorEnum.INTERNAL_SERVER_ERROR);
}
}
