spring retry是從spring batch獨立出來的一個能功能,主要實現了重試和熔斷。對于重試是有場景限制的,不是什么場景都適合重試,比如參數校驗不合法、寫操作等(要考慮寫是否冪等)都不適合重試。遠程調用超時、網絡突然中斷可以重試。在微服務治理框架中,通常都有自己的重試與超時配置,比如dubbo可以設置retries=1,timeout=500調用失敗只重試1次,超過500ms調用仍未返回則調用失敗。在spring retry中可以指定需要重試的異常類型,并設置每次重試的間隔以及如果重試失敗是繼續重試還是熔斷(停止重試)。
設計與實現
RetryOperations
定義重試的API,RetryTemplate
是API的模板模式實現,實現了重試和熔斷。提供的API如下:
public interface RetryOperations { <T, E extends Throwable>T execute(RetryCallback<T, E>retryCallback) throws E; } // 其他API已省略
RetryCallback
定義了需要執行重試的操作,定義好操作后,就是如何重試的問題了。RetryTemplate
通過制定不同的重試策略來執行如何重試的邏輯。默認的重試策略是SimpleRetryPlicy
,也就是會重試3次。重試第1次如果成功后面就不會繼續重試了。那么如果3尺都重試失敗了呢?流程結束或者返回兜底結果。要返回兜底結果需要配置RecoveyCallBack
,從名字可以看出這是一個兜底回調接口,也就是重試失敗后執行的邏輯。除了SimpleRetryPolicy
還有其他重試策略,先來看下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
在每次重試的時候調用,是否可以繼續重試的判斷條件
open
重試開始前調用,會創建一個重試上下文到RetryContext
,保存重試的堆棧等信息
registerThrowable
每次重試異常時調用(有異常會繼續重試)
以SimpleRetryPolicy
為例,當重試次數達到3(默認3次)停止重試,重試次數保存在重試上下文中。
提供如下重試策略實現:
重試回退策略,指的是每次重試是立即重試還是等待一段時間后重試。默認情況下是立即重試,如果需要配置等待一段時間后重試則需要指定回退策略BackoffRetryPolicy
。BackoffRetryPolicy有如下實現:
有狀態重試 OR 無狀態重試
所謂無狀態重試是指重試在一個線程上下文中完成的重試,反之不在一個線程上下文完成重試的就是有狀態重試。之前的SimpleRetryPolicy
就屬于無狀態重試,因為重試是在一個循環中完成的。那么什么會后會出現或者說需要有狀態重試呢?通常有兩種情況:事務回滾和熔斷。
數據庫操作異常DataAccessException,不能執行重試,而如果拋出其他異??梢灾卦嚒?/p>
熔斷的意思不在當前循環中處理重試,而是全局重試模式(不是線程上下文)。熔斷會跳出循環,那么必然會丟失線程上下文的堆棧信息。那么肯定需要一種“全局模式”保存這種信息,目前的實現放在一個cache(map實現的)中,下次從緩存中獲取就能繼續重試了。
Quick Start
在需要執行重試的類上使用@EnableRetry
,如果設置了proxyTargetClass=true
這使用CGLIB動態代理:
@Configuration@EnableRetry(proxyTargetClass = true)@Componentpublic class RetryExamples {}
基于最大重試次數策略的重試,如果重試了3次仍然拋出異常則停止重試,執行兜底回調,所以最后的輸出結果是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>() { //兜底回調 @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),需要設置如下三個參數:
斷路器開閉實現判斷:
測試代碼如下:
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); } }
這里由于設置了isForceRefresh = false
,則key = "circuit"
的值(也就是RetryContext)會從緩存中獲取,所以當重試失敗且滿足this.time < this.openWindow
發生熔斷的時候,后面仍然可以繼續已全局模式實現重試(拿到的RetryContext
是同一個)。
注解開發
如果每次有重試需求的時候都寫一個RetryTemplate
太臃腫了,使用注解可以大大簡化開發,減少重復代碼。下面是一個使用注解實現的最大重試策略的重試:
@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時(默認false),使用CGLIB代理
@Retryable:注解需要被重試的方法
@Backoff:重試回退策略(立即重試還是等待一會再重試)
@Recover: 用于方法。用于@Retryable失敗時的“兜底”處理方法。 @Recover注釋的方法必須要與@Retryable注解的方法“簽名”保持一致,第一入參為要重試的異常,其他參數與@Retryable保持一致,返回值也要一樣,否則無法執行!
@CircuitBreaker:用于方法,實現熔斷模式。
更多的例子歡迎到我的Github(https://github.com/happyxiaofan/springboot-learning-example) star。謝謝
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持VeVb武林網。
新聞熱點
疑難解答
圖片精選