封装全局异常处理

目录

• 1 定义错误码类
  
• 2 定义业务异常类
  
• 3 全局异常处理器
  
• 4 使用
  
• 5 前端请求效果
  
• 总结
  

1 定义错误码类

​        可以定义各种错误码枚举，比如业务，系统相关的报错信息

1. /**
2. * 错误代码
3. * 错误码
4. *
5. * @author leovany
6. * @date 2023/09/23
7. */
8. public enum ErrorCode {
9.     SUCCESS(0, "success", ""),
10.     ERROR_PARAMS(40000, "请求参数错误", ""),
11.     ERROR_NULL(40001, "请求数据为空", ""),
12.     ERROR_LOGIN(40100, "未登录", ""),
13.     ERROR_NO_AUTH(41001, "无权限", ""),
14.     ERROR_SYSTEM(50000, "系统内部异常", "")
15.     ;
18.     /**
19.      * 错误码ID
20.      */
21.     private final int code;
23.     /**
24.      * 错误码信息
25.      */
26.     private final String message;
28.     /**
29.      * 错误码描述（详情）
30.      */
31.     private final String description;
33.     ErrorCode(int code, String message, String description) {
34.         this.code = code;
35.         this.message = message;
36.         this.description = description;
37.     }
39.     public int getCode() {
40.         return code;
41.     }
43.     public String getMessage() {
44.         return message;
45.     }
47.     public String getDescription() {
48.         return description;
49.     }
50. }

复制代码

2 定义业务异常类

• 相对于 java 的异常类，支持更多字段
  扩展了 code和description两个字段
  
• 自定义构造函数，更灵活 / 快捷的设置字段
  

1. import com.leovany.usercenter.common.ErrorCode;
3. /**
4. * 业务异常
5. * 自定义业务异常类
6. *
7. * @author leovany
8. * @date 2023/09/23
9. */
10. public class BusinessException extends RuntimeException {
12.     /**
13.      * 错误码
14.      */
15.     private final int code;
17.     /**
18.      * 描述
19.      */
20.     private final String description;
22.     /**
23.      * 业务异常
24.      *
25.      * @param message     信息
26.      * @param code        错误码
27.      * @param description 描述
28.      */
29.     public BusinessException(String message, int code, String description) {
30.         super(message);
31.         this.code = code;
32.         this.description = description;
33.     }
35.     /**
36.      * 业务异常
37.      *
38.      * @param errorCode 错误代码
39.      */
40.     public BusinessException(ErrorCode errorCode) {
41.         super(errorCode.getMessage());
42.         this.code = errorCode.getCode();
43.         this.description = errorCode.getDescription();
44.     }
46.     /**
47.      * 业务异常
48.      *
49.      * @param errorCode   错误代码
50.      * @param description 描述
51.      */
52.     public BusinessException(ErrorCode errorCode, String description) {
53.         super(errorCode.getMessage());
54.         this.code = errorCode.getCode();
55.         this.description = description;
56.     }
58.     public int getCode() {
59.         return code;
60.     }
62.     public String getDescription() {
63.         return description;
64.     }
65. }

复制代码

3 全局异常处理器

• 通过Spring AOP实现，在调用方法前后进行额外的处理
  
• 作用
  
  
  
  • 捕获代码中所有的异常，让前端得到更详细的业务报错信息
    
  • 屏蔽掉项目框架本身的异常，不暴露服务器的内部状态
    
  • 集中处理，比如还可以做记录日志
    
  
  

1. import com.leovany.usercenter.common.ResultVO;
2. import com.leovany.usercenter.common.ErrorCode;
3. import com.leovany.usercenter.common.ResultUtils;
4. import lombok.extern.slf4j.Slf4j;
5. import org.springframework.web.bind.annotation.ExceptionHandler;
6. import org.springframework.web.bind.annotation.RestControllerAdvice;
8. /**
9. * 全局异常处理类
10. */
11. @RestControllerAdvice
12. @Slf4j
13. public class GlobalExceptionHandler {
15.     /**
16.      * 处理异常-BusinessException
17.      * @param e
18.      * @return
19.      */
20.     @ExceptionHandler(BusinessException.class)
21.     public ResultVO<?> businessExceptionHandler(BusinessException e){
22.         log.error("businessException:" + e.getMessage(),e);
23.         return ResultUtils.error(e.getCode(),e.getMessage(),e.getDescription());
24.     }
26.     /**
27.      * 处理异常-RuntimeException
28.      * @param e
29.      * @return
30.      */
31.     @ExceptionHandler(RuntimeException.class)
32.     public ResultVO<?> runtimeExceptionHandler(RuntimeException e){
33.         log.error("runtimeException:" + e);
34.         return ResultUtils.error(ErrorCode.ERROR_SYSTEM,e.getMessage());
35.     }
36. }

复制代码

4 使用

​        throw new BusinessException可以在方法中，任意地方抛出，很方便

• 示例代码
  

1. @PostMapping("/login")
2. public ResultVO<User> userLogin(@RequestBody UserLoginRequest userLoginRequest, HttpServletRequest request) {
4.     String userAccount = userLoginRequest.getUserAccount();
5.     String userPassword = userLoginRequest.getUserPassword();
7.     if (StringUtils.isAnyBlank(userAccount, userPassword)) {
8.         throw new BusinessException(ErrorCode.ERROR_PARAMS);
9.     }
10.     User user = userService.doLogin(userAccount, userPassword, request);
11.     return ResultUtils.success(user);
12. }

复制代码

• 代码对比
  

5 前端请求效果


总结

​        通过封装全局异常处理，对异常信息做了统一处理，让前端得到更详细的业务信息，同时保证系统的安全性（不会暴露系统内部信息），在代码上对参数校验等方面提供更加方便的形式。

本文由博客一文多发平台 OpenWrite 发布！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！