feat: should retry based on business code (#197)

Author: MilletBo

src/main/java/io/github/doocs/im/ClientConfiguration.java

@@ -31,6 +31,11 @@ public class ClientConfiguration {
      * 默认自动更新签名
      */
     public static final boolean DEFAULT_RENEW_SIG = true;
+
+    /**
+     * 默认业务错误码重试开关关闭
+     */
+    public static final boolean DEFAULT_ENABLE_BUSINESS_RETRY = false;
     /**
      * 默认超时时间（毫秒）
      */
@@ -57,14 +62,15 @@ public class ClientConfiguration {
     private long callTimeout = DEFAULT_CALL_TIMEOUT;
     private long expireTime = DEFAULT_EXPIRE_TIME;
     private boolean autoRenewSig = DEFAULT_RENEW_SIG;
+    private boolean enableBusinessRetry = DEFAULT_ENABLE_BUSINESS_RETRY;
     private String userAgent = DEFAULT_USER_AGENT;
     private ConnectionPool connectionPool = DEFAULT_CONNECTION_POOL;
 
     public ClientConfiguration() {
     }
 
     public ClientConfiguration(int maxRetries, long retryIntervalMs, long connectTimeout, long readTimeout, long writeTimeout,
-                               long callTimeout, long expireTime, boolean autoRenewSig,
+                               long callTimeout, long expireTime, boolean autoRenewSig, boolean enableBusinessRetry,
                                String userAgent, ConnectionPool connectionPool) {
         if (connectionPool == null) {
             connectionPool = DEFAULT_CONNECTION_POOL;
@@ -77,6 +83,7 @@ public ClientConfiguration(int maxRetries, long retryIntervalMs, long connectTim
         this.callTimeout = callTimeout;
         this.expireTime = expireTime;
         this.autoRenewSig = autoRenewSig;
+        this.enableBusinessRetry = enableBusinessRetry;
         this.userAgent = userAgent;
         this.connectionPool = connectionPool;
     }
@@ -90,6 +97,7 @@ private ClientConfiguration(Builder builder) {
         this.callTimeout = builder.callTimeout;
         this.expireTime = builder.expireTime;
         this.autoRenewSig = builder.autoRenewSig;
+        this.enableBusinessRetry = builder.enableBusinessRetry;
         this.userAgent = builder.userAgent;
         this.connectionPool = builder.connectionPool;
     }
@@ -162,6 +170,14 @@ public void setAutoRenewSig(boolean autoRenewSig) {
         this.autoRenewSig = autoRenewSig;
     }
 
+    public boolean isEnableBusinessRetry() {
+        return enableBusinessRetry;
+    }
+
+    public void setEnableBusinessRetry(boolean enableBusinessRetry) {
+        this.enableBusinessRetry = enableBusinessRetry;
+    }
+
     public String getUserAgent() {
         return userAgent;
     }
@@ -215,6 +231,9 @@ public boolean equals(Object o) {
         if (autoRenewSig != that.autoRenewSig) {
             return false;
         }
+        if (enableBusinessRetry != that.enableBusinessRetry) {
+            return false;
+        }
         if (!userAgent.equals(that.userAgent)) {
             return false;
         }
@@ -223,7 +242,7 @@ public boolean equals(Object o) {
 
     @Override
     public int hashCode() {
-        return Objects.hash(maxRetries, retryIntervalMs, connectTimeout, readTimeout, writeTimeout, callTimeout, expireTime, autoRenewSig, userAgent, connectionPool);
+        return Objects.hash(maxRetries, retryIntervalMs, connectTimeout, readTimeout, writeTimeout, callTimeout, expireTime, autoRenewSig, enableBusinessRetry, userAgent, connectionPool);
     }
 
     public static final class Builder {
@@ -235,6 +254,7 @@ public static final class Builder {
         private long callTimeout = DEFAULT_CALL_TIMEOUT;
         private long expireTime = DEFAULT_EXPIRE_TIME;
         private boolean autoRenewSig = DEFAULT_RENEW_SIG;
+        private boolean enableBusinessRetry = DEFAULT_ENABLE_BUSINESS_RETRY;
         private String userAgent = DEFAULT_USER_AGENT;
         private ConnectionPool connectionPool = DEFAULT_CONNECTION_POOL;
 
@@ -285,6 +305,11 @@ public Builder autoRenewSig(boolean autoRenewSig) {
             return this;
         }
 
+        public Builder enableBusinessRetry(boolean enableBusinessRetry) {
+            this.enableBusinessRetry = enableBusinessRetry;
+            return this;
+        }
+
         public Builder userAgent(String userAgent) {
             this.userAgent = userAgent;
             return this;

src/main/java/io/github/doocs/im/util/HttpUtil.java

@@ -1,6 +1,7 @@
 package io.github.doocs.im.util;
 
 import io.github.doocs.im.ClientConfiguration;
+import io.github.doocs.im.model.response.GenericResult;
 import okhttp3.*;
 
 import java.io.IOException;
@@ -31,7 +32,7 @@ public class HttpUtil {
             .writeTimeout(DEFAULT_CONFIG.getWriteTimeout(), TimeUnit.MILLISECONDS)
             .callTimeout(DEFAULT_CONFIG.getCallTimeout(), TimeUnit.MILLISECONDS)
             .retryOnConnectionFailure(false)
-            .addInterceptor(new RetryInterceptor(DEFAULT_CONFIG.getMaxRetries(), DEFAULT_CONFIG.getRetryIntervalMs()))
+            .addInterceptor(new RetryInterceptor(DEFAULT_CONFIG.getMaxRetries(), DEFAULT_CONFIG.getRetryIntervalMs(), null, DEFAULT_CONFIG.isEnableBusinessRetry()))
             .build();
 
     private HttpUtil() {
@@ -58,7 +59,7 @@ private static OkHttpClient getClient(ClientConfiguration config) {
                 .writeTimeout(cfg.getWriteTimeout(), TimeUnit.MILLISECONDS)
                 .callTimeout(cfg.getCallTimeout(), TimeUnit.MILLISECONDS)
                 .retryOnConnectionFailure(false)
-                .addInterceptor(new RetryInterceptor(cfg.getMaxRetries(), cfg.getRetryIntervalMs()))
+                .addInterceptor(new RetryInterceptor(cfg.getMaxRetries(), cfg.getRetryIntervalMs(), null, DEFAULT_CONFIG.isEnableBusinessRetry()))
                 .build());
     }
 
@@ -104,10 +105,14 @@ class RetryInterceptor implements Interceptor {
     private static final int MAX_DELAY_MS = 10000;
     private final int maxRetries;
     private final long retryIntervalMs;
+    private final Set<Integer> businessRetryCodes;
+    private final boolean enableBusinessRetry;
 
-    public RetryInterceptor(int maxRetries, long retryIntervalMs) {
+    public RetryInterceptor(int maxRetries, long retryIntervalMs, Set<Integer> businessRetryCodes, boolean enableBusinessRetry) {
         this.maxRetries = maxRetries;
         this.retryIntervalMs = retryIntervalMs;
+        this.businessRetryCodes = businessRetryCodes;
+        this.enableBusinessRetry = enableBusinessRetry;
     }
 
     @Override
@@ -153,7 +158,13 @@ private boolean shouldRetry(Response response) {
         if (code >= 500 && code < 600) {
             return true;
         }
-        return RETRYABLE_STATUS_CODES.contains(code);
+        if (RETRYABLE_STATUS_CODES.contains(code)) {
+            return true;
+        }
+        if (enableBusinessRetry) {
+            return shouldRetryBasedOnBusinessCode(response);
+        }
+        return false;
     }
 
     private void waitForRetry(int attempt) {
@@ -164,4 +175,18 @@ private void waitForRetry(int attempt) {
             Thread.currentThread().interrupt();
         }
     }
+
+    private boolean shouldRetryBasedOnBusinessCode(Response response) {
+        try {
+            if (businessRetryCodes == null || businessRetryCodes.isEmpty()) {
+                return false;
+            }
+            String responseBody = Objects.requireNonNull(response.body()).string();
+            GenericResult genericResult = JsonUtil.str2Obj(responseBody, GenericResult.class);
+            int businessCode = genericResult.getErrorCode();
+            return businessRetryCodes.contains(businessCode);
+        } catch (IOException | IllegalStateException e) {
+            return false;
+        }
+    }
 }