準備好好看看一下spring-cloud的源碼,把其中實現的原理搞清楚,而不是僅僅會配幾個註解,會配幾個參數,把“微服務”框架搭建起來。在查看其中pom的的依賴關係時,發現spring-cloud對於spring不僅僅是bean,aop,context等,居然spring-cloud-commons依賴了一個spring-retry的東西。
官方定義:
This project provides declarative retry support for Spring applications. It is used in Spring Batch, Spring Integration, Spring for Apache Hadoop (amongst others).
該項目給spring應用提供了聲明式的重試支持。它被使用在spring批處理,spring集成,Apache Hadoop集成pring幾個項目中。
一、概念
spring對於重試機制的實現,給了幾個抽象。
- BackOff:補償值,一般指失敗後多久進行重試的延遲值。
- Sleeper:暫停應用的工具,通常用來應用補償值。
- BackOffPolicy:補償策略,決定失敗後如何確定補償值。
- RetryContext:重試上下文,代表了能被重試動作使用的資源。
- RetryPolicy:重試策略,決定失敗能否重試。
- RecoveryCallback:定義一個動作recover,在重試耗盡後的動作。
- RetryCallback:具體的重試動作。
- RetryOperations:通過傳遞RetryCallback,進行重試操作。
- RetryState:重試狀態,通常包含一個重試的鍵值。
- RetryStatistics和RetryListener,用來監控Retry的執行情況,並生成統計信息。
二、聲明式使用
1 2 3 4 5 6 7 8 9 10 |
|
官方給的代碼如下:
@Configuration
@EnableRetry
public class Application {
@Bean
public Service service() {
return new Service();
}
}
@Service
class Service {
@Retryable(RemoteAccessException.class)
public void service() {
// ... do something
}
//spring-retry @Recover不執行2個方法返回值一致就ok了
//返回值和@Retryable的返回值一致,入參和拋出異常一致
@Recover
public void recover(RemoteAccessException e) {
// ... panic
}
}
通過@EnableRetry就可以啓用Retry功能了,需要被重試的方法加上@Retryable(),就能在指定的異常出現情況下重試,而當默認的失敗次數到達後(查看SimpleRetryPolicy可知,就是試3次),就會調用@Recover註解的方法,進行恢復。
當然在@Retryable上,可以配置屬性,更加細化
例如:@Retryable(value= {RemoteAccessException.class},maxAttempts = 5,backoff = @Backoff(delay = 5000l,multiplier = 1))
指定,重試5次,每次補償(延遲5秒),每次倍數爲1(不變)。
幾個註解的參數解釋
@EnableRetry能否重試。當proxyTargetClass屬性爲true時,使用CGLIB代理。默認使用標準JAVA註解。在spring Boot中此參數寫在程序入口即可。
@Retryable 標註此註解的方法在發生異常時會進行重試
- value:指定處理的異常類
- include:指定處理的異常類和value一樣,默認爲空,當exclude也爲空時,默認所有異常
- exclude:指定異常不處理,默認空,當include也爲空時,默認所有異常
- maxAttempts:最大重試次數。默認3次
-backoff: 重試補償策略。默認使用@Backoff註解
@Backoff 重試補償策略
- 不設置參數時,默認使用FixedBackOffPolicy(指定等待時間),重試等待1000ms
- 設置delay,使用FixedBackOffPolicy(指定等待- - 設置delay和maxDealy時,重試等待在這兩個值之間均態分佈
- 設置delay、maxDealy、multiplier,使用 ExponentialBackOffPolicy(指數級重試間隔的實現 ),multiplier即指定延遲倍數,比如delay=5000l,multiplier=2,則第一次重試爲5秒,第二次爲10秒,第三次爲20秒
@Recover 用於@Retryable重試失敗後處理方法,此註解註釋的方法參數一定要是@Retryable拋出的異常,否則無法識別,可以在該方法中進行日誌處理。
三、核心API-RetryTemplate
聲明式的使用,實際上是由spring-retry在內部生成了一個默認的RetryTemplate,由它封裝我們自己寫的函數完成的重試。這有點像@Scheduled,內部生成了一個ThreadPoolTaskExecutor完成定時任務的調度。雖然簡單,但是可配置的東西太少了,如果想用spring-retry強大的策略機制,並必須定製化RetryTemplate。
官方的API使用demo如下:
RetryTemplate template = new RetryTemplate();
TimeoutRetryPolicy policy = new TimeoutRetryPolicy();
policy.setTimeout(30000L);
template.setRetryPolicy(policy);
Foo result = template.execute(new RetryCallback<Foo>() {
public Foo doWithRetry(RetryContext context) {
// Do stuff that might fail, e.g. webservice operation
return result;
}
});
可以看出,new出一個RetryTemplate對象後,可以給它設置重試策略、補償策略、重試監聽器等屬性。核心是在template.execute(),傳遞一個RetryCallback,內部執行我們需要重試的具體方法。
RetryTemplate是標準spring的××Template風格(腦補jdbcTemplate),內部doExecute()方法實現瞭如何開啓重試上下文,獲取補償上下文,在try/catch中執行doWithRetry(),出現異常捕捉下來,如何應用重試策略決定重試,最後如何應用回退方法,關閉上下文等。這些都模板化了,我們只需要要傳入RetryCallback和RecoveryCallback(連這個也可省)。
參考:
- 官方項目頁面
https://github.com/spring-projects/spring-retry - spring-retry
http://www.itclj.com/blog/59940a4081c06e672f942ae1 - Spring Retry
https://www.cnblogs.com/jtlgb/p/6813164.html - spring-retry重試與熔斷詳解
https://yq.aliyun.com/articles/92899