SpringBoot优雅的抛出业务异常

通常在我们的项目中，在参数的校验，执行失败，校验返回值时业如果有业务异常，我们通常是原地进行异常的信息编写和抛出，如果业务异常使用频繁，代码看上去就很很杂乱。我这里提供一种优雅抛出异常的方式

版本信息

springBoot 2.4.2 jdk11

具体步骤

定义一个异常接口

1
/**
2
 * @author lyne
3
 * @date 2022/9/11
4
 */
5
public interface ErrorCode {
6
  /**
7
   * 获取错误信息
8
   * @return msg
9
   */
10
  String getMsg();
11

12
  /**
13
   * 获取错误码
14
   * @return code
15
   */
16
  int getCode();
17

18
}

2.然后根据具体的业务领域创建一个或这多个的实现类，因为异常实体一旦定义，就不轻易修改，所以我推荐使用枚举类继承接口下面随意定义基础异常实体

1
/**
2
 * @author lyne
3
 * @date 2022/9/11
4
 */
5
public enum BaseErrorCode implements ErrorCode {
6
  /**
7
   * 空值错误
8
   */
9
  NULLError(5000, "参数不能为空！");
10

11
  private final int code;
12
  private final String msg;
13

14
  @Override
15
  public String getMsg() {
16
    return this.msg;
17
  }
18

19
  @Override
20
  public int getCode() {
21
    return this.code;
22
  }
23

24
  BaseErrorCode(int code, String msg) {
25
    this.code = code;
26
    this.msg = msg;
27
  }
28

29
}

在定义异常实体后，我们需要定义一个静态方法以便我们快速的使用这里就写了个简单的方法集合，更多的功能还请结合实际需要增补

1
/**
2
 * @author lyne
3
 * @date 2022/9/11
4
 */
5
public class When {
6

7
  public static <T> void emptyReturnError(T t, ErrorCode errorCode) {
8
    if (t == null) nullReturnError(null, errorCode);
9
    if (t instanceof String) {
10
      if (((String) t).length() == 0) {
11
        returnError(errorCode);
12
      }
13
    }
14
    if (t instanceof Collection) {
15
      if (((Collection<?>) t).isEmpty()) {
16
        returnError(errorCode);
17
      }
18
    }
19
  }
20

21
  public static <T> void nullReturnError(T t, ErrorCode errorCode) {
22
    if (t == null) {
23
      returnError(errorCode);
24
    }
25
  }
26

27
  public static void trueReturnError(boolean t, ErrorCode errorCode) {
28
    if (t) {
29
      returnError(errorCode);
30
    }
31
  }
32

33
  public static void falseReturnError(boolean t, ErrorCode errorCode) {
34
    trueReturnError(!t, errorCode);
35
  }
36

37
  public static void returnError(ErrorCode errorCode) {
38
    throw new BaseException(errorCode.getCode(), errorCode.getMsg());
39
  }
40
}

我们可以直接对异常拦截器进行改造以便入参兼容异常枚举类，也可以像本文中所写的那样兼容原有的异常入参处理。

1
@ExceptionHandler(value = BaseException.class)
2
public R<?> baseExceptionHandler(HttpServletRequest request, BaseException e) {
3
  log.error("请求地址：{}; 业务异常：{}", request.getRequestURI(), e.getMessage());
4
  return R.error(e.getMessage());
5
}

统一JSON实体

1
/**
2
 * 前端返回体
3
 * {"success": true, "code", 2000, "msg": "", "obj": null}
4
 *
5
 * @author lyne
6
 * @date 2022/8/18
7
 */
8
@Data
9
public class R<T> implements Serializable {
10

11
  private static final long serialVersionUID = 1L;
12

13
  public static final String DEFAULT_SUCCESS_MESSAGE = "请求成功";
14
  public static final String DEFAULT_ERROR_MESSAGE = "请求失败";
15

16
  private static final int CODE_SUCCESS = 2000;
17
  private static final int CODE_ERROR = 5000;
18

19

20
  /**
21
   * 是否成功
22
   */
23
  private boolean success = true;
24
  /**
25
   * 状态码
26
   */
27
  private int code;
28
  /**
29
   * 返回信息
30
   */
31
  private String msg;
32
  /**
33
   * 返回实体
34
   */
35
  private T obj;
36

37
  public static <T> R<T> error(String msg) {
38
    return error(CODE_ERROR, msg.trim().isEmpty() ? DEFAULT_ERROR_MESSAGE : msg);
39
  }
40

41
  public static <T> R<T> error(int code, String msg) {
42
    return error(code, msg, null);
43
  }
44

45
  public static <T> R<T> error(int code, String msg, T obj) {
46
    return create(code, msg.trim().isEmpty() ? DEFAULT_ERROR_MESSAGE : msg, obj);
47
  }
48

49
  public static <T> R<T> success(String msg) {
50
    return success(CODE_SUCCESS, msg.trim().isEmpty() ? DEFAULT_SUCCESS_MESSAGE : msg);
51
  }
52

53
  public static <T> R<T> success(int code, String msg) {
54
    return success(code, msg, null);
55
  }
56

57
  public static <T> R<T> success(String msg, T obj) {
58
    return success(CODE_SUCCESS, msg, obj);
59
  }
60

61
  public static <T> R<T> success(int code, T obj) {
62
    return success(code, "请求成功", obj);
63
  }
64

65
  public static <T> R<T> success(int code, String msg, T obj) {
66
    return create(code, msg.trim().isEmpty() ? DEFAULT_SUCCESS_MESSAGE : msg, obj);
67
  }
68

69
  private static <T> R<T> create(int code, String msg, T obj){
70
    R<T> ajaxR = new R<>();
71
    ajaxR.code = code;
72
    ajaxR.msg = msg;
73
    ajaxR.obj = obj;
74
    return ajaxR;
75
  }
76
}

到这里就完成了业务异常的改造工作，下面就是具体的使用这里截取了摸鱼君的部分代码

1
/**
2
 * @author lyne
3
 * @date 2022/10/7
4
 */
5
public enum UserErrorCode implements ErrorCode {
6
  PASSWORD_MD5_LENGTH_ERROR(40001, "请使用MD5摘要算法对密码进行加密处理"),
7
  USERNAME_OR_PASSWORD_ERROR(40002, "账号或密码不正确"),
8
  USER_NOT_FOUND_ERROR(40003, "未找到该用户！"),
9
  ADMIN_USER_FORBID_DISABLE(40004, "管理员账户无法禁用"),
10
  USER_EMAIL_MAIL_CODE_ERROR(40004, "邮箱验证码不正确！"),
11

12
  ;
13

14
  private final int code;
15
  private final String msg;
16

17
  UserErrorCode(int code, String msg) {
18
    this.code = code;
19
    this.msg = msg;
20
  }
21

22
  @Override
23
  public String getMsg() {
24
    return this.msg;
25
  }
26

27
  @Override
28
  public int getCode() {
29
    return this.code;
30
  }
31
}

1
  @Override
2
  public R<String> resetPassword(LoginDto userDto) {
3
    // 校验密码长度
4
    When.trueReturnError(userDto.getPassword().length() != 32, UserErrorCode.PASSWORD_MD5_LENGTH_ERROR);
5
    String mailCode = redisService.getCacheObject(Constants.User.KEY_MAIL_CODE + userDto.getEmail());
6
    When.emptyReturnError(mailCode, UserErrorCode.USER_EMAIL_MAIL_CODE_ERROR);
7
    When.trueReturnError(!mailCode.equals(userDto.getVerifyCode()), UserErrorCode.USER_EMAIL_MAIL_CODE_ERROR);
8
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
9
    if (StrUtil.isNotBlank(userDto.getAccountId())) {
10
      queryWrapper.eq(User.T_ID, userDto.getAccountId());
11
    }
12
    if (StrUtil.isNotBlank(userDto.getEmail())) {
13
      queryWrapper.eq(User.T_EMAIL, userDto.getEmail());
14
    }
15
    User sysUser = getById(queryWrapper);
16
    When.nullReturnError(sysUser, UserErrorCode.USER_NOT_FOUND_ERROR);
17
    sysUser.setPassword(bCryptPasswordEncoder.encode(userDto.getPassword()));
18
    updateById(sysUser);
19
    logout();
20
    return R.success("重置密码成功！");
21
  }