spring-retry(1.概念和基本用法)


準備好好看看一下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)畔规,給了幾個抽象。

  1. BackOff:補償值讹剔,一般指失敗后多久進行重試的延遲值油讯。
  2. Sleeper:暫停應用的工具详民,通常用來應用補償值。
  3. BackOffPolicy:補償策略陌兑,決定失敗后如何確定補償值沈跨。
  4. RetryContext:重試上下文,代表了能被重試動作使用的資源兔综。
  5. RetryPolicy:重試策略饿凛,決定失敗能否重試。
  6. RecoveryCallback:定義一個動作recover软驰,在重試耗盡后的動作涧窒。
  7. RetryCallback:具體的重試動作。
  8. RetryOperations:通過傳遞RetryCallback锭亏,進行重試操作纠吴。
  9. RetryState:重試狀態(tài),通常包含一個重試的鍵值慧瘤。
  10. 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(連這個也可省)。

參考:

?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末撵枢,一起剝皮案震驚了整個濱河市民晒,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌锄禽,老刑警劉巖潜必,帶你破解...
    沈念sama閱讀 222,183評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異沃但,居然都是意外死亡磁滚,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,850評論 3 399
  • 文/潘曉璐 我一進店門宵晚,熙熙樓的掌柜王于貴愁眉苦臉地迎上來垂攘,“玉大人,你說我怎么就攤上這事淤刃∩顾” “怎么了?”我有些...
    開封第一講書人閱讀 168,766評論 0 361
  • 文/不壞的土叔 我叫張陵逸贾,是天一觀的道長陨仅。 經(jīng)常有香客問我,道長铝侵,這世上最難降的妖魔是什么灼伤? 我笑而不...
    開封第一講書人閱讀 59,854評論 1 299
  • 正文 為了忘掉前任,我火速辦了婚禮咪鲜,結(jié)果婚禮上狐赡,老公的妹妹穿的比我還像新娘。我一直安慰自己疟丙,他們只是感情好颖侄,可當我...
    茶點故事閱讀 68,871評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著隆敢,像睡著了一般发皿。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上拂蝎,一...
    開封第一講書人閱讀 52,457評論 1 311
  • 那天,我揣著相機與錄音惶室,去河邊找鬼温自。 笑死玄货,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的悼泌。 我是一名探鬼主播松捉,決...
    沈念sama閱讀 40,999評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼馆里!你這毒婦竟也來了隘世?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,914評論 0 277
  • 序言:老撾萬榮一對情侶失蹤鸠踪,失蹤者是張志新(化名)和其女友劉穎丙者,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體营密,經(jīng)...
    沈念sama閱讀 46,465評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡械媒,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,543評論 3 342
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了评汰。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片纷捞。...
    茶點故事閱讀 40,675評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖被去,靈堂內(nèi)的尸體忽然破棺而出主儡,到底是詐尸還是另有隱情,我是刑警寧澤惨缆,帶...
    沈念sama閱讀 36,354評論 5 351
  • 正文 年R本政府宣布糜值,位于F島的核電站,受9級特大地震影響踪央,放射性物質(zhì)發(fā)生泄漏臀玄。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 42,029評論 3 335
  • 文/蒙蒙 一畅蹂、第九天 我趴在偏房一處隱蔽的房頂上張望健无。 院中可真熱鬧,春花似錦液斜、人聲如沸累贤。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,514評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽臼膏。三九已至,卻和暖如春示损,著一層夾襖步出監(jiān)牢的瞬間渗磅,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,616評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留始鱼,地道東北人仔掸。 一個月前我還...
    沈念sama閱讀 49,091評論 3 378
  • 正文 我出身青樓,卻偏偏與公主長得像医清,于是被迫代替她去往敵國和親起暮。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 45,685評論 2 360

推薦閱讀更多精彩內(nèi)容