準備好好看看一下spring-cloud的源碼啰脚,把其中實現(xiàn)的原理搞清楚,而不是僅僅會配幾個注解实夹,會配幾個參數(shù)橄浓,把“微服務”框架搭建起來。在查看其中pom的的依賴關系時亮航,發(fā)現(xiàn)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對于重試機制的實現(xiàn)畔规,給了幾個抽象。
- BackOff:補償值讹剔,一般指失敗后多久進行重試的延遲值油讯。
- Sleeper:暫停應用的工具详民,通常用來應用補償值。
- BackOffPolicy:補償策略陌兑,決定失敗后如何確定補償值沈跨。
- RetryContext:重試上下文,代表了能被重試動作使用的資源兔综。
- RetryPolicy:重試策略饿凛,決定失敗能否重試。
- RecoveryCallback:定義一個動作recover软驰,在重試耗盡后的動作涧窒。
- RetryCallback:具體的重試動作。
- RetryOperations:通過傳遞RetryCallback锭亏,進行重試操作纠吴。
- RetryState:重試狀態(tài),通常包含一個重試的鍵值慧瘤。
- RetryStatistics和RetryListener戴已,用來監(jiān)控Retry的執(zhí)行情況,并生成統(tǒng)計信息锅减。
二糖儡、聲明式使用
官方給的代碼如下:
@Configuration
@EnableRetry
public class Application {
@Bean
public Service service() {
return new Service();
}
}
@Service
class Service {
@Retryable(RemoteAccessException.class)
public void service() {
// ... do something
}
@Recover
public void recover(RemoteAccessException e) {
// ... panic
}
}
通過@EnableRetry就可以啟用Retry功能了,需要被重試的方法加上@Retryable(),就能在指定的異常出現(xiàn)情況下重試怔匣,而當默認的失敗次數(shù)到達后(查看SimpleRetryPolicy可知握联,就是試3次),就會調(diào)用@Recover注解的方法每瞒,進行恢復金闽。
當然在@Retryable上,可以配置屬性独泞,更加細化
例如:@Retryable(value= {RemoteAccessException.class},maxAttempts = 5,backoff = @Backoff(delay = 5000l,multiplier = 1))
指定呐矾,重試5次,每次補償(延遲5秒)懦砂,每次倍數(shù)為1(不變)。
幾個注解的參數(shù)解釋
@EnableRetry能否重試组橄。當proxyTargetClass屬性為true時荞膘,使用CGLIB代理。默認使用標準JAVA注解玉工。在spring Boot中此參數(shù)寫在程序入口即可羽资。
@Retryable 標注此注解的方法在發(fā)生異常時會進行重試
- value:指定處理的異常類
- include:指定處理的異常類和value一樣,默認為空遵班,當exclude也為空時屠升,默認所有異常
- exclude:指定異常不處理潮改,默認空,當include也為空時腹暖,默認所有異常
- maxAttempts:最大重試次數(shù)汇在。默認3次
-backoff: 重試補償策略。默認使用@Backoff注解
@Backoff 重試補償策略
- 不設置參數(shù)時脏答,默認使用FixedBackOffPolicy(指定等待時間)糕殉,重試等待1000ms
- 設置delay,使用FixedBackOffPolicy(指定等待- - 設置delay和maxDealy時,重試等待在這兩個值之間均態(tài)分布
- 設置delay殖告、maxDealy阿蝶、multiplier,使用 ExponentialBackOffPolicy(指數(shù)級重試間隔的實現(xiàn) )黄绩,multiplier即指定延遲倍數(shù)羡洁,比如delay=5000l,multiplier=2,則第一次重試為5秒,第二次為10秒爽丹,第三次為20秒
@Recover 用于@Retryable重試失敗后處理方法焚廊,此注解注釋的方法參數(shù)一定要是@Retryable拋出的異常,否則無法識別习劫,可以在該方法中進行日志處理咆瘟。
三、核心API-RetryTemplate
聲明式的使用诽里,實際上是由spring-retry在內(nèi)部生成了一個默認的RetryTemplate袒餐,由它封裝我們自己寫的函數(shù)完成的重試。這有點像@Scheduled谤狡,內(nèi)部生成了一個ThreadPoolTaskExecutor完成定時任務的調(diào)度灸眼。雖然簡單,但是可配置的東西太少了墓懂,如果想用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對象后匕积,可以給它設置重試策略、補償策略榜跌、重試監(jiān)聽器等屬性闪唆。核心是在template.execute(),傳遞一個RetryCallback,內(nèi)部執(zhí)行我們需要重試的具體方法钓葫。
RetryTemplate是標準spring的××Template風格(腦補jdbcTemplate)悄蕾,內(nèi)部doExecute()方法實現(xiàn)了如何開啟重試上下文,獲取補償上下文础浮,在try/catch中執(zhí)行doWithRetry(),出現(xiàn)異常捕捉下來帆调,如何應用重試策略決定重試奠骄,最后如何應用回退方法,關閉上下文等番刊。這些都模板化了含鳞,我們只需要要傳入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