feat: 优化 RetryTemplate 配置

Author: cadecode

framework/src/main/java/com/github/cadecode/uniboot/framework/config/RetryConfig.java

@@ -1,11 +1,10 @@
 package com.github.cadecode.uniboot.framework.config;
 
+import com.github.cadecode.uniboot.framework.exception.RetryableException;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Primary;
 import org.springframework.retry.annotation.EnableRetry;
-import org.springframework.retry.backoff.ExponentialBackOffPolicy;
-import org.springframework.retry.policy.SimpleRetryPolicy;
 import org.springframework.retry.support.RetryTemplate;
 
 /**
@@ -19,22 +18,45 @@
 public class RetryConfig {
 
     /**
-     * 重试模板，重试三次
+     * 默认重试模板，所有异常类型
+     * 重试 5 次，间隔 1 秒，每次间隔时间 x2
      */
     @Primary
     @Bean
-    public RetryTemplate retryTemplate3Times() {
-        RetryTemplate retryTemplate = new RetryTemplate();
-        SimpleRetryPolicy simpleRetryPolicy = new SimpleRetryPolicy();
-        simpleRetryPolicy.setMaxAttempts(3);
-        retryTemplate.setRetryPolicy(simpleRetryPolicy);
-        // 延迟规则
-        // 初次重试间隔 1 秒，后面每次乘以 2
+    public RetryTemplate retryTemplate() {
+        /*
+        SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy();
+        retryPolicy.setMaxAttempts(3);
         ExponentialBackOffPolicy backOffPolicy = new ExponentialBackOffPolicy();
         backOffPolicy.setInitialInterval(1000L);
+        backOffPolicy.setMaxInterval(10000L);
         backOffPolicy.setMultiplier(2);
+        RetryTemplate retryTemplate = new RetryTemplate();
+        retryTemplate.setRetryPolicy(retryPolicy);
         retryTemplate.setBackOffPolicy(backOffPolicy);
-        return retryTemplate;
+        */
+
+        // 使用 builder 模式代替以上代码
+        return RetryTemplate.builder()
+                .maxAttempts(5)
+                .retryOn(Exception.class)
+                .exponentialBackoff(1000L, 2, 30000L)
+                .build();
     }
 
+    /**
+     * 指定异常类型的重试模板，只重试异常类型或异常 cause 为 RetryableException
+     * 通过抛出 RetryableException 实现自定义控制重试逻辑
+     * 重试 5 次，间隔 1 秒，每次间隔时间 x2
+     */
+    @Bean
+    public RetryTemplate retryTemplateOnRetryable() {
+        return RetryTemplate.builder()
+                .maxAttempts(5)
+                .retryOn(RetryableException.class)
+                // 开启 cause 穿透，可根据 cause 判断
+                .traversingCauses()
+                .exponentialBackoff(1000L, 2, 30000L)
+                .build();
+    }
 }

framework/src/main/java/com/github/cadecode/uniboot/framework/exception/RetryableException.java

@@ -0,0 +1,38 @@
+package com.github.cadecode.uniboot.framework.exception;
+
+import lombok.Getter;
+
+/**
+ * 可重试异常
+ *
+ * @author Cade Li
+ * @date 2023/7/4
+ */
+@Getter
+public class RetryableException extends RuntimeException {
+
+    /**
+     * 用于传递重试中的状态信息
+     */
+    private final Object state;
+
+    public RetryableException(String message, Object state) {
+        super(message);
+        this.state = state;
+    }
+
+    public RetryableException(String message, Throwable cause, Object state) {
+        super(message, cause);
+        this.state = state;
+    }
+
+    public RetryableException(Throwable cause, Object state) {
+        super(cause);
+        this.state = state;
+    }
+
+    public RetryableException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace, Object state) {
+        super(message, cause, enableSuppression, writableStackTrace);
+        this.state = state;
+    }
+}