SpringMvc，Springboot统一校验、自定义异常、全局异常处理

青旅半醒 2022-08-31 15:13 357阅读 0赞

引入jar包

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-validation</artifactId>
  4. </dependency>

写一个DTO用来接收客户端传送的参数

  1. @Data
  2. public class AuditListDto { 
  3.     @ApiModelProperty(value = "提交人ID", required = true)
  4.     @NotNull
  5.     private Long commitPersonnelId;
  7.     @ApiModelProperty(value = "提交人名称", required = true)
  8.     @NotNull
  9.     private String commitPersonnelName;
  11.     @ApiModelProperty(value = "巡检设备表ID集合", required = true)
  12.     @NotEmpty
  13.     private List<Long> inspectionEquipmentIds;
  14. }

在Controller的方法里面上加上@Validated注解

  1. @PostMapping("submitAccept")
  2. @ApiOperation(value = "06.巡检数据提交验收", notes = "巡检数据提交验收")
  3. @ApiOperationSupport(order = 22)
  4. public ResultData<Void> submitAccept(@Validated @RequestBody AuditListDto conditionDto) { 
  5.     service.submitAccept(conditionDto);
  6.     return ResultData.success();
  7. }

定义一个统一异常拦截器

  1. package com.yxk.config;
  3. import com.yxk.utils.ResultData;
  4. import com.yxk.utils.ResultDataException;
  5. import com.yxk.utils.Utils;
  6. import org.apache.commons.lang3.exception.ExceptionUtils;
  7. import org.slf4j.Logger;
  8. import org.slf4j.LoggerFactory;
  9. import org.springframework.dao.DataIntegrityViolationException;
  10. import org.springframework.dao.DuplicateKeyException;
  11. import org.springframework.validation.BindException;
  12. import org.springframework.validation.BindingResult;
  13. import org.springframework.validation.FieldError;
  14. import org.springframework.validation.ObjectError;
  15. import org.springframework.web.HttpRequestMethodNotSupportedException;
  16. import org.springframework.web.bind.MethodArgumentNotValidException;
  17. import org.springframework.web.bind.MissingServletRequestParameterException;
  18. import org.springframework.web.bind.annotation.ExceptionHandler;
  19. import org.springframework.web.bind.annotation.RestControllerAdvice;
  21. import java.util.List;
  23. @RestControllerAdvice
  24. public class GlobalExceptionHandler { 
  26.     private Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class.getName());
  28.     @ExceptionHandler({ HttpRequestMethodNotSupportedException.class})
  29.     public ResultData<?> handleException(HttpRequestMethodNotSupportedException e) { 
  30.         return ResultData.failed(ResultData.NOT_SUPPORTED_HTTP_METHOD, "不支持' " + e.getMethod() + "'请求");
  31.     }
  33.     @ExceptionHandler({ MissingServletRequestParameterException.class})
  34.     public ResultData<?> handleException(MissingServletRequestParameterException e) { 
  35.         return ResultData.failed(ResultData.MISSING_HTTP_PARAMETER,
  36.                 "缺少必要参数" + e.getParameterName() + ", 类型:" + e.getParameterType());
  37.     }
  39.     @ExceptionHandler({ BindException.class})
  40.     public ResultData<?> handleException(BindException e) { 
  41.         return ResultData.failed(ResultData.BIND_ERROR, e.getFieldErrors().get(0).getDefaultMessage());
  42.     }
  44.     @ExceptionHandler({ ResultDataException.class})
  45.     public ResultData<?> handleResultDataException(ResultDataException e) { 
  46.         logger.info("", e);
  47.         return e.toResultData();
  48.     }
  50.     @ExceptionHandler({ DataIntegrityViolationException.class}) // uk/fk
  51.     public ResultData<?> handleDataIntegrityViolationException(DataIntegrityViolationException e) { 
  52.         final String delFK = "Cannot delete or update a parent row: a foreign key constraint fails";
  53.         final String saveFK = "Cannot add or update a child row: a foreign key constraint fails";
  54.         final String UK = "Duplicate entry";
  55.         final String truncation = "Data truncation";//
  57.         logger.error("", e);
  59.         if (e instanceof DuplicateKeyException) { 
  60.             // pk (not to here, except direct insert by native sql)
  61.             return ResultData.failed(ResultData.INTEGRITY_VIOLATION, "重复的id");
  62.         }
  64.         Throwable root = ExceptionUtils.getRootCause(e);
  65.         if (root != null) { 
  66.             String err = Utils.findStr(root.getMessage(), UK);
  67.             if (err != null) {  // uk
  68.                 return ResultData.failed(ResultData.DUPLICATE_ENTRY, "重复数据，不能保存", err);
  69.             }
  70.             err = Utils.findStr(root.getMessage(), delFK);
  71.             if (err != null) { // fk: Cannot delete or update a parent row: a foreign key constraint fails
  72.                 return ResultData.failed(ResultData.DUPLICATE_ENTRY, "数据已被使用，不能删除", err);
  73.             }
  74.             err = Utils.findStr(root.getMessage(), saveFK);
  75.             if (err != null) { // fk: Cannot add or update a child row: a foreign key constraint fails
  76.                 return ResultData.failed(ResultData.DUPLICATE_ENTRY, "无效的引用id，不能保存", err);
  77.             }
  78.             err = Utils.findStr(root.getMessage(), truncation);
  79.             if (err != null) { // Data truncation: Out of range value for column 'fee'
  80.                 return ResultData.failed(ResultData.DUPLICATE_ENTRY, "数据截断(值超出范围)", err);
  81.             }
  82.             return ResultData.failed(ResultData.DUPLICATE_ENTRY, "数据不完整", root.getMessage());
  83.         }
  85.         return ResultData.failed(ResultData.INTEGRITY_VIOLATION, "数据不完整");
  86.     }
  88.     /** * 处理@Validated参数校验失败异常 * * @param exception 异常类 * @return 响应 */
  89.     @ExceptionHandler(MethodArgumentNotValidException.class)
  90.     public ResultData<?> validExceptionHandler(MethodArgumentNotValidException exception) { 
  91.         BindingResult result = exception.getBindingResult();
  92.         StringBuilder stringBuilder = new StringBuilder();
  93.         if (result.hasErrors()) { 
  94.             List<ObjectError> errors = result.getAllErrors();
  95.             if (errors != null) { 
  96.                 StringBuilder finalStringBuilder = stringBuilder;
  97.                 errors.forEach(p -> { 
  98.                     FieldError fieldError = (FieldError) p;
  99.                     logger.warn("Bad Request Parameters: dto entity [{}],field [{}],message [{}]", fieldError.getObjectName(), fieldError.getField(), fieldError.getDefaultMessage());
  100.                     finalStringBuilder.append(String.format("%s[%s]%s", p.getObjectName(), ((FieldError) p).getField(), p.getDefaultMessage())).append("，");
  101.                 });
  102.             }
  103.             if (stringBuilder.length() > 0) { 
  104.                 stringBuilder = stringBuilder.deleteCharAt(stringBuilder.length() - 1);
  105.             }
  106.         }
  108.         return ResultData.failed(ResultData.VALIDATE_ERROR, stringBuilder.toString());
  109.     }
  111.     @ExceptionHandler(RuntimeException.class)
  112.     public ResultData<?> handlerUnknown(RuntimeException e) { 
  113.         logger.error("", e);
  114.         Throwable root = ExceptionUtils.getRootCause(e);
  115.         if (root != null) { 
  116.             return ResultData.failed(ResultData.UNKNOWN_ERROR, "未知错误", root.getMessage());
  117.         }
  118.         return ResultData.failed(ResultData.UNKNOWN_ERROR, "未知错误", e.getMessage());
  120.     }
  122. }

自定义异常

  1. public class ResultDataException extends RuntimeException { 
  2.     private static final long serialVersionUID = -9041090610418135434L;
  4.     public static ResultDataException of(int code, String message) { 
  5.         return new ResultDataException(code, message);
  6.     }
  8.     public static ResultDataException of(int code, String message, Object data) { 
  9.         return new ResultDataException(code, message, null, data);
  10.     }
  12.     public static ResultDataException duplicateKey(String message) { 
  13.         return new ResultDataException(ResultData.DUPLICATE_KEY, message);
  14.     }
  16.     public static ResultDataException notfound(String message) { 
  17.         return new ResultDataException(ResultData.NOT_FOUND, message);
  18.     }
  20.     public static ResultDataException notfound(Long id) { 
  21.         return new ResultDataException(ResultData.NOT_FOUND, "记录不存在: " + id);
  22.     }
  24.     public static ResultDataException validateRequired(String field) { 
  25.         return new ResultDataException(ResultData.VALIDATE_ERROR, field + " 不能为空");
  26.     }
  28.     public static ResultDataException validteInvalidFormat(String field, String value) { 
  29.         return new ResultDataException(ResultData.VALIDATE_ERROR, field + " 无效格式: " + value);
  30.     }
  32.     public static ResultDataException validteTooLong(String field, int maxLength, String value) { 
  33.         return new ResultDataException(ResultData.VALIDATE_ERROR,
  34.                 String.format("[%s]超长(%d, %d): %s", field, maxLength, value.length(), value));
  35.     }
  37.     private final int code;
  38.     private final String internalError;
  39.     private final Object data;
  41.     public ResultDataException(int code, String message) { 
  42.         this(code, message, null);
  43.     }
  45.     public ResultDataException(int code, String message, String internalError) { 
  46.         this(code, message, internalError, null);
  47.     }
  49.     public ResultDataException(int code, String message, String internalError, Object data) { 
  50.         super(message);
  51.         this.code = code;
  52.         this.internalError = internalError;
  53.         this.data = data;
  54.     }
  56.     @SuppressWarnings("unchecked")
  57.     public <T> ResultData<T> toResultData() { 
  58.         return (ResultData<T>) ResultData.of(code, super.getMessage(), internalError, data);
  59.     }
  61. }
  63. public class ResultData<T> { 
  65.     public static <T> ResultData<T> of(int code, String message, T data) { 
  66.         return of(code, message, null, data);
  67.     }
  69.     public static <T> ResultData<T> of(int code, String message, String internalError, T data) { 
  70.         ResultData<T> ret = new ResultData<>();
  71.         ret.code = code;
  72.         ret.msg = message;
  73.         ret.internalError = internalError;
  74.         ret.data = data;
  75.         return ret;
  76.     }
  78.     public static <T> ResultList<T> ofList(int code, String message, String internalError, List<T> data) { 
  79.         ResultList<T> result = of(data, data == null ? 0 : data.size());
  80.         result.setCode(code);
  81.         result.setMsg(message);
  82.         result.setInternalError(internalError);
  83.         return result;
  84.     }
  86.     public static <T> ResultData<T> of(T data) { 
  87.         return of(SUCCESS, null, data);
  88.     }
  90.     public static <T> ResultList<T> of(List<T> data) { 
  91.         return of(data, data.size());
  92.     }
  94.     public static <T> ResultList<T> of(List<T> data, long total) { 
  95.         ResultList<T> ret = new ResultList<>();
  96.         ret.setData(data);
  97.         ret.setTotal(total);
  98.         return ret;
  99.     }
  101.     public static <T> ResultData<T> success(T data) { 
  102.         return of(SUCCESS, null, data);
  103.     }
  105.     // success (no ret data)
  106.     public static <T> ResultData<T> success() { 
  107.         return of(SUCCESS, null, null);
  108.     }
  110.     public static <T> ResultData<T> success(String message, T data) { // success with message
  111.         return of(SUCCESS, message, data);
  112.     }
  113.     //
  115.     public static <T> ResultData<T> failed(int code, String message) { 
  116.         return failed(code, message, null);
  117.     }
  119.     public static <T> ResultData<T> failed(int code, String message, String internalError) { 
  120.         return of(code, message, internalError, null);
  121.     }
  123.     public static <T> ResultData<T> unknown(String message) { 
  124.         return of(UNKNOWN_ERROR, message, null);
  125.     }
  127.     public static <T> ResultData<T> unknown(Throwable t) { 
  128.         String message = t.getMessage();
  129.         if (message == null || message.isEmpty()) { 
  130.             message = t.toString();
  131.         }
  132.         return of(UNKNOWN_ERROR, message, null);
  133.     }
  135.     public static <T> ResultData<T> notfound(String message) { 
  136.         return failed(NOT_FOUND, message);
  137.     }
  139.     //
  140.     public static final int SUCCESS = 0;
  141.     public static final int UNKNOWN_ERROR = -1;
  143.     public static final int DUPLICATE_KEY = 1; // primaryKey
  144.     public static final int DUPLICATE_ENTRY = 2; // uk
  145.     public static final int INTEGRITY_VIOLATION = 3; // fk
  146.     public static final int DISALLOW_OPERATION = 4;
  147.     public static final int VALIDATE_ERROR = 5; // required/String format/value range
  149.     // module defined code...
  150.     public static final int UNAUTHORIZED = 401;
  151.     public static final int FORBIDDEN = 403;
  153.     public static final int NOT_FOUND = 404;
  155.     /** * process data(record) is not in the biz rules expired status, or input * param(some-field) not in expired state(value-range). */
  156.     public static final int ILLEGAL_STATE = 411;
  158.     /** * http request BindException */
  159.     public static final int BIND_ERROR = 412;
  161.     /** * http request method is not supported. */
  162.     public static final int NOT_SUPPORTED_HTTP_METHOD = 413;
  164.     /** * http request missing some param */
  165.     public static final int MISSING_HTTP_PARAMETER = 414;
  167.     //
  169.     private int code;
  170.     private String msg;
  171.     private String internalError;
  172.     private T data;
  173.     private Object extData;
  175.     @SuppressWarnings("unchecked")
  176.     public <R> R andThen(Consumer<R> f) { 
  177.         f.accept((R) this);
  178.         return (R) this;
  179.     }
  181.     @SuppressWarnings("unchecked")
  182.     public <R> R andThen(boolean predicate, Consumer<R> f) { 
  183.         if (predicate) { 
  184.             f.accept((R) this);
  185.         }
  186.         return (R) this;
  187.     }
  189.     public String toString() { 
  190.         return new StringBuilder().append("code=").append(code).append(", msg=").append(msg).append(", data=")
  191.                 .append(data).toString();
  192.     }
  194.     @JsonIgnore
  195.     public boolean isSuccessed() { 
  196.         return code == SUCCESS;
  197.     }
  199.     @JsonIgnore
  200.     public boolean isFailed() { 
  201.         return !isSuccessed();
  202.     }
  204.     public int getCode() { 
  205.         return code;
  206.     }
  208.     public void setCode(int code) { 
  209.         this.code = code;
  210.     }
  212.     public String getMsg() { 
  213.         return msg;
  214.     }
  216.     public void setMsg(String message) { 
  217.         this.msg = message;
  218.     }
  220.     public T getData() { 
  221.         return data;
  222.     }
  224.     public void setData(T data) { 
  225.         this.data = data;
  226.     }
  228.     public String getInternalError() { 
  229.         return internalError;
  230.     }
  232.     public void setInternalError(String internalError) { 
  233.         this.internalError = internalError;
  234.     }
  236.     public Object getExtData() { 
  237.         return extData;
  238.     }
  240.     public void setExtData(Object extData) { 
  241.         this.extData = extData;
  242.     }
  243. }
  245. public class Utils { 
  246.     private Utils() { 
  247.     }
  249.     public static String findStr(String s, String search) { 
  250.         if (s == null) { 
  251.             return s;
  252.         }
  253.         int idx = s.indexOf(search);
  254.         if (idx > -1) { 
  255.             return s.substring(idx);
  256.         }
  257.         return null;
  258.     }
  259. }

发表评论

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

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

相关阅读

    相关 Java全局异常处理-自定义异常处理

    > 哈喽！大家好，我是旷世奇才李先生 > 文章持续更新，可以微信搜索【小奇JAVA面试】第一时间阅读，回复【资料】更有我为大家准备的福利哟，回复【项目】获取我为大家准备的项

    悠悠悠悠/ 0 赞/ 217 阅读