feat: 引入 validation，配置统一异常处理

Author: cadecode

simple-common/pom.xml

@@ -27,6 +27,11 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-aop</artifactId>
         </dependency>
+        <!--validation-->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
         <!--Spring Security-->
         <dependency>
             <groupId>org.springframework.boot</groupId>

simple-common/src/main/java/top/cadecode/sra/common/enums/error/FrameErrorEnum.java

@@ -0,0 +1,29 @@
+package top.cadecode.sra.common.enums.error;
+
+import lombok.Getter;
+import top.cadecode.sra.common.exception.ApiErrorCode;
+
+/**
+ * @author Cade Li
+ * @date 2022/5/30
+ * @description 框架异常枚举
+ */
+@Getter
+public enum FrameErrorEnum implements ApiErrorCode {
+
+    VALIDATED_ERROR(1, "参数校验不通过"),
+    REQ_PARAM_INVALID(2, "请求参数无效"),
+    REQ_BODY_INVALID(3, "请求体无效"),
+    MEDIA_TYPE_NO_SUPPORT(4, "MediaType 不被支持"),
+    PARAM_TYPE_CONVERT_ERROR(4, "参数类型转换错误"),
+    ;
+
+    private final String code;
+
+    private final String message;
+
+    FrameErrorEnum(int code, String message) {
+        this.code = "FRAME_" + code;
+        this.message = message;
+    }
+}

simple-framework/src/main/java/top/cadecode/sra/framework/exception/ApiExceptionAdvisor.java

@@ -2,7 +2,6 @@
 
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.bind.annotation.ExceptionHandler;
-import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 import top.cadecode.sra.common.exception.ApiErrorCode;
 import top.cadecode.sra.common.exception.ApiException;
@@ -30,7 +29,6 @@ public ApiResult<Object> handleApiException(ApiException e) {
      * 兜底处理一般异常
      */
     @ExceptionHandler(Exception.class)
-    @ResponseBody
     public ApiResult<Object> handleException(Exception e) {
         log.error("Exception =>", e);
         return ApiResult.error(ApiErrorCode.UNKNOWN).moreInfo(e.getMessage());

simple-framework/src/main/java/top/cadecode/sra/framework/exception/FrameExceptionAdvisor.java

@@ -0,0 +1,85 @@
+package top.cadecode.sra.framework.exception;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.TypeMismatchException;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.http.converter.HttpMessageNotReadableException;
+import org.springframework.validation.BindException;
+import org.springframework.web.HttpMediaTypeNotSupportedException;
+import org.springframework.web.bind.ServletRequestBindingException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import top.cadecode.sra.common.enums.error.FrameErrorEnum;
+import top.cadecode.sra.common.exception.ApiErrorCode;
+import top.cadecode.sra.common.response.ApiResult;
+import top.cadecode.sra.common.response.ApiStatus;
+
+import javax.servlet.http.HttpServletRequest;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.stream.Collectors;
+
+/**
+ * @author Cade Li
+ * @date 2022/5/30
+ * @description 框架异常处理器
+ */
+@Slf4j
+@RestControllerAdvice
+@Order(Ordered.HIGHEST_PRECEDENCE)
+public class FrameExceptionAdvisor {
+
+    /**
+     * 处理参数校验异常
+     */
+    @ExceptionHandler(value = BindException.class)
+    public ApiResult<Object> handleValidationException(BindException e, HttpServletRequest request) {
+        log.error("Validation Exception =>", e);
+        // 获取错误信息，并拼接
+        String msg = e.getBindingResult().getFieldErrors().stream()
+                .map(o -> "[" + o.getField() + "]" + o.getDefaultMessage())
+                .collect(Collectors.joining(","));
+        return ApiResult.of(ApiStatus.BAD_REQUEST, FrameErrorEnum.VALIDATED_ERROR, null)
+                .moreInfo(msg).path(request.getRequestURI());
+    }
+
+    /**
+     * Spring MVC 异常类型和错误枚举的映射
+     */
+    private static final Map<Class<?>, ApiErrorCode> MVC_EXP_CODE_MAP = new HashMap<Class<?>, ApiErrorCode>() {{
+        // 请求参数错误
+        put(ServletRequestBindingException.class, FrameErrorEnum.REQ_PARAM_INVALID);
+        // 请求体错误
+        put(HttpMessageNotReadableException.class, FrameErrorEnum.REQ_BODY_INVALID);
+        // content-type 错误
+        put(HttpMediaTypeNotSupportedException.class, FrameErrorEnum.MEDIA_TYPE_NO_SUPPORT);
+        // 参数类型转换错误
+        put(TypeMismatchException.class, FrameErrorEnum.PARAM_TYPE_CONVERT_ERROR);
+    }};
+
+    /**
+     * 处理 Spring MVC 参数异常
+     */
+    @ExceptionHandler({
+            ServletRequestBindingException.class,
+            HttpMessageNotReadableException.class,
+            HttpMediaTypeNotSupportedException.class,
+            TypeMismatchException.class
+    })
+    public ApiResult<Object> handleMvcException(Exception e, HttpServletRequest request) {
+        log.error("Spring MVC Exception Handler =>", e);
+        String requestURI = request.getRequestURI();
+        // 根据异常类型查找 map 中的 code 枚举
+        ApiErrorCode errorCode = MVC_EXP_CODE_MAP.entrySet()
+                .stream()
+                .filter(o -> o.getKey().isAssignableFrom(e.getClass()))
+                .map(Entry::getValue)
+                .findFirst()
+                .orElse(ApiErrorCode.UNKNOWN);
+        return ApiResult.of(ApiStatus.BAD_REQUEST, errorCode, null)
+                .moreInfo(e.getMessage())
+                .path(requestURI);
+    }
+}