更好的 Java 重試框架 Sisyphus 配置的兩種方式介紹
這一節(jié)讓我們一起學習下 sisyphus 基于函數(shù)式的配置和注解式的配置。
函數(shù)式配置概覽
為了滿足更加方便的配置,Retryer 類提供了許多可以配置的信息。
默認配置
- /**
- * 默認配置測試
- */
- public void defaultConfigTest() {
- Retryer.<String>newInstance()
- .condition(RetryConditions.hasExceptionCause())
- .retryWaitContext(RetryWaiter.<String>retryWait(NoRetryWait.class).context())
- .maxAttempt(3)
- .listen(RetryListens.noListen())
- .recover(Recovers.noRecover())
- .callable(new Callable<String>() {
- @Override
- public String call() throws Exception {
- System.out.println("called...");
- throw new RuntimeException();
- }
- }).retryCall();
- }
和下面的代碼是等價的:
- public void helloTest() {
- Retryer.<String>newInstance()
- .callable(new Callable<String>() {
- @Override
- public String call() throws Exception {
- System.out.println("called...");
- throw new RuntimeException();
- }
- }).retryCall();
- }
方法說明
condition
重試觸發(fā)的條件,可以指定多個條件。
默認為拋出異常。
retryWaitContext
重試等待的策略,可以指定多個。
默認為不做任何等待。
maxAttempt
指定最大重試次數(shù),包括第一次執(zhí)行。
默認值:3 次。
listen
指定重試的監(jiān)聽實現(xiàn),默認為不做監(jiān)聽。
recover
當重試完成之后,依然滿足重試條件,則可以指定恢復的策略。
默認不做恢復。
callable
待重試執(zhí)行的方法。
retryCall
觸發(fā)重試執(zhí)行。
接口的詳細介紹
接口及其實現(xiàn)
所有的接口,都可以直接查看對應的子類實例。
用戶自定義
基于替換的靈活性,用戶可以實現(xiàn)接口,定義更符合自己業(yè)務的實現(xiàn)。
sisyphus 注解
配置具有很高的靈活性,但是對于開發(fā)人員的使用,就沒有注解那樣簡單靈活。
所以本框架也實現(xiàn)了基于注解的重試。
設計的規(guī)范
保證接口和注解二者的統(tǒng)一性。
maven 引入
- <dependency>
- <groupId>${project.groupId}</groupId>
- <artifactId>sisyphus-annotation</artifactId>
- <version>${project.version}</version>
- </dependency>
注解
核心注解主要有兩個。
Retry
用于指定重試的相關配置。
- /**
- * 重試注解
- * 1. 實際需要,只允許放在方法上。
- * 2. 如果放在接口上,是否所有的子類都生效?為了簡單明確,不提供這種實現(xiàn)。
- * 3. 保持注解和接口的一致性。{@link com.github.houbb.sisyphus.api.core.Retry} 接口
- * @author binbin.hou
- * @since 0.0.3
- */
- @Documented
- @Inherited
- @Target(ElementType.METHOD)
- @Retention(RetentionPolicy.RUNTIME)
- @RetryAble(DefaultRetryAbleHandler.class)
- public @interface Retry {
- /**
- * 重試類實現(xiàn)
- * @return 重試
- * @since 0.0.5
- */
- Class<? extends com.github.houbb.sisyphus.api.core.Retry> retry() default DefaultRetry.class;
- /**
- * 最大嘗試次數(shù)
- * 1. 包含方法第一次正常執(zhí)行的次數(shù)
- * @return 次數(shù)
- */
- int maxAttempt() default 3;
- /**
- * 重試觸發(fā)的場景
- * @return 重試觸發(fā)的場景
- */
- Class<? extends RetryCondition> condition() default ExceptionCauseRetryCondition.class;
- /**
- * 監(jiān)聽器
- * 1. 默認不進行監(jiān)聽
- * @return 監(jiān)聽器
- */
- Class<? extends RetryListen> listen() default NoRetryListen.class;
- /**
- * 恢復操作
- * 1. 默認不進行任何恢復操作
- * @return 恢復操作對應的類
- */
- Class<? extends Recover> recover() default NoRecover.class;
- /**
- * 等待策略
- * 1. 支持指定多個,如果不指定,則不進行任何等待,
- * @return 等待策略
- */
- RetryWait[] waits() default {};
- }
RetryWait
用于指定重試的等待策略。
- package com.github.houbb.sisyphus.annotation.annotation;
- import com.github.houbb.sisyphus.annotation.annotation.metadata.RetryWaitAble;
- import com.github.houbb.sisyphus.annotation.handler.impl.DefaultRetryWaitAbleHandler;
- import com.github.houbb.sisyphus.core.constant.RetryWaitConst;
- import com.github.houbb.sisyphus.core.support.wait.NoRetryWait;
- import java.lang.annotation.*;
- /**
- * 重試等待策略
- * 1. 為了對應重試策略,所有的內置注解應該實現(xiàn)當前的注解。
- * 2. 是否允許自定義注解?
- *
- * 當注解+對象同時出現(xiàn)的時候,視為組合。
- *
- * @author binbin.hou
- * @since 0.0.3
- */
- @Retention(RetentionPolicy.RUNTIME)
- @Inherited
- @Documented
- @Target(ElementType.ANNOTATION_TYPE)
- @RetryWaitAble(DefaultRetryWaitAbleHandler.class)
- public @interface RetryWait {
- /**
- * 默認值
- * 1. fixed 模式,則對應固定等待時間
- * 2. 遞增
- * @return 默認值
- */
- long value() default RetryWaitConst.VALUE_MILLS;
- /**
- * 最小值
- * @return 最小值
- */
- long min() default RetryWaitConst.MIN_MILLS;
- /**
- * 最大值
- * @return 最大值
- */
- long max() default RetryWaitConst.MAX_MILLS;
- /**
- * 影響因數(shù)
- * 1. 遞增重試,默認為 {@link RetryWaitConst#INCREASE_MILLS_FACTOR}
- * 2. 指數(shù)模式。默認為 {@link RetryWaitConst#MULTIPLY_FACTOR}
- * @return 影響因數(shù)
- */
- double factor() default Double.MIN_VALUE;
- /**
- * 指定重試的等待時間 class 信息
- * @return 重試等待時間 class
- */
- Class<? extends com.github.houbb.sisyphus.api.support.wait.RetryWait> retryWait() default NoRetryWait.class;
- }
注解的使用
定義好了注解,肯定要有注解的相關使用。
關于注解的使用,主要有兩種方式。
Proxy+CGLIB
基于代理模式和字節(jié)碼增強。
如果是項目中沒有使用 spring,直接使用這種方式比較方便。
Spring-AOP
可以和 spring 直接整合。
使用方式和 spring-retry 是一樣的。
這些內容將放在下一節(jié)進行詳細講解。
小結
靈活的配置才能更加符合實際生產使用中的各種需求。
一般實際使用推薦使用注解的配置方式,非常的簡單方便。