6-Retry-zh.md

← 超时配置 | 重试机制(English) | 异常处理 →

---

重试机制

默认

• autoRetry - true（默认开启重试）
• minRetryDelayMs - 300
• maxRetryDelayMs - 300 * 1000
• retryCondition - com.volcengine.retryer.DefaultRetryCondition
• backoffStrategy - com.volcengine.retryer.ExponentialWithRandomJitterBackoffStrategy
• retryErrorCode - empty set

请求的处理逻辑内置了网络异常重试逻辑，即当遇到网络异常问题或限流错误时，系统会自动尝试重新发起请求，以确保服务的稳定性和可靠性。若请求因业务逻辑错误而报错，例如参数错误、资源不存在等情况，SDK 将不会执行重试操作，这是因为业务层面的错误通常需要应用程序根据具体的错误信息做出相应的处理或调整，而非简单地重复尝试。

重试代码配置

import com.volcengine.ApiClient;
import com.volcengine.retryer.DefaultRetryCondition;
import com.volcengine.retryer.ExponentialBackoffStrategy;
import com.volcengine.sign.Credentials;

public class SampleCode {
    public static void main(String[] args) {
        String region = "cn-beijing";

        ApiClient apiClient = new ApiClient()
            .setCredentials(Credentials.getEnvCredentials())
            .setRegion(region)
            .setDebugging(true)
            .setAutoRetry(true) // 开启重试
            .setNumMaxRetries(3) // 最大重试次数
            .setMinRetryDelayMs(1000) // 最小重试间隔
            .setMaxRetryDelayMs(3000) // 最大重试间隔
            .setRetryCondition(new DefaultRetryCondition()) // 重试条件
            .setBackoffStrategy(new ExponentialBackoffStrategy()) // 重试间隔策略
            .addRetryErrorCode("InvalidAuthorization") // 重试错误码
            /*.addRetryErrorCodes(new HashSet<String>(){{
                add("InvalidAuthorization");
                add("InvalidAccessKeyId");
            }})*/
        ;
    }

}

重试条件

重试条件定义了哪些情况下需要进行重试。SDK 内置了默认的重试条件，用户也可以根据自己的业务需求，自定义重试条件。

默认重试条件

默认重试条件 DefaultRetryCondition，其中包含以下重试条件：

1. 网络错误会进行重试。
2. 服务端限流错误会进行重试。
3. 包含客户自定义的错误码 retryErrorCodes。

自定义重试条件

用户可以根据自己的业务需求，自定义重试条件。

代码示例：

1. 继承基类 RetryCondition，实现 boolean shouldRetry(ApiResponse response, Exception error)：

   import com.volcengine.retryer.RetryCondition;
   
   public abstract class CustomRetryCondition extends RetryCondition {
       @Override
       public boolean shouldRetry(ApiResponse response, Exception error) {
           // #................实现自己逻辑
           return false;
       }
   }

2. 复用默认 DefaultRetryCondition 逻辑：

   import com.volcengine.retryer.DefaultRetryCondition;
   
   public class CustomRetryCondition extends DefaultRetryCondition{
       @Override
       public boolean shouldRetry(ApiResponse response, Exception error) {
           boolean shouldRetry = super.shouldRetry(response, error);
           // #................实现自己逻辑
           return false;
       }
   
   }

退避策略

退避策略定义了在重试时，每次重试之间的延迟时间。SDK 内置了默认的退避策略，用户也可以根据自己的业务需求，自定义退避策略。

默认

ExponentialWithRandomJitterBackoffStrategy

内置退避策略

边界值说明：minRetryDelay 最小延迟时间，maxRetryDelay 最大延迟时间，n 为重试次数。

策略名称	说明	公式
NoBackoffStrategy	不使用退避。每次重试立即执行，零延时。	delay = 0.0
ExponentialBackoffStrategy	每次重试延时按 2ⁿ 级数增长，受最小/最大延时约束。可快速降低请求频率。	delay = min(minRetryDelay * 2ⁿ, maxRetryDelay)
ExponentialWithRandomJitterBackoffStrategy	在 [base, 2·base] 之间取值：始终 ≥ base，抖动幅度与基线等宽。	base = min(minRetryDelay · 2ⁿ, maxRetryDelay) delay = base + U(0, base)

自定义退避策略

用户可以根据自己的需求，自定义退避策略。

代码示例：

1. 继承基类 BackoffStrategy，实现函数 public long computeDelay(int retryCount)：

   import com.volcengine.retryer.BackoffStrategy;
   
   class CustomBackoffStrategy extends BackoffStrategy {
       public long computeDelay(int retryCount){
           long minRetryDelayMs = this.minRetryDelayMs;
           long maxRetryDelayMs = this.maxRetryDelayMs;
           // ....实现自己逻辑
           return 0;
       }
   }

2. 也可以复用内置退避策略 ExponentialBackoffStrategy 或 ExponentialWithRandomJitterBackoffStrategy：

   import com.volcengine.retryer.ExponentialWithRandomJitterBackoffStrategy;
   
   class CustomBackoffStrategy extends ExponentialWithRandomJitterBackoffStrategy{
       public long computeDelay(int retryCount){
           long base = super.computeDelay(retryCount); // 调用父类的实现
           long minRetryDelayMs = this.minRetryDelayMs;
           long maxRetryDelayMs = this.maxRetryDelayMs;
           // ....实现自己逻辑
           return 0;
       }
   }

---

← 超时配置 | 重试机制(English) | 异常处理 →