詳解重試框架Spring retry實(shí)踐
spring retry是從spring batch獨(dú)立出來(lái)的一個(gè)能功能,主要實(shí)現(xiàn)了重試和熔斷。對(duì)于重試是有場(chǎng)景限制的,不是什么場(chǎng)景都適合重試,比如參數(shù)校驗(yàn)不合法、寫(xiě)操作等(要考慮寫(xiě)是否冪等)都不適合重試。遠(yuǎn)程調(diào)用超時(shí)、網(wǎng)絡(luò)突然中斷可以重試。在微服務(wù)治理框架中,通常都有自己的重試與超時(shí)配置,比如dubbo可以設(shè)置retries=1,timeout=500調(diào)用失敗只重試1次,超過(guò)500ms調(diào)用仍未返回則調(diào)用失敗。在spring retry中可以指定需要重試的異常類(lèi)型,并設(shè)置每次重試的間隔以及如果重試失敗是繼續(xù)重試還是熔斷(停止重試)。
設(shè)計(jì)與實(shí)現(xiàn)
RetryOperations
定義重試的API,RetryTemplate
是API的模板模式實(shí)現(xiàn),實(shí)現(xiàn)了重試和熔斷。提供的API如下:
public interface RetryOperations { <T, E extends Throwable>T execute(RetryCallback<T, E>retryCallback) throws E; } // 其他API已省略
RetryCallback
定義了需要執(zhí)行重試的操作,定義好操作后,就是如何重試的問(wèn)題了。RetryTemplate
通過(guò)制定不同的重試策略來(lái)執(zhí)行如何重試的邏輯。默認(rèn)的重試策略是SimpleRetryPlicy
,也就是會(huì)重試3次。重試第1次如果成功后面就不會(huì)繼續(xù)重試了。那么如果3尺都重試失敗了呢?流程結(jié)束或者返回兜底結(jié)果。要返回兜底結(jié)果需要配置RecoveyCallBack
,從名字可以看出這是一個(gè)兜底回調(diào)接口,也就是重試失敗后執(zhí)行的邏輯。除了SimpleRetryPolicy
還有其他重試策略,先來(lái)看下RetryPolicy
接口:
public interface RetryPolicy extends Serializable { boolean canRetry(RetryContext context); RetryContext open(RetryContext parent); void close(RetryContext context); void registerThrowable(RetryContext context, Throwable throwable); }
canRetry
在每次重試的時(shí)候調(diào)用,是否可以繼續(xù)重試的判斷條件
open
重試開(kāi)始前調(diào)用,會(huì)創(chuàng)建一個(gè)重試上下文到RetryContext
,保存重試的堆棧等信息
registerThrowable
每次重試異常時(shí)調(diào)用(有異常會(huì)繼續(xù)重試)
以SimpleRetryPolicy
為例,當(dāng)重試次數(shù)達(dá)到3(默認(rèn)3次)停止重試,重試次數(shù)保存在重試上下文中。
提供如下重試策略實(shí)現(xiàn):
- NeverRetryPolicy:只允許調(diào)用RetryCallback一次,不允許重試
- AlwaysRetryPolicy:允許無(wú)限重試,直到成功,此方式邏輯不當(dāng)會(huì)導(dǎo)致死循環(huán)
- SimpleRetryPolicy:固定次數(shù)重試策略,默認(rèn)重試最大次數(shù)為3次,RetryTemplate默認(rèn)使用的策略
- TimeoutRetryPolicy:超時(shí)時(shí)間重試策略,默認(rèn)超時(shí)時(shí)間為1秒,在指定的超時(shí)時(shí)間內(nèi)允許重試
- ExceptionClassifierRetryPolicy:設(shè)置不同異常的重試策略,類(lèi)似組合重試策略,區(qū)別在于這里只區(qū)分不同異常的重試
- CircuitBreakerRetryPolicy:有熔斷功能的重試策略,需設(shè)置3個(gè)參數(shù)openTimeout、resetTimeout和delegate
- CompositeRetryPolicy:組合重試策略,有兩種組合方式,樂(lè)觀組合重試策略是指只要有一個(gè)策略允許重試即可以,悲觀組合重試策略是指只要有一個(gè)策略不允許重試即可以,但不管哪種組合方式,組合中的每一個(gè)策略都會(huì)執(zhí)行
重試回退策略,指的是每次重試是立即重試還是等待一段時(shí)間后重試。默認(rèn)情況下是立即重試,如果需要配置等待一段時(shí)間后重試則需要指定回退策略BackoffRetryPolicy
。BackoffRetryPolicy有如下實(shí)現(xiàn):
- NoBackOffPolicy:無(wú)退避算法策略,每次重試時(shí)立即重試
- FixedBackOffPolicy:固定時(shí)間的退避策略,需設(shè)置參數(shù)sleeper和backOffPeriod,sleeper指定等待策略,默認(rèn)是Thread.sleep,即線程休眠,backOffPeriod指定休眠時(shí)間,默認(rèn)1秒
- UniformRandomBackOffPolicy:隨機(jī)時(shí)間退避策略,需設(shè)置sleeper、minBackOffPeriod和maxBackOffPeriod,該策略在[minBackOffPeriod,maxBackOffPeriod之間取一個(gè)隨機(jī)休眠時(shí)間,minBackOffPeriod默認(rèn)500毫秒,maxBackOffPeriod默認(rèn)1500毫秒
- ExponentialBackOffPolicy:指數(shù)退避策略,需設(shè)置參數(shù)sleeper、initialInterval、maxInterval和multiplier,initialInterval指定初始休眠時(shí)間,默認(rèn)100毫秒,maxInterval指定最大休眠時(shí)間,默認(rèn)30秒,multiplier指定乘數(shù),即下一次休眠時(shí)間為當(dāng)前休眠時(shí)間*multiplier
- ExponentialRandomBackOffPolicy:隨機(jī)指數(shù)退避策略,引入隨機(jī)乘數(shù)可以實(shí)現(xiàn)隨機(jī)乘數(shù)回退
有狀態(tài)重試 OR 無(wú)狀態(tài)重試
所謂無(wú)狀態(tài)重試是指重試在一個(gè)線程上下文中完成的重試,反之不在一個(gè)線程上下文完成重試的就是有狀態(tài)重試。之前的SimpleRetryPolicy
就屬于無(wú)狀態(tài)重試,因?yàn)橹卦囀窃谝粋€(gè)循環(huán)中完成的。那么什么會(huì)后會(huì)出現(xiàn)或者說(shuō)需要有狀態(tài)重試呢?通常有兩種情況:事務(wù)回滾和熔斷。
數(shù)據(jù)庫(kù)操作異常DataAccessException,不能執(zhí)行重試,而如果拋出其他異??梢灾卦嚒?/p>
熔斷的意思不在當(dāng)前循環(huán)中處理重試,而是全局重試模式(不是線程上下文)。熔斷會(huì)跳出循環(huán),那么必然會(huì)丟失線程上下文的堆棧信息。那么肯定需要一種“全局模式”保存這種信息,目前的實(shí)現(xiàn)放在一個(gè)cache(map實(shí)現(xiàn)的)中,下次從緩存中獲取就能繼續(xù)重試了。
Quick Start
在需要執(zhí)行重試的類(lèi)上使用@EnableRetry
,如果設(shè)置了proxyTargetClass=true
這使用CGLIB動(dòng)態(tài)代理:
@Configuration @EnableRetry(proxyTargetClass = true) @Component public class RetryExamples { }
基于最大重試次數(shù)策略的重試,如果重試了3次仍然拋出異常則停止重試,執(zhí)行兜底回調(diào),所以最后的輸出結(jié)果是Integer.MAX_VALUE
:
private void retryExample3() throws Exception { RetryTemplate retryTemplate = new RetryTemplate(); SimpleRetryPolicy simpleRetryPolicy = new SimpleRetryPolicy(); simpleRetryPolicy.setMaxAttempts(3); retryTemplate.setRetryPolicy(simpleRetryPolicy); Integer result = retryTemplate.execute(new RetryCallback<Integer, Exception>() { int i = 0; // 重試操作 @Override public Integer doWithRetry(RetryContext retryContext) throws Exception { log.info("retry count: {}", retryContext.getRetryCount()); return len(i++); } }, new RecoveryCallback<Integer>() { //兜底回調(diào) @Override public Integer recover(RetryContext retryContext) throws Exception { log.info("after retry: {}, recovery method called!", retryContext.getRetryCount()); return Integer.MAX_VALUE; } }); log.info("final result: {}", result); } private int len(int i) throws Exception { if (i < 10) throw new Exception(i + " le 10"); return i; }
下面介紹如何使用熔斷重試策略模式(CircuitBreakerRetryPolicy),需要設(shè)置如下三個(gè)參數(shù):
- delegate:傳入RetryPolicy(每個(gè)RetryPolicy實(shí)現(xiàn)都有自己的重試策略實(shí)現(xiàn)),是真正判斷是否重試的策略,當(dāng)重試失敗時(shí),則執(zhí)行熔斷策略
- openTimeout:openWindow,配置熔斷器電路打開(kāi)的超時(shí)時(shí)間,當(dāng)超過(guò)openTimeout之后熔斷器電路變成半打開(kāi)狀態(tài)(只要有一次重試成功,則閉合電路)
- resetTimeout:timeout,配置重置熔斷器重新閉合的超時(shí)時(shí)間
斷路器開(kāi)閉實(shí)現(xiàn)判斷:
- 當(dāng)重試失敗,且在熔斷器打開(kāi)時(shí)間窗口[0,openWindow) 內(nèi),立即熔斷
- 當(dāng)重試失敗,且超過(guò)timeout,熔斷器電路重新閉合
- 在熔斷器半打開(kāi)狀態(tài)[openWindow, timeout] 時(shí),只要重試成功則重置上下文,斷路器閉合
測(cè)試代碼如下:
RetryTemplate template = new RetryTemplate(); CircuitBreakerRetryPolicy retryPolicy = new CircuitBreakerRetryPolicy(new SimpleRetryPolicy(3)); retryPolicy.setOpenTimeout(5000); retryPolicy.setResetTimeout(20000); template.setRetryPolicy(retryPolicy); for (int i = 0; i < 10; i++) { //Thread.sleep(100); try { Object key = "circuit"; boolean isForceRefresh = false; RetryState state = new DefaultRetryState(key, isForceRefresh); String result = template.execute(new RetryCallback<String, RuntimeException>() { @Override public String doWithRetry(RetryContext context) throws RuntimeException { log.info("retry count: {}", context.getRetryCount()); throw new RuntimeException("timeout"); } }, new RecoveryCallback<String>() { @Override public String recover(RetryContext context) throws Exception { return "default"; } }, state); log.info("result: {}", result); } catch (Exception e) { System.out.println(e); } }
這里由于設(shè)置了isForceRefresh = false
,則key = "circuit"
的值(也就是RetryContext)會(huì)從緩存中獲取,所以當(dāng)重試失敗且滿(mǎn)足this.time < this.openWindow
發(fā)生熔斷的時(shí)候,后面仍然可以繼續(xù)已全局模式實(shí)現(xiàn)重試(拿到的RetryContext
是同一個(gè))。
注解開(kāi)發(fā)
如果每次有重試需求的時(shí)候都寫(xiě)一個(gè)RetryTemplate
太臃腫了,使用注解可以大大簡(jiǎn)化開(kāi)發(fā),減少重復(fù)代碼。下面是一個(gè)使用注解實(shí)現(xiàn)的最大重試策略的重試:
@Retryable(value = SQLDataException.class, backoff = @Backoff(value = 0L)) public String service3() throws SQLDataException { log.info("service3 open"); throw new SQLDataException(); } @Recover public String recover(SQLDataException ne) { return "SQLDataException recover"; }
注解包括:
@EnableRetry
@Retryable
@Recover
@Backoff
@CircuitBreaker
@EnableRetry:能否重試,proxyTargetClass屬性為true時(shí)(默認(rèn)false),使用CGLIB代理
@Retryable:注解需要被重試的方法
- include 指定處理的異常類(lèi)。默認(rèn)為空
- exclude指定不需要處理的異常。默認(rèn)為空
- vaue指定要重試的異常。默認(rèn)為空
- maxAttempts 最大重試次數(shù)。默認(rèn)3次
- backoff 重試等待策略。默認(rèn)使用@Backoff注解
@Backoff:重試回退策略(立即重試還是等待一會(huì)再重試)
- 不設(shè)置參數(shù)時(shí),默認(rèn)使用FixedBackOffPolicy,重試等待1000ms
- 只設(shè)置delay()屬性時(shí),使用FixedBackOffPolicy,重試等待指定的毫秒數(shù)
- 當(dāng)設(shè)置delay()和maxDealy()屬性時(shí),重試等待在這兩個(gè)值之間均態(tài)分布
- 使用delay(),maxDealy()和multiplier()屬性時(shí),使用ExponentialBackOffPolicy
- 當(dāng)設(shè)置multiplier()屬性不等于0時(shí),同時(shí)也設(shè)置了random()屬性時(shí),使用ExponentialRandomBackOffPolicy
@Recover: 用于方法。用于@Retryable失敗時(shí)的“兜底”處理方法。 @Recover注釋的方法必須要與@Retryable注解的方法“簽名”保持一致,第一入?yún)橐卦嚨漠惓?,其他參?shù)與@Retryable保持一致,返回值也要一樣,否則無(wú)法執(zhí)行!
@CircuitBreaker:用于方法,實(shí)現(xiàn)熔斷模式。
- include 指定處理的異常類(lèi)。默認(rèn)為空
- exclude指定不需要處理的異常。默認(rèn)為空
- vaue指定要重試的異常。默認(rèn)為空
- maxAttempts 最大重試次數(shù)。默認(rèn)3次
- openTimeout 配置熔斷器打開(kāi)的超時(shí)時(shí)間,默認(rèn)5s,當(dāng)超過(guò)openTimeout之后熔斷器電路變成半打開(kāi)狀態(tài)(只要有一次重試成功,則閉合電路)
- resetTimeout 配置熔斷器重新閉合的超時(shí)時(shí)間,默認(rèn)20s,超過(guò)這個(gè)時(shí)間斷路器關(guān)閉
更多的例子歡迎到我的Github(https://github.com/happyxiaofan/springboot-learning-example) star。謝謝
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
SpringBoot中多環(huán)境yml的配置與打包問(wèn)題
這篇文章主要介紹了SpringBoot中多環(huán)境yml的配置與打包問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-09-09Java 畫(huà)時(shí)鐘遇到的問(wèn)題及解決方案
我是一個(gè)剛?cè)腴T(mén)的小菜鳥(niǎo),希望我寫(xiě)的東西可以幫助和我一樣剛?cè)腴T(mén)的兄弟們少走一些彎路,也希望大佬們可以多指點(diǎn)指點(diǎn)我。感謝!解決在畫(huà)時(shí)鐘遇到的問(wèn)題讓我花費(fèi)不少時(shí)間...說(shuō)兩個(gè)困擾我比較久的2021-11-11Spring?Boot如何排除自動(dòng)加載數(shù)據(jù)源
這篇文章主要介紹了Spring?Boot如何排除自動(dòng)加載數(shù)據(jù)源,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-12-12SpringData JPA快速上手之關(guān)聯(lián)查詢(xún)及JPQL語(yǔ)句書(shū)寫(xiě)詳解
JPA都有SpringBoot的官方直接提供的starter,而Mybatis沒(méi)有,直到SpringBoot 3才開(kāi)始加入到官方模版中,這篇文章主要介紹了SpringData JPA快速上手,關(guān)聯(lián)查詢(xún),JPQL語(yǔ)句書(shū)寫(xiě)的相關(guān)知識(shí),感興趣的朋友一起看看吧2023-09-09關(guān)于Java中的可見(jiàn)性和有序性問(wèn)題
這篇文章主要介紹了關(guān)于Java中的可見(jiàn)性和有序性問(wèn)題,Java在誕生之初就支持多線程,自然也有針對(duì)這三者的技術(shù)方案,今天就學(xué)習(xí)一下Java如何解決其中的可見(jiàn)性和有序性導(dǎo)致的問(wèn)題,需要的朋友可以參考下2023-08-08淺談Spring Cloud中的API網(wǎng)關(guān)服務(wù)Zuul
這篇文章主要介紹了淺談Spring Cloud中的API網(wǎng)關(guān)服務(wù)Zuul,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-10-10SpringBoot使用Filters實(shí)現(xiàn)請(qǐng)求過(guò)濾和預(yù)處理
過(guò)濾器(Filter)是一種在Web應(yīng)用中用于攔截和處理HTTP請(qǐng)求和響應(yīng)的對(duì)象,在Java Web開(kāi)發(fā)中,過(guò)濾器是實(shí)現(xiàn)特定功能,如認(rèn)證、日志記錄和字符編碼處理的重要工具,本文主要介紹了SpringBoot使用Filters實(shí)現(xiàn)請(qǐng)求過(guò)濾和預(yù)處理,需要的朋友可以參考下2024-08-08布隆過(guò)濾器詳解以及其在Java中的實(shí)際應(yīng)用
布隆過(guò)濾器是一種數(shù)據(jù)結(jié)構(gòu),比較巧妙的概率型數(shù)據(jù)結(jié)構(gòu)(probabilistic data structure),特點(diǎn)是高效地插入和查詢(xún),這篇文章主要給大家介紹了關(guān)于布隆過(guò)濾器詳解以及其在Java中的實(shí)際應(yīng)用,需要的朋友可以參考下2023-12-12Java多線程中的單例模式兩種實(shí)現(xiàn)方式
這篇文章主要介紹了Java多線程中的單例模式兩種實(shí)現(xiàn)方式的相關(guān)資料,需要的朋友可以參考下2017-04-04