api.result.error

Author: AlanGeeker

blogtree-util-api/src/main/java/org/blogtree/util/api/result/error/BaseError.java

@@ -0,0 +1,38 @@
+package org.blogtree.util.api.result.error;
+
+import java.text.MessageFormat;
+
+/**
+ * 通用的ErrorCode枚举接口，定义code和msg方法
+ */
+public interface BaseError {
+
+    /**
+     * 获取 错误码
+     *
+     * @return 错误码
+     */
+    String getErrorCode();
+
+    /**
+     * 获取 错误信息 或 错误信息模版
+     *
+     * @return 错误信息 或 错误信息模版
+     */
+    String getErrorMsg();
+
+    /**
+     * 根据入参，拼接错误信息
+     *
+     * @param errorMsg  错误信息 或 错误信息模版
+     * @param arguments 待拼接的入参，可能为空
+     * @return 拼接好的错误信息
+     */
+    static String buildErrorMsg(String errorMsg, Object... arguments) {
+        if (arguments == null || arguments.length == 0) {
+            return errorMsg;
+        } else {
+            return MessageFormat.format(errorMsg, arguments);
+        }
+    }
+}

blogtree-util-api/src/main/java/org/blogtree/util/api/result/error/BizException.java

@@ -0,0 +1,37 @@
+package org.blogtree.util.api.result.error;
+
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * 业务异常类
+ */
+@Getter
+@ToString
+public class BizException extends RuntimeException {
+
+    private static final long serialVersionUID = -1L;
+
+    private String errorCode;
+    private String errorMsg;
+
+    /**
+     * 常用
+     * 从项目规范来说，应该全部为错误码枚举
+     * 错误枚举类，应该使用 或 继承 BaseError
+     */
+    public BizException(BaseError baseError, Object... arguments) {
+        this.errorCode = baseError.getErrorCode();
+        this.errorMsg = BaseError.buildErrorMsg(baseError.getErrorMsg(), arguments);
+    }
+
+    /**
+     * 优化处理：
+     * fillInStackTrace内部 调用native的fillInStackTrace()方法去爬取线程堆栈信息，为运行时栈做一份快照，这一部分开销很大
+     * 由于是自定义业务异常，无需再查询堆栈信息，所有直接返回this即可
+     */
+    @Override
+    public Throwable fillInStackTrace() {
+        return this;
+    }
+}

blogtree-util-api/src/main/java/org/blogtree/util/api/result/error/CommonError.java

@@ -0,0 +1,33 @@
+package org.blogtree.util.api.result.error;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+/**
+ * 通用的业务异常枚举。
+ * 实际业务系统，可参考此类，自行继承BaseError类。
+ */
+@Getter
+@AllArgsConstructor
+public enum CommonError implements BaseError {
+
+    // ===== ===== ===== ===== 通用 - 入参校验异常 ===== ===== ===== =====
+    PARAM_NOT_NULL("PARAM_NOT_NULL", "{0}不能为NULL"),
+    STRING_NOT_EMPTY("STRING_NOT_EMPTY", "{0}不能为NULL或空字符串"),
+    NUMBER_NOT_EMPTY("NUMBER_NOT_EMPTY", "{0}不能为NULL或0"),
+    DATE_NOT_EMPTY("DATE_NOT_EMPTY", "{0}不能为NULL或0"),
+    LIST_NOT_EMPTY("LIST_NOT_EMPTY", "{0}不能为NULL或空数组"),
+    NUMBER_NOT_LTE("NUMBER_NOT_LTE", "{0}不能大于{1}"),
+
+    // ===== ===== ===== ===== 通用 - 数据库异常 ===== ===== ===== =====
+    DB_NOT_EXIST("DB_NOT_EXIST", "数据不存在"),
+
+    // ===== ===== ===== ===== 终极异常 ===== ===== ===== =====
+    ERROR("ERROR", "系统异常"),
+
+    // 占位
+    ;
+
+    private String errorCode;
+    private String errorMsg;
+}