• SpringBoot全局异常配置

    1、实现方式定义一个全局异常配置类，使用@RestControllerAdvice注解

    在使用方法上用
    @ExceptionHandler(value = BizException.class)配合使用，使其异常提示作用

    2、需要定义一个统一结果返回类，如下代码

    1.  
    2. @Data
    3. @Slf4j
    4. @ToString
    5. public class CommonResult<T> {
    6.  
    7.     /**
    8.      * 状态码
    9.      */
    10.     private long code;
    11.     /**
    12.      * 提示信息
    13.      */
    14.     private String message;
    15.     /**
    16.      * 数据封装
    17.      */
    18.     private T data;
    19.  
    20.     protected CommonResult() {
    21.     }
    22.  
    23.     protected CommonResult(long code, String message, T data) {
    24.         this.code = code;
    25.         this.message = message;
    26.         this.data = data;
    27.     }
    28.  
    29.     /**
    30.      * 成功返回结果
    31.      *
    32.      * @param data 获取的数据
    33.      */
    34.     public static <T> CommonResult<T> success(T data) {
    35.         return new CommonResult<T>(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMessage(), data);
    36.     }
    37.  
    38.     /**
    39.      * 成功返回结果
    40.      *
    41.      * @param data 获取的数据
    42.      * @param  message 提示信息
    43.      */
    44.     public static <T> CommonResult<T> success(T data, String message) {
    45.         return new CommonResult<T>(ResultCode.SUCCESS.getCode(), message, data);
    46.     }
    47.  
    48.     /**
    49.      * 失败返回结果
    50.      * @param errorCode 错误码
    51.      */
    52.     public static <T> CommonResult<T> failed(IErrorCode errorCode) {
    53.         return new CommonResult<T>(errorCode.getCode(), errorCode.getMessage(), null);
    54.     }
    55.  
    56.     /**
    57.      * 失败返回结果
    58.      * @param errorCode 错误码
    59.      * @param message 错误信息
    60.      */
    61.     public static <T> CommonResult<T> failed(IErrorCode errorCode,String message) {
    62.         return new CommonResult<T>(errorCode.getCode(), message, null);
    63.     }
    64.  
    65.     /**
    66.      * 失败返回结果
    67.      * @param message 提示信息
    68.      */
    69.     public static <T> CommonResult<T> failed(String message) {
    70.         return new CommonResult<T>(ResultCode.FAILED.getCode(), message, null);
    71.     }
    72.  
    73.     /**
    74.      * 失败返回结果
    75.      */
    76.     public static <T> CommonResult<T> failed() {
    77.         return failed(ResultCode.FAILED);
    78.     }
    79.  
    80.     /**
    81.      * 参数验证失败返回结果
    82.      */
    83.     public static <T> CommonResult<T> validateFailed() {
    84.         return failed(ResultCode.VALIDATE_FAILED);
    85.     }
    86.  
    87.     /**
    88.      * 参数验证失败返回结果
    89.      * @param message 提示信息
    90.      */
    91.     public static <T> CommonResult<T> validateFailed(String message) {
    92.         return new CommonResult<T>(ResultCode.VALIDATE_FAILED.getCode(), message, null);
    93.     }
    94.  
    95.     /**
    96.      * 未登录返回结果
    97.      */
    98.     public static <T> CommonResult<T> unauthorized(T data) {
    99.         return new CommonResult<T>(ResultCode.UNAUTHORIZED.getCode(), ResultCode.UNAUTHORIZED.getMessage(), data);
    100.     }
    101.  
    102.     /**
    103.      * 未授权返回结果
    104.      */
    105.     public static <T> CommonResult<T> forbidden(T data) {
    106.         return new CommonResult<T>(ResultCode.FORBIDDEN.getCode(), ResultCode.FORBIDDEN.getMessage(), data);
    107.     }

    3、需要定义一个统一的错误吗接口，异常枚举类来实现

    1. /**
    2.  * 错误码接口
    3.  */
    4. public interface IErrorCode {
    5.  
    6.     /**
    7.      * 返回码
    8.      */
    9.     long getCode();
    10.  
    11.     /**
    12.      * 返回信息
    13.      */
    14.     String getMessage();
    15. }
    1.  
    2. /**
    3.  * 统一返回结果枚举定义
    4.  */
    5. public enum ResultCode implements IErrorCode {
    6.     SUCCESS(200, "操作成功"),
    7.     FAILED(500, "操作失败"),
    8.     VALIDATE_FAILED(404, "参数检验失败"),
    9.     UNAUTHORIZED(401, "暂未登录或token已经过期"),
    10.     FORBIDDEN(403, "没有相关权限");
    11.     private long code;
    12.     private String message;
    13.  
    14.     private ResultCode(long code, String message) {
    15.         this.code = code;
    16.         this.message = message;
    17.     }
    18.  
    19.     @Override
    20.     public long getCode() {
    21.         return code;
    22.     }
    23.  
    24.     @Override
    25.     public String getMessage() {
    26.         return message;
    27.     }

    4、自定义业务异常，在业务异常时使用抛出，在全局异常里面处理捕获返回给前端

    1.  
    2. /**
    3.  * 自定义业务异常
    4.  */
    5. public class BizException extends  RuntimeException{
    6.  
    7.     private IErrorCode errorCode;
    8.     public BizException(Throwable cause) {
    9.         super(cause);
    10.     }
    11.  
    12.     public BizException(IErrorCode code) {
    13.         super(code.getMessage());
    14.         this.errorCode = code;
    15.     }
    16.     public BizException(String message) {
    17.         super(message);
    18.     }
    19.     public BizException(String message, Throwable cause) {
    20.         super(message, cause);
    21.     }
    22.     public IErrorCode getErrorCode() {
    23.         return errorCode;
    24.     }
    25. }

    5、定义全局异常处理类

    1.  
    2. /**
    3.  * 全局异常处理
    4.  */
    5. @RestControllerAdvice
    6. public class GlobalExceptionHandler {
    7.  
    8.     /**
    9.      * 业务异常
    10.      * @param e
    11.      * @return
    12.      */
    13.     @ExceptionHandler(value = BizException.class)
    14.     public CommonResult handle(BizException e) {
    15.         if (e.getErrorCode() != null) {
    16.             return CommonResult.failed(e.getErrorCode());
    17.         }
    18.         return CommonResult.failed(e.getMessage());
    19.     }
    20.  
    21.     /**
    22.      * 将请求体解析并绑定到 java bean 时，如果出错，则抛出 MethodArgumentNotValidException 异常
    23.      * @param e
    24.      * @return
    25.      */
    26.     @ExceptionHandler(value = MethodArgumentNotValidException.class)
    27.     public CommonResult handleValidException(MethodArgumentNotValidException e) {
    28.         BindingResult bindingResult = e.getBindingResult();
    29.         String message = null;
    30.         if (bindingResult.hasErrors()) {
    31.             FieldError fieldError = bindingResult.getFieldError();
    32.             if (fieldError != null) {
    33.                 message = fieldError.getField()+fieldError.getDefaultMessage();
    34.             }
    35.         }
    36.         return CommonResult.validateFailed(message);
    37.     }
    38.  
    39.  
    40.     /**
    41.      * 表单绑定到 java bean 出错时，绑定参数校验异常
    42.      * @param e
    43.      * @return
    44.      */
    45.     @ExceptionHandler(value = BindException.class)
    46.     public CommonResult handleValidException(BindException e) {
    47.         BindingResult bindingResult = e.getBindingResult();
    48.         String message = null;
    49.         if (bindingResult.hasErrors()) {
    50.             FieldError fieldError = bindingResult.getFieldError();
    51.             if (fieldError != null) {
    52.                 message = fieldError.getField()+fieldError.getDefaultMessage();
    53.             }
    54.         }
    55.         return CommonResult.validateFailed(message);
    56.     }
    57.  
    58.     @ExceptionHandler(value = SQLSyntaxErrorException.class)
    59.     public CommonResult handleSQLSyntaxErrorException(SQLSyntaxErrorException e) {
    60.         String message = e.getMessage();
    61.         if (StrUtil.isNotEmpty(message) && message.contains("denied")) {
    62.             message = "演示环境暂无修改权限，如需修改数据可本地搭建后台服务！";
    63.         }
    64.         return CommonResult.failed(message);
    65.     }
    66.  
    67.     /**
    68.      * 必填校验参数缺失错误
    69.      * @param e
    70.      * @return
    71.      */
    72.     @ExceptionHandler(value = MissingServletRequestParameterException.class)
    73.     public CommonResult handleMissingServletException(MissingServletRequestParameterException e) {
    74.         String message = e.getMessage();
    75.         if (StrUtil.isNotEmpty(message)) {
    76.             return CommonResult.validateFailed(message);
    77.         }
    78.         return CommonResult.validateFailed(message);
    79.     }
    80.  
    81. }

    断言设置，可以在抛出异常时使代码更简洁清晰，其中加了一些true、false的判断

    作用等同于throw new BizException(“msg”);

    1. package com.example.common.util;
    2.  
    3. import cn.hutool.core.collection.CollUtil;
    4. import cn.hutool.core.map.MapUtil;
    5. import cn.hutool.core.util.ObjectUtil;
    6. import cn.hutool.core.util.StrUtil;
    7. import com.example.common.api.IErrorCode;
    8. import com.example.common.exception.BizException;
    9. import lombok.NoArgsConstructor;
    10.  
    11. import java.util.Collection;
    12. import java.util.Map;
    13. import java.util.Objects;
    14.  
    15. /**
    16.  * 断言
    17.  */
    18. @NoArgsConstructor
    19. public class BizAssert {
    20.  
    21.     public static void equals(IErrorCode errorEnum, Object obj1, Object obj2, Object... params) {
    22.         if (!Objects.equals(obj1, obj2)) {
    23.             failure(errorEnum, params);
    24.         }
    25.     }
    26.  
    27.     public static void isTrue(IErrorCode errorEnum, boolean condition, Object... params) {
    28.         if (!condition) {
    29.             failure(errorEnum, params);
    30.         }
    31.     }
    32.  
    33.     public static void isFalse(IErrorCode errorEnum, boolean condition, Object... params) {
    34.         if (condition) {
    35.             failure(errorEnum, params);
    36.         }
    37.     }
    38.  
    39.     public static void isNull(IErrorCode errorEnum, Object condition, Object... params) {
    40.         if (ObjectUtil.isNotNull(condition)) {
    41.             failure(errorEnum, params);
    42.         }
    43.     }
    44.  
    45.     public static void notNull(IErrorCode errorEnum, Object condition, Object... params) {
    46.         if (ObjectUtil.isNull(condition)) {
    47.             failure(errorEnum, params);
    48.         }
    49.     }
    50.  
    51.     public static void equals(String message, Object obj1, Object obj2, Object... params) {
    52.         if (!Objects.equals(obj1, obj2)) {
    53.             failure(message, params);
    54.         }
    55.     }
    56.  
    57.     public static void isTrue(String message, boolean condition, Object... params) {
    58.         if (!condition) {
    59.             failure(message, params);
    60.         }
    61.     }
    62.  
    63.     public static void isFalse(String message, boolean condition, Object... params) {
    64.         if (condition) {
    65.             failure(message, params);
    66.         }
    67.     }
    68.  
    69.     public static void isNull(String message, Object condition, Object... params) {
    70.         if (ObjectUtil.isNotNull(condition)) {
    71.             failure(message, params);
    72.         }
    73.     }
    74.  
    75.     public static void notNull(String message, Object condition, Object... params) {
    76.         if (ObjectUtil.isNull(condition)) {
    77.             failure(message, params);
    78.         }
    79.     }
    80.  
    81.     /**
    82.      * 
    83.      * 失败结果
    84.      * 
    85.      * @param errorCode 异常错误码
    86.      */
    87.     public static void failure(IErrorCode errorCode, Object... params) {
    88.         failure(errorCode.getMessage(),params);
    89.     }
    90.  
    91.     /**
    92.      * 失败
    93.      * @param message
    94.      * @param params
    95.      */
    96.     public static void failure(String message, Object... params) {
    97.         throw new BizException(StrUtil.format(message, params));
    98.     }
    99.  
    100.     /**
    101.      * 数组为空通过msg
    102.      * @param message
    103.      * @param array
    104.      * @param params
    105.      */
    106.     public static void notEmpty(String message, Object[] array, Object... params) {
    107.         if (ObjectUtil.isEmpty(array)) {
    108.             failure(message, params);
    109.         }
    110.     }
    111.     /**
    112.      * 数组为空通过errorCode
    113.      * @param errorCode
    114.      * @param array
    115.      * @param params
    116.      */
    117.     public static void notEmpty(IErrorCode errorCode, Object[] array, Object... params) {
    118.         if (ObjectUtil.isEmpty(array)) {
    119.             failure(errorCode, params);
    120.         }
    121.     }
    122.  
    123.     /**
    124.      * 集合为空
    125.      * @param errorEnum
    126.      * @param collection
    127.      * @param params
    128.      */
    129.     public static void notEmpty(IErrorCode errorEnum, Collection collection, Object... params) {
    130.         if (CollUtil.isEmpty(collection)) {
    131.             failure(errorEnum, params);
    132.         }
    133.     }
    134.  
    135.     /**
    136.      * map为空
    137.      * @param errorEnum
    138.      * @param map
    139.      * @param params
    140.      */
    141.     public static void notEmpty(IErrorCode errorEnum, Map map, Object... params) {
    142.         if (MapUtil.isEmpty(map)) {
    143.             failure(errorEnum, params);
    144.         }
    145.     }
    146.  
    147.     /**集合不能为空
    148.      * @param errorEnum
    149.      * @param collection
    150.      * @param params
    151.      */
    152.     public static void isEmpty(IErrorCode errorEnum, Collection collection, Object... params) {
    153.         if (CollUtil.isNotEmpty(collection)) {
    154.             failure(errorEnum, params);
    155.         }
    156.     }
    157.  
    158.     /**
    159.      * map不为空
    160.      * @param errorEnum
    161.      * @param map
    162.      * @param params
    163.      */
    164.     public static void isEmpty(IErrorCode errorEnum, Map map, Object... params) {
    165.         if (MapUtil.isNotEmpty(map)) {
    166.             failure(errorEnum, params);
    167.         }
    168.     }
    169.  
    170.  
    171.     public static void notEmpty(String message, Collection collection, Object... params) {
    172.         if (CollUtil.isEmpty(collection)) {
    173.             failure(message, params);
    174.         }
    175.     }
    176.  
    177.     public static void notEmpty(String message, Map map, Object... params) {
    178.         if (MapUtil.isEmpty(map)) {
    179.             failure(message, params);
    180.         }
    181.     }
    182.  
    183.     public static void isEmpty(String message, Collection collection, Object... params) {
    184.         if (CollUtil.isNotEmpty(collection)) {
    185.             failure(message, params);
    186.         }
    187.     }
    188.  
    189.     public static void isEmpty(String message, Map map, Object... params) {
    190.         if (MapUtil.isNotEmpty(map)) {
    191.             failure(message, params);
    192.         }
    193.     }
    194.  
    195.  
    196. }

  • 相关阅读:
    如何做bug分析 ？bug分析什么 ？ 为什么要做bug分析 ？
    【LeetCode热题100】--102.二叉树的层序遍历
    【编程题】【Scratch三级】2021.03 加法出题机
    成员变量、静态成员变量、局部变量、常量的内存区域
    QPlainTextEdit等 自制 文本或者代码 编辑器控件 是如何 自定义 实现的？
    计算机网络八股
    码蹄集 - MT2140 - 双端队列
    （57、58）性能分析命令2
    Android 12(S) 图像显示系统 - SurfaceFlinger 之 VSync - 中篇（十七）
    MFC 鼠标悬停提示框
  • 原文地址：https://blog.csdn.net/qq_31450641/article/details/133947452