refactor: standardize Seata Exception

changes/en-us/2.x.md

@@ -63,6 +63,9 @@ Add changes here for all PR submitted to the 2.x branch.
 - [[#6264](https://github.com/apache/incubator-seata/pull/6264)] fix jib-maven-plugin build failed
 - [[#6246](https://github.com/apache/incubator-seata/pull/6246)] build the frontend at the same time as the maven build
 
+### refactor:
+- [[#6269](https://github.com/apache/incubator-seata/pull/6269)] standardize Seata Exception
+
 ### security:
 - [[#6069](https://github.com/apache/incubator-seata/pull/6069)] Upgrade Guava dependencies to fix security vulnerabilities
 - [[#6145](https://github.com/apache/incubator-seata/pull/6145)] upgrade jettison to 1.5.4

changes/zh-cn/2.x.md

@@ -61,6 +61,9 @@
 - [[#6264](https://github.com/apache/incubator-seata/pull/6264)] 修复 jib-maven-plugin 编译失败问题
 - [[#6246](https://github.com/apache/incubator-seata/pull/6246)] 在maven打包的同时打包前端资源
 
+### refactor:
+- [[#6269](https://github.com/apache/incubator-seata/pull/6269)] 统一Seata异常规范
+
 ### security:
 - [[#6069](https://github.com/apache/incubator-seata/pull/6069)] 升级Guava依赖版本，修复安全漏洞
 - [[#6144](https://github.com/apache/incubator-seata/pull/6144)] 升级Nacos依赖版本至1.4.6

common/src/main/java/io/seata/common/exception/ErrorCode.java

@@ -0,0 +1,59 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.seata.common.exception;
+
+public enum ErrorCode {
+
+    /**
+     * 0001 ~ 0099  Configuration related errors
+     */
+    ERR_CONFIG(ErrorType.Config, 0001);
+    /**
+     * The error code of the transaction exception.
+     */
+
+    private int code;
+    private ErrorType type;
+
+    ErrorCode(ErrorType type, int code) {
+        this.code = code;
+        this.type = type;
+    }
+
+    public int getCode() {
+        return code;
+    }
+
+    public String getType() {
+        return type.name();
+    }
+
+    public String getMessage(String... params) {
+        return ResourceBundleUtil.getInstance().getMessage(this.name(), this.getCode(), this.getType(), params);
+    }
+
+    enum ErrorType {
+        Config,
+        Network,
+        TM,
+        RM,
+        TC,
+        Datasource,
+        Other;
+    }
+
+}

common/src/main/java/io/seata/common/exception/FrameworkErrorCode.java

@@ -20,6 +20,7 @@
  * The enum Framework error code.
  *
  */
+@Deprecated
 public enum FrameworkErrorCode {
     /**
      * 0001 ~ 0099  Configuration related errors

common/src/main/java/io/seata/common/exception/RemoteResourceBundle.java

@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.seata.common.exception;
+
+import java.util.ResourceBundle;
+
+public abstract class RemoteResourceBundle extends ResourceBundle {
+
+}

common/src/main/java/io/seata/common/exception/ResourceBundleUtil.java

@@ -0,0 +1,167 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.seata.common.exception;
+
+import java.text.MessageFormat;
+import java.util.HashSet;
+import java.util.Locale;
+import java.util.ResourceBundle;
+import java.util.Set;
+
+import io.seata.common.loader.EnhancedServiceLoader;
+import org.apache.commons.lang.StringUtils;
+
+public class ResourceBundleUtil {
+
+    private static final Locale LOCALE = new Locale("en", "US");
+    private static final ResourceBundleUtil INSTANCE = new ResourceBundleUtil("error/ErrorCode", LOCALE);
+    private ResourceBundle localBundle;
+    private RemoteResourceBundle remoteBundle;
+
+    public static final String DEFAULT_PLACEHOLDER_PREFIX = "${";
+    public static final String DEFAULT_PLACEHOLDER_SUFFIX = "}";
+
+    public static ResourceBundleUtil getInstance() {
+        return INSTANCE;
+    }
+
+    public ResourceBundleUtil(String bundleName, Locale local) {
+
+        this.localBundle = ResourceBundle.getBundle(bundleName, local);
+        try {
+            this.remoteBundle = EnhancedServiceLoader.load(RemoteResourceBundle.class);
+        } catch (Throwable e) {
+            //ignore
+        }
+    }
+
+    public String getMessage(String key, String... params) {
+        if (StringUtils.isBlank(key)) {
+            return null;
+        }
+        StringBuilder sb = new StringBuilder();
+        sb.append(getFormattedMessage(key));
+        String msg = parseStringValue(sb.toString(), new HashSet<String>());
+        if (params == null || params.length == 0) {
+            return msg;
+        }
+        if (StringUtils.isBlank(msg)) {
+            return msg;
+        }
+        return MessageFormat.format(msg, (Object[])params);
+    }
+
+    public String getMessage(String key, int code, String type, String... params) {
+        if (StringUtils.isBlank(key)) {
+            return null;
+        }
+        StringBuilder sb = new StringBuilder();
+
+        sb.append(getFormattedMessage("ERR_PREFIX")).append(" ").append(getFormattedMessage(key)).append(" ").append(
+            getFormattedMessage("ERR_POSTFIX"));
+        String msg = sb.toString();
+        msg = parseStringValue(msg, new HashSet<String>());
+        msg = StringUtils.replace(msg, "{code}", String.valueOf(code));
+        msg = StringUtils.replace(msg, "{type}", String.valueOf(type));
+        msg = StringUtils.replace(msg, "{key}", key);
+
+        if (params == null || params.length == 0) {
+            return msg;
+        }
+        if (StringUtils.isBlank(msg)) {
+            return msg;
+        }
+        return MessageFormat.format(msg, (Object[])params);
+    }
+
+    protected String getFormattedMessage(String key) {
+        String value = StringUtils.EMPTY;
+        if (remoteBundle != null && remoteBundle.containsKey(key)) {
+            value = remoteBundle.getString(key);
+        }
+        if (StringUtils.isEmpty(value)) {
+            value = localBundle.getString(key);
+        }
+        return value;
+    }
+
+    protected String parseStringValue(String strVal, Set<String> visitedPlaceholders) {
+        StringBuffer buf = new StringBuffer(strVal);
+        int startIndex = strVal.indexOf(DEFAULT_PLACEHOLDER_PREFIX);
+        while (startIndex != -1) {
+            int endIndex = findPlaceholderEndIndex(buf, startIndex);
+            if (endIndex != -1) {
+                String placeholder = buf.substring(startIndex + DEFAULT_PLACEHOLDER_PREFIX.length(), endIndex);
+                if (!visitedPlaceholders.add(placeholder)) {
+                    throw new SeataRuntimeException(ErrorCode.ERR_CONFIG,
+                        "Duplicate placeholders exist '" + placeholder + "' in bundle.");
+                }
+                placeholder = parseStringValue(placeholder, visitedPlaceholders);
+                String propVal = resolvePlaceholder(placeholder);
+                if (propVal != null) {
+                    propVal = parseStringValue(propVal, visitedPlaceholders);
+                    buf.replace(startIndex, endIndex + DEFAULT_PLACEHOLDER_SUFFIX.length(), propVal);
+                    startIndex = buf.indexOf(DEFAULT_PLACEHOLDER_PREFIX, startIndex + propVal.length());
+                } else {
+                    throw new SeataRuntimeException(ErrorCode.ERR_CONFIG,
+                        "Could not resolve placeholder '" + placeholder + "'");
+                }
+                visitedPlaceholders.remove(placeholder);
+            } else {
+                startIndex = -1;
+            }
+        }
+
+        return buf.toString();
+    }
+
+    private int findPlaceholderEndIndex(CharSequence buf, int startIndex) {
+        int index = startIndex + DEFAULT_PLACEHOLDER_PREFIX.length();
+        int withinNestedPlaceholder = 0;
+        while (index < buf.length()) {
+            if (matchSubString(buf, index, DEFAULT_PLACEHOLDER_SUFFIX)) {
+                if (withinNestedPlaceholder > 0) {
+                    withinNestedPlaceholder--;
+                    index = index + DEFAULT_PLACEHOLDER_SUFFIX.length();
+                } else {
+                    return index;
+                }
+            } else if (matchSubString(buf, index, DEFAULT_PLACEHOLDER_PREFIX)) {
+                withinNestedPlaceholder++;
+                index = index + DEFAULT_PLACEHOLDER_PREFIX.length();
+            } else {
+                index++;
+            }
+        }
+        return -1;
+    }
+
+    private boolean matchSubString(CharSequence str, int index, CharSequence substring) {
+        for (int j = 0; j < substring.length(); j++) {
+            int i = index + j;
+            if (i >= str.length() || str.charAt(i) != substring.charAt(j)) {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    private String resolvePlaceholder(String placeholder) {
+        return getFormattedMessage(placeholder);
+    }
+
+}

common/src/main/java/io/seata/common/exception/SeataRuntimeException.java

@@ -0,0 +1,72 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.seata.common.exception;
+
+import java.sql.SQLException;
+
+public class SeataRuntimeException extends RuntimeException {
+    private int vendorCode;
+    private String sqlState;
+    public SeataRuntimeException(ErrorCode errorCode, String... params) {
+        super(errorCode.getMessage(params));
+        this.vendorCode = errorCode.getCode();
+    }
+
+    public SeataRuntimeException(ErrorCode errorCode, Throwable cause, String... params) {
+        super(errorCode.getMessage(params), cause);
+        buildSQLMessage(cause);
+    }
+
+    @Override
+    public String toString() {
+        return super.getLocalizedMessage();
+    }
+
+    @Override
+    public String getMessage() {
+        if (super.getMessage() != null) {
+            return super.getMessage();
+        } else if (getCause() != null) {
+            Throwable ca = getCause();
+            if (ca != null) {
+                return ca.getMessage();
+            } else {
+                return null;
+            }
+        } else {
+            return null;
+        }
+    }
+
+    private void buildSQLMessage(Throwable e) {
+        if (e instanceof SQLException) {
+            this.vendorCode = ((SQLException) e).getErrorCode();
+            this.sqlState = ((SQLException) e).getSQLState();
+        } else if (e instanceof SeataRuntimeException) {
+            this.vendorCode = ((SeataRuntimeException) e).getVendorCode();
+            this.sqlState = ((SeataRuntimeException) e).getSqlState();
+        }
+    }
+
+    public int getVendorCode() {
+        return vendorCode;
+    }
+
+    public String getSqlState() {
+        return sqlState;
+    }
+}

common/src/main/resources/error/ErrorCode_en.properties

@@ -0,0 +1,19 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+ERR_PREFIX=ERR-CODE: [Seata-{code}][{key}]
+ERR_POSTFIX=More: [https://seata.apache.org/docs/next/overview/faq#{code}]
+ERR_CONFIG=config error, {0}