refactor: 修改统一接口返回格式、全局异常处理

Author: cadecode

simple-common/src/main/java/top/cadecode/common/constant/ErrorEnum.java

@@ -0,0 +1,38 @@
+package top.cadecode.common.constant;
+
+import lombok.Getter;
+
+/**
+ * @author Li Jun
+ * @date 2021/8/24
+ * @description 错误码枚举类
+ */
+@Getter
+public enum ResCode {
+
+    // 未知错误通用码
+    UNKNOWN(0, "未知错误"),
+    SUCCESS(1, "请求成功"),
+
+    // 用户权限异常
+    TOKEN_NOT_EXIST(1000, "未登录"),
+    TOKEN_ERROR(1001, "Token 错误"),
+    TOKEN_EXPIRED(1002, "Token 已过期"),
+    TOKEN_NO_AUTHORITY(1003, "权限不足"),
+
+    // 请求响应异常
+    REQ_PARAM_INVALID(2000, "请求参数无效"),
+    REQ_BODY_INVALID(2001, "请求体无效"),
+    RES_BODY_INVALID(2002, "响应数据为空"),
+    REQ_METHOD_INVALID(2003, "请求方法不支持"),
+    REQ_PATH_NOT_EXIST(2004, "请求接口不存在"),
+    ;
+
+    private final Integer code;
+    private final String reason;
+
+    ResCode(Integer code, String reason) {
+        this.code = code;
+        this.reason = reason;
+    }
+}

simple-common/src/main/java/top/cadecode/common/constant/ResCode.java

@@ -1,7 +1,7 @@
 package top.cadecode.common.exception;
 
 import lombok.Getter;
-import top.cadecode.common.constant.ErrorEnum;
+import top.cadecode.common.constant.ResCode;
 
 /**
  * @author Cade Li
@@ -11,15 +11,14 @@
 @Getter
 public class SimpleException extends RuntimeException {
 
-    private final ErrorEnum errorEnum;
+    private final ResCode resCode;
 
-    public SimpleException(ErrorEnum errorEnum) {
-        super(errorEnum.getReason());
-        this.errorEnum = errorEnum;
+    public SimpleException(ResCode resCode) {
+        this.resCode = resCode;
     }
 
-    public SimpleException(ErrorEnum errorEnum, String message) {
-        super(message);
-        this.errorEnum = errorEnum;
+    public SimpleException(ResCode resCode, String errorMsg) {
+        super(errorMsg);
+        this.resCode = resCode;
     }
 }

simple-common/src/main/java/top/cadecode/common/constant/StatusEnum.java

@@ -9,14 +9,12 @@
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.context.request.WebRequest;
+import top.cadecode.common.constant.ResCode;
 import top.cadecode.common.response.SimpleRes;
-import top.cadecode.common.constant.ErrorEnum;
-import top.cadecode.common.constant.StatusEnum;
 import top.cadecode.common.util.MapUtil;
-import top.cadecode.common.response.SimpleRes.ResError;
+import top.cadecode.common.util.MapUtil.MapBuilder;
 
 import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
 import java.util.Map;
 
 /**
@@ -33,69 +31,58 @@ public class SimpleExceptionHandler extends DefaultErrorAttributes {
      */
     @ExceptionHandler(SimpleException.class)
     @ResponseBody
-    public SimpleRes handleSimpleException(SimpleException e, HttpServletRequest request,
-                                           HttpServletResponse response) {
+    public SimpleRes<?> handleSimpleException(SimpleException e, HttpServletRequest request) {
         log.error("SimpleException Handler =>", e);
-        return SimpleRes.fail(e.getErrorEnum())
-                .path(request)
-                .status(response);
+        return SimpleRes.of(e.getResCode())
+                .errorMsg(e.getMessage())
+                .path(request.getRequestURI());
     }
 
     /**
      * 处理一般异常
      */
     @ExceptionHandler(Exception.class)
     @ResponseBody
-    public SimpleRes handleOtherException(Exception e, HttpServletRequest request,
-                                          HttpServletResponse response) {
+    public SimpleRes<?> handleOtherException(Exception e, HttpServletRequest request) {
+        // 获取请求路径
+        String requestURI = request.getRequestURI();
         log.error("Exception Handler =>", e);
         // 处理 SpringMVC 异常
         if (e instanceof MissingServletRequestParameterException) {
-            return SimpleRes.fail(ErrorEnum.REQ_PARAM_INVALID)
-                    .path(request)
-                    .status(response);
+            return SimpleRes.of(ResCode.REQ_PARAM_INVALID)
+                    .path(requestURI);
         }
         if (e instanceof HttpMessageNotReadableException) {
-            return SimpleRes.fail(ErrorEnum.REQ_BODY_INVALID)
-                    .path(request)
-                    .status(response);
+            return SimpleRes.of(ResCode.REQ_BODY_INVALID)
+                    .path(requestURI);
         }
-        return SimpleRes.fail(ErrorEnum.UNKNOWN)
-                .path(request)
-                .status(response);
+        return SimpleRes.of(ResCode.UNKNOWN)
+                .path(requestURI);
     }
 
     /**
      * 自定义 SpringMVC 404、405 返回内容
      */
-    private static final String STATUS_KEY = "status";
-    private static final String MESSAGE_KEY = "message";
-    private static final String PATH_KEY = "path";
-    private static final String ERROR_KEY = "error";
-
     @Override
     public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
         // 获取填充好的 errorAttributes
         Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, options);
-        // 获取状态码与路径
-        int status = (int) errorAttributes.get(STATUS_KEY);
-        String path = (String) errorAttributes.get(PATH_KEY);
+        // 获取请求路径
+        int status = (int) errorAttributes.get("status");
+        String path = (String) errorAttributes.get("path");
+        MapBuilder<String, Object> resMapBuilder = MapUtil.create().add("path", path);
         // 处理 404
-        if (status == StatusEnum.NOT_EXIT.getStatus()) {
-            return MapUtil.create()
-                    .add(STATUS_KEY, StatusEnum.NOT_EXIT.getStatus())
-                    .add(MESSAGE_KEY, StatusEnum.NOT_EXIT.getMessage())
-                    .add(PATH_KEY, path)
-                    .add(ERROR_KEY, new ResError(ErrorEnum.API_NOT_EXIST))
+        if (status == 404) {
+            return resMapBuilder
+                    .add("code", ResCode.REQ_PATH_NOT_EXIST.getCode())
+                    .add("reason", ResCode.REQ_PATH_NOT_EXIST.getReason())
                     .asMap();
         }
         // 处理 405
-        if (status == StatusEnum.NOT_FIT.getStatus()) {
-            return MapUtil.create()
-                    .add(STATUS_KEY, StatusEnum.NOT_FIT.getStatus())
-                    .add(MESSAGE_KEY, StatusEnum.NOT_FIT.getMessage())
-                    .add(PATH_KEY, path)
-                    .add(ERROR_KEY, new ResError(ErrorEnum.REQ_METHOD_INVALID))
+        if (status == 405) {
+            return resMapBuilder
+                    .add("code", ResCode.REQ_METHOD_INVALID.getCode())
+                    .add("reason", ResCode.REQ_METHOD_INVALID.getReason())
                     .asMap();
         }
         return errorAttributes;