前言
spring retry是從spring batch獨立出來的一個能功能，主要實現了重試和熔斷。對於重試是有場景限制的，不是什麼場景都適合重試，比如參數校驗不合法、寫操作等（要考慮寫是否冪等）都不適合重試。遠程調用超時、網絡突然中斷可以重試。在微服務治理框架中，通常都有自己的重試與超時配置，比如dubbo可以設置retries=1，timeout=500調用失敗只重試1次，超過500ms調用仍未返回則調用失敗。在spring retry中可以指定需要重試的異常類型，並設置每次重試的間隔以及如果重試失敗是繼續重試還是熔斷（停止重試）。目前在spring cloud中已經滲透到諸多組件，如ribbon等，故本章對原生spring-retry的應用做個簡單的梳理和案例分析。
本章概要
1、設計實現原理
2、案例實踐：
- 重試策略：SimpleRetryPolicy固定重試次數
- 重試策略：SimpleRetryPolicy固定重試次數
- 重試策略：AlwaysRetryPolicy無限重試
- 重試策略：TimeoutRetryPolicy超時重試
- 重試策略：根據返回結果值實現重試
- 重試策略：啓用熔斷器重試策略
- 通過RetryListener實現攔截器模式
- 採用註解方式實現
設計實現原理
重試的定義：RetryOperations定義重試的API，RetryTemplate是API的模板模式實現，實現了重試和熔斷。提供的API如下：
RetryCallback定義了需要執行重試的操作，定義好操作後，就是如何重試的問題了。RetryTemplate通過制定不同的重試策略來執行如何重試的邏輯。默認的重試策略是SimpleRetryPlicy，也就是會重試3次。重試第1次如果成功後面就不會繼續重試了。那麼如果3尺都重試失敗了呢？流程結束或者返回兜底結果。要返回兜底結果需要配置RecoveyCallBack，從名字可以看出這是一個兜底回調接口，也就是重試失敗後執行的邏輯。
重試策略，除了SimpleRetryPolicy還有其他重試策略，先來看下RetryPolicy接口：
方法說明：
- canRetry：在每次重試的時候調用，是否可以繼續重試的判斷條件
- open：重試開始前調用，會創建一個重試上下文到RetryContext，保存重試的堆棧等信息
- registerThrowable：每次重試異常時調用（有異常會繼續重試）
以SimpleRetryPolicy爲例，當重試次數達到3（默認3次）停止重試，重試次數保存在重試上下文中。
所有重試策略實現如下：
- NeverRetryPolicy：只允許調用RetryCallback一次，不允許重試
- AlwaysRetryPolicy：允許無限重試，直到成功，此方式邏輯不當會導致死循環
- SimpleRetryPolicy：固定次數重試策略，默認重試最大次數爲3次，RetryTemplate默認使用的策略
- TimeoutRetryPolicy：超時時間重試策略，默認超時時間爲1秒，在指定的超時時間內允許重試
- ExceptionClassifierRetryPolicy：設置不同異常的重試策略，類似組合重試策略，區別在於這裏只區分不同異常的重試
- CircuitBreakerRetryPolicy：有熔斷功能的重試策略，需設置3個參數openTimeout、resetTimeout和delegate
- CompositeRetryPolicy：組合重試策略，有兩種組合方式，樂觀組合重試策略是指只要有一個策略允許重試即可以，悲觀組合重試策略是指只要有一個策略不允許重試即可以，但不管哪種組合方式，組合中的每一個策略都會執行
重試回退(等待)策略，指的是每次重試是立即重試還是等待一段時間後重試。默認情況下是立即重試，如果需要配置等待一段時間後重試則需要指定回退策略BackOffPolicy。BackOffPolicy有如下實現：
- NoBackOffPolicy：無退避算法策略，每次重試時立即重試
- FixedBackOffPolicy：固定時間的退避策略，需設置參數sleeper和backOffPeriod，sleeper指定等待策略，默認是Thread.sleep，即線程休眠，backOffPeriod指定休眠時間，默認1秒
- UniformRandomBackOffPolicy：隨機時間退避策略，需設置sleeper、minBackOffPeriod和maxBackOffPeriod，該策略在[minBackOffPeriod,maxBackOffPeriod之間取一個隨機休眠時間，minBackOffPeriod默認500毫秒，maxBackOffPeriod默認1500毫秒
- ExponentialBackOffPolicy：指數退避策略，需設置參數sleeper、initialInterval、maxInterval和multiplier，initialInterval指定初始休眠時間，默認100毫秒，maxInterval指定最大休眠時間，默認30秒，multiplier指定乘數，即下一次休眠時間爲當前休眠時間*multiplier
- ExponentialRandomBackOffPolicy：隨機指數退避策略，引入隨機乘數可以實現隨機乘數回退
有狀態重試 OR 無狀態重試
所謂無狀態重試是指重試在一個線程上下文中完成的重試，反之不在一個線程上下文完成重試的就是有狀態重試。之前的SimpleRetryPolicy就屬於無狀態重試，因爲重試是在一個循環中完成的。那麼什麼會後會出現或者說需要有狀態重試呢？通常有兩種情況：事務回滾和熔斷。
如數據庫操作異常DataAccessException，則不能執行重試，而如果拋出其他異常可以重試。
熔斷的意思不在當前循環中處理重試，而是全局重試模式（不是線程上下文）。熔斷會跳出循環，那麼必然會丟失線程上下文的堆棧信息。那麼肯定需要一種“全局模式”保存這種信息，目前的實現放在一個cache（map實現的）中，下次從緩存中獲取就能繼續重試了。
案例實踐
場景描述：i作爲計數器，如果i小於5則拋出異常，i會進行自增一操作，直到等於5方正常返回，否則根據重試策略進行重試操作，如果直到最後一直未重試成功，則返回Integer最大值。在重試上下文中添加一個value變量，後續通過其值實現根據返回值判斷重試應用。最後打印最終的返回值。
示例代碼：
private void run(RetryTemplate retryTemplate) throws Exception {
Integer result = retryTemplate.execute(new RetryCallback<Integer, Exception>() {
int i = 0;
// 重試操作
@Override
public Integer doWithRetry(RetryContext retryContext) throws Exception {
retryContext.setAttribute("value", i);
LOGGER.info("retry {} times.", retryContext.getRetryCount());
return len(i++);
}
}, new RecoveryCallback<Integer>() { //兜底回調
@Override
public Integer recover(RetryContext retryContext) throws Exception {
LOGGER.info("after retry {} times, recovery method called!", retryContext.getRetryCount());
return Integer.MAX_VALUE;
}
});
LOGGER.info("final result: {}", result);
}
private int len(int i) throws Exception {
if (i < 5) throw new Exception(i + " le 5");
return i;
}
重試策略：SimpleRetryPolicy固定重試次數
示例代碼：
@Test
public void retryFixTimes() throws Exception {
RetryTemplate retryTemplate = new RetryTemplate();
SimpleRetryPolicy simpleRetryPolicy = new SimpleRetryPolicy();
simpleRetryPolicy.setMaxAttempts(3);
retryTemplate.setRetryPolicy(simpleRetryPolicy);
run(retryTemplate);
}
打印：
超過3次最大重試次數，觸發了recoveryCall，並返回Integer最大值。
重試策略：AlwaysRetryPolicy無限重試
示例代碼：
@Test
public void retryAlwaysTimes() throws Exception {
RetryTemplate retryTemplate = new RetryTemplate();
retryTemplate.setRetryPolicy(new AlwaysRetryPolicy());
run(retryTemplate);
}
打印：
直達i等於5則正常返回，之前將實現無限重試。
重試策略：TimeoutRetryPolicy超時重試
TimeoutRetryPolicy策略定義：重試累計運行時長在設定的timeout範圍內則重試，一旦超出則不再重試直接執行RecoveryCallback。
@Test
public void retryTimeout() throws Exception {
RetryTemplate retryTemplate = new RetryTemplate();
TimeoutRetryPolicy timeoutRetryPolicy = new TimeoutRetryPolicy();
timeoutRetryPolicy.setTimeout(1000);
retryTemplate.setRetryPolicy(timeoutRetryPolicy);
FixedBackOffPolicy fixedBackOffPolicy = new FixedBackOffPolicy();
fixedBackOffPolicy.setBackOffPeriod(400);
retryTemplate.setBackOffPolicy(fixedBackOffPolicy);
run(retryTemplate);
}
打印：
設定1000ms後則認定爲超時，每次重試等待時長400ms，故重試3次後即會超出超時閾值，觸發RecoveryCallback回調，並返回Integer最大值。
重試策略：根據返回結果值實現重試
@Test
public void retryWithResult() throws Exception {
RetryTemplate retryTemplate = new RetryTemplate();
retryTemplate.setRetryPolicy(new AlwaysRetryPolicy() {
private static final long serialVersionUID = 1213824522266301314L;
@Override
public boolean canRetry(RetryContext context) {
//小於1則重試
return context.getAttribute("value") == null || Integer.parseInt(context.getAttribute("value").toString()) < 1;
}
});
run(retryTemplate);
}
打印：
如果value值小於1或者爲null則進行重試，反之不在進行重試，觸發RecoveryCallback回調，並返回Integer最大值。
重試策略：啓用熔斷器重試策略
首先來看CircuitBreakerRetryPolicy定義
需要設置如下三個參數：
- delegate：傳入RetryPolicy（每個RetryPolicy實現都有自己的重試策略實現），是真正判斷是否重試的策略，當重試失敗時，則執行熔斷策略；
- openTimeout：openWindow，配置熔斷器電路打開的超時時間，當超過openTimeout之後熔斷器電路變成半打開狀態（只要有一次重試成功，則閉合電路）；
- resetTimeout：timeout，配置重置熔斷器重新閉合的超時時間；
斷路器判斷實現：
可以理解爲如下：
- 當重試失敗，且在熔斷器打開時間窗口[0,openWindow) 內，立即熔斷
- 當重試失敗，且超過timeout，熔斷器電路重新閉合
- 在熔斷器半打開狀態[openWindow, timeout] 時，只要重試成功則重置上下文，斷路器閉合
示例代碼：
@Test
public void retryCircuitBreakerTest() {
RetryTemplate retryTemplate = new RetryTemplate();
CircuitBreakerRetryPolicy retryPolicy =
new CircuitBreakerRetryPolicy(new SimpleRetryPolicy(4));
FixedBackOffPolicy fixedBackOffPolicy = new FixedBackOffPolicy();
fixedBackOffPolicy.setBackOffPeriod(300);
retryTemplate.setBackOffPolicy(fixedBackOffPolicy);
retryPolicy.setOpenTimeout(1500);
retryPolicy.setResetTimeout(2000);
retryTemplate.setRetryPolicy(retryPolicy);
long startTime = System.currentTimeMillis();
IntStream.range(0, 10).forEach(index -> {
try {
Thread.sleep(100);
RetryState state = new DefaultRetryState("circuit", false);
String result = retryTemplate.execute(new RetryCallback<String, RuntimeException>() {
@Override
public String doWithRetry(RetryContext context) throws RuntimeException {
LOGGER.info("retry {} times", context.getRetryCount());
if (System.currentTimeMillis() - startTime > 1300 && System.currentTimeMillis() - startTime < 1500) {
return "success";
}
throw new RuntimeException("timeout");
}
}, new RecoveryCallback<String>() {
@Override
public String recover(RetryContext context) throws Exception {
return "default";
}
}, state);
LOGGER.info("result: {}", result);
} catch (Exception e) {
LOGGER.error("error: {}", e.getMessage());
}
});
}
打印：
設定重試次數爲4次，在執行1300ms至1500ms期間連續兩次調用成功，無需重試，其後繼續拋出異常重試，第4次重試時（1405）仍然在1500ms內，故打開了斷路器，後續請求異常均會直接返回RecoveryCallback中回調定義。
Note：
- 如果採用無限重試策略則沒有意義，將不會觸發斷路器；
- 必須符合[0,openWindow)時間內重試失敗方會發開斷路器；
通過RetryListener實現攔截器模式
通過RetryListener實現攔截器模式，默認提供了StatisticsListener實現重試操作統計分析數據，如下示例：
@Test
public void retryListeners() {
RetryTemplate template = new RetryTemplate();
DefaultStatisticsRepository repository = new DefaultStatisticsRepository();
StatisticsListener listener = new StatisticsListener(repository);
template.setListeners(new RetryListener[]{listener});
for (int i = 0; i < 10; i++) {
String result = template.execute(new RetryCallback<String, RuntimeException>() {
@Override
public String doWithRetry(RetryContext context) throws RuntimeException {
context.setAttribute(RetryContext.NAME, "method.key");
return "ok";
}
});
}
RetryStatistics statistics = repository.findOne("method.key");
System.out.println(statistics);
}
打印：
採用註解方式實現
以上採用硬編碼方式定義實現，整體看起來代碼非常的不優雅，Spring已經爲我們提供了註解方式，本小節將基於springboot實現一個註解方式案例：
1、通過@EnableRetry註解啓動類：
@SpringBootApplication
@EnableRetry(proxyTargetClass = true)
public class SpringRetryApp {
}
2、如下通過@Retryable註解一個待重試方法，並@Recover註解定義一個對應的Recover方法：
@Component
public class SpringRetryService {
private static final Logger LOGGER = LoggerFactory.getLogger(SpringRetryService.class);
@Retryable(value = Exception.class, maxAttempts = 4, backoff = @Backoff(value = 0L))
public void run() throws Exception {
LOGGER.info("do sth");
throw new Exception("error");
}
@Recover
private void recover(Exception e) {
LOGGER.info("invoke recover");
}
}
Note：
- Recover方法必須與源方法保持一樣的參數列表定義，並添加一個Throwable作爲異常信息傳遞；
3、編寫一個測試方法：
@Autowired
private SpringRetryService springRetryService;
@Test
public void retryWithAnnotation() throws Exception {
springRetryService.run();
}
4、打印：
如上重試4次，並調用了Recover回調返回值。
5、更多的註解說明：
- @EnableRetry
- @Retryable
- @Recover
- @Backoff
- @CircuitBreaker
- @EnableRetry：能否重試，proxyTargetClass屬性爲true時（默認false），使用CGLIB代理
- @Retryable：註解需要被重試的方法
include 指定處理的異常類。默認爲空
exclude指定不需要處理的異常。默認爲空
vaue指定要重試的異常。默認爲空
maxAttempts 最大重試次數。默認3次
backoff 重試等待策略。默認使用@Backoff註解
- @Backoff：重試回退策略（立即重試還是等待一會再重試）
不設置參數時，默認使用FixedBackOffPolicy，重試等待1000ms
只設置delay()屬性時，使用FixedBackOffPolicy，重試等待指定的毫秒數
當設置delay()和maxDealy()屬性時，重試等待在這兩個值之間均態分佈
使用delay()，maxDealy()和multiplier()屬性時，使用ExponentialBackOffPolicy
當設置multiplier()屬性不等於0時，同時也設置了random()屬性時，使用ExponentialRandomBackOffPolicy
- @Recover: 用於方法。用於@Retryable失敗時的“兜底”處理方法。 @Recover註釋的方法必須要與@Retryable註解的方法“簽名”保持一致，第一入參爲要重試的異常，其他參數與@Retryable保持一致，返回值也要一樣，否則無法執行！
- @CircuitBreaker：用於方法，實現熔斷模式。
include 指定處理的異常類。默認爲空
exclude指定不需要處理的異常。默認爲空
vaue指定要重試的異常。默認爲空
maxAttempts 最大重試次數。默認3次
openTimeout 配置熔斷器打開的超時時間，默認5s，當超過openTimeout之後熔斷器電路變成半打開狀態（只要有一次重試成功，則閉合電路）
resetTimeout 配置熔斷器重新閉合的超時時間，默認20s，超過這個時間斷路器關閉
6、源碼淺析：
- @Retryable註解實現源碼主要參考AnnotationAwareRetryOperationsInterceptor實現，定義如下：
- @Recover註解實現源碼主要參考RecoverAnnotationRecoveryHandler實現，定義如下：
@Retryable和@Recover註解是如何關聯起來的呢，正是上述findClosestMatch和calculateDistance。