SpringBoot全局异常统一处理

小咪咪 2023-07-18 02:39 67阅读 0赞

目标:

对运行时发生的异常进行统一处理

处理自定义异常

  1. Validator统一异常封装

Assert的异常统一封装

一:定义异常统一返回的格式规范:

  1. import com.techsun.industry.common.enums.ResultCode;
  2. import lombok.AllArgsConstructor;
  3. import lombok.Builder;
  4. import lombok.Data;
  5. import lombok.NoArgsConstructor;
  6. import org.apache.commons.lang3.StringUtils;
  8. @Builder
  9. @AllArgsConstructor
  10. @NoArgsConstructor
  11. @Data
  12. public class ErrorResult {
  14.     /**
  15.      * 异常状态码
  16.      */
  17.     private Integer status;
  19.     /**
  20.      * 用户看得见的异常，例如 用户名重复！！,
  21.      */
  22.     private String message;
  24.     /**
  25.      * 异常的名字
  26.      */
  27.     private String exception;
  29.     /**
  30.      * 异常堆栈信息
  31.      */
  32.     //private String errors;
  34.     /**
  35.      * 对异常提示语进行封装
  36.      */
  37.     public static ErrorResult fail(ResultCode resultCode, Throwable e, String message) {
  38.         ErrorResult result = ErrorResult.fail(resultCode, e);
  39.         if(StringUtils.isNotBlank(message)){
  40.             result.setMessage(message);
  41.         }
  42.         return result;
  43.     }
  45.     /**
  46.      * 对异常枚举进行封装
  47.      */
  48.     public static ErrorResult fail(ResultCode resultCode, Throwable e) {
  50.         ErrorResult result = new ErrorResult();
  51.         result.setMessage(resultCode.message());
  52.         result.setStatus(resultCode.code());
  53.         result.setException(e.getClass().getName());
  54.         //result.setErrors(Throwables.getStackTraceAsString(e));
  55.         return result;
  56.     }
  57. }

二:自定义异常用来处理业务逻辑中的异常情况

  1. import com.techsun.industry.common.enums.ResultCode;
  2. import lombok.Data;
  4. /**
  5.  * 自定义异常
  6.  */
  7. @Data
  8. public class BusinessException extends RuntimeException{
  10.     public Integer code;
  12.     public String message;
  15.     public BusinessException(ResultCode resultCode) {
  16.         this.code = resultCode.code();
  17.         this.message = resultCode.message();
  18.     }
  21. }

三:编写全局异常处理类

  1. package com.*.*.config.aspect;
  2. import com.techsun.industry.common.base.response.ErrorResult;
  3. import com.techsun.industry.common.enums.ResultCode;
  4. import com.techsun.industry.common.exception.BusinessException;
  5. import lombok.extern.slf4j.Slf4j;
  6. import org.springframework.http.HttpStatus;
  7. import org.springframework.validation.FieldError;
  8. import org.springframework.web.bind.MethodArgumentNotValidException;
  9. import org.springframework.web.bind.annotation.*;
  11. import javax.servlet.http.HttpServletRequest;
  12. import java.util.List;
  13. @RestControllerAdvice
  14. @Slf4j
  15. /**
  16.  * 全局异常处理
  17.  */
  18. public class GlobalExceptionHandler {
  21.     /**
  22.      * 处理运行时异常
  23.      */
  24.     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
  25.     @ExceptionHandler(Throwable.class)
  26.     public ErrorResult handleThrowable(Throwable e, HttpServletRequest request) {
  27.         //TODO 运行时异常，可以在这里记录，用于发异常邮件通知
  28.         ErrorResult error =ErrorResult.fail(ResultCode.SYSTEM_ERROR, e);
  29.         log.error("URL:{} ,系统异常: ",request.getRequestURI(), e);
  30.         return error;
  31.     }
  33.     /**
  34.      * 处理自定义异常
  35.      */
  36.     @ExceptionHandler(BusinessException.class)
  37.     public ErrorResult handleBusinessException(BusinessException e, HttpServletRequest request) {
  38.         ErrorResult error = ErrorResult.builder().status(e.code)
  39.                 .message(e.message)
  40.                 .exception(e.getClass().getName())
  41.                 .build();
  42.         log.warn("URL:{} ,业务异常:{}", request.getRequestURI(),error);
  43.         return error;
  44.     }
  46.     /**
  47.      * validator 统一异常封装
  48.      */
  49.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  50.     @ExceptionHandler(MethodArgumentNotValidException.class)
  51.     public ErrorResult handleMethodArgumentNotValidException(MethodArgumentNotValidException e, HttpServletRequest request) {
  52.         String msgs = this.handle(e.getBindingResult().getFieldErrors());
  53.         ErrorResult error = ErrorResult.fail(ResultCode.PARAM_IS_INVALID, e,  msgs);
  54.         log.warn("URL:{} ,参数校验异常:{}", request.getRequestURI(),msgs);
  55.         return error;
  56.     }
  58.     private String handle(List<FieldError> fieldErrors) {
  59.         StringBuilder sb = new StringBuilder();
  60.         for (FieldError obj : fieldErrors) {
  61.             sb.append(obj.getField());
  62.             sb.append("=[");
  63.             sb.append(obj.getDefaultMessage());
  64.             sb.append("]  ");
  65.         }
  66.         return sb.toString();
  67.     }
  69.     /**
  70.      * Assert的异常统一封装
  71.      */
  72.     @ExceptionHandler(IllegalArgumentException.class)
  73.     public ErrorResult illegalArgumentException(IllegalArgumentException e, HttpServletRequest request) {
  74.         ErrorResult error = ErrorResult.builder().status(4000)
  75.                 .message(e.getMessage())
  76.                 .exception(e.getClass().getName())
  77.                 .build();
  78.         log.warn("URL:{} ,业务校验异常:{}", request.getRequestURI(),e);
  79.         return error;
  80.     }
  82. }

对应ResultCode枚举类：

  1. public enum ResultCode {
  3.     /* 成功状态码 */
  4.     SUCCESS(200, "成功"),
  6.     /* 系统500错误*/
  7.     SYSTEM_ERROR(10000, "系统异常，请稍后重试"),
  10.     /* 参数错误：10001-19999 */
  11.     PARAM_IS_INVALID(10001, "参数无效"),
  14.     /* 用户错误：20001-29999*/
  15.     USER_HAS_EXISTED(20001, "用户已存在"),
  16.     USER_LOGIN_FAIL(20002,"账号或密码错误"),
  17.     USER_HAS_EXIST(20003,"账号已存在"),
  18.     USER_NOT_EXIST(20003,"用户不存在，请重新登录"),
  20.     /* 认证失败错误：30001-39999*/
  21.     NO_TOKEN(30001,"无token，请重新登录"),
  22.     TOKEN_OUT_TIME(30002,"token超时,请重新登录"),
  23.     TOKEN_ILLEGAL(30003,"token 认证失败"),
  25.     /* 文件失败错误：40001-49999*/
  26.     EXCEL_NO_SHEET(40001,"Excel无Sheet");
  29.     private Integer code;
  31.     private String message;
  33.     ResultCode(Integer code, String message) {
  34.         this.code = code;
  35.         this.message = message;
  36.     }
  38.     public Integer code() {
  39.         return this.code;
  40.     }
  42.     public String message() {
  43.         return this.message;
  44.     }
  46.     public static String getMessage(String name) {
  47.         for (ResultCode item : ResultCode.values()) {
  48.             if (item.name().equals(name)) {
  49.                 return item.message;
  50.             }
  51.         }
  52.         return name;
  53.     }
  55.     public static Integer getCode(String name) {
  56.         for (ResultCode item : ResultCode.values()) {
  57.             if (item.name().equals(name)) {
  58.                 return item.code;
  59.             }
  60.         }
  61.         return null;
  62.     }
  64.     @Override
  65.     public String toString() {
  66.         return this.name();
  67.     }
  68. }

可根据实际情况将Code状态码进行划分。

我们可以参考下Http请求返回的状态码：

  1. 下面是常见的HTTP状态码：
  2. 200 - 请求成功
  3. 301 - 资源（网页等）被永久转移到其它URL
  4. 404 - 请求的资源（网页等）不存在
  5. 500 - 内部服务器错误

watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0h1SGFvX0NTRE4_size_16_color_FFFFFF_t_70

我们可以参考这样的设计，这样的好处就把错误类型归类到某个区间内，如果区间不够，可以设计成4位数。

  1. #1000～1999 区间表示参数错误
  2. #2000～2999 区间表示用户错误
  3. #3000～3999 区间表示接口异常

这样前端开发人员在得到返回值后，根据状态码就可以知道，大概什么错误，再根据message相关的信息描述，可以快速定位。

现在可以进行测试了.

发表评论

表情：
评论列表 （有 0 条评论，67人围观）

还没有评论，来说两句吧...

相关阅读

    相关 springboot中异常全局统一处理

    [个人博客][Link 1] 日常后端业务开发中，在提供接口服务时会遇到各种异常处理，通常涉及到参数校验异常、自定义异常以及一些不可预知的异常等等。下面就来说一下在sprin

    亦凉亦凉/ 0 赞/ 381 阅读