在項目中,調用第三方接口響應比較慢,或者由於網絡抖動等原因,導致無響應或響應超時的情況,就要用到重試機制。比較簡單成熟的方案就是使用spring-retry
功能,spring-retry
需要使用aop的特性,所以需要引入aspectj
1. 添加依賴
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
</dependency>
2. 核心註解有3個: @EnableRetry
,@Retryable
和 @Recover
@EnableRetry:此註解用於開啓重試框架,可以修飾在SpringBoot啓動類上面,也可以修飾在需要重試的類上
proxyTargetClass:Boolean類型,用於指明代理方式【true:cglib代理,false:jdk動態代理】默認使用jdk動態代理
@Retryable
value:Class[]類型,用於指定需要重試的異常類型,
include:Class[]類型,作用於value類似,區別尚未分析
exclude:Class[]類型,指定不需要重試的異常類型
maxAttemps:int類型,指定最多重試次數,默認3
backoff:Backoff類型,指明補償機制
@BackOff
delay:指定延遲後重試,默認爲1000L,即1s後開始重試 ;
multiplier:指定延遲的倍數
@Recover
當重試次數耗盡依然出現異常時,執行此異常對應的@Recover方法。
異常類型需要與Recover方法參數類型保持一致,
recover方法返回值需要與重試方法返回值保證一致
3. 使用步驟
① SpringBoot啓動類上增加@EnableRetry註解
@SpringBootApplication
@EnableRetry
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication .class, args);
}
}
② 接口
@RestController
public class RetryController {
@Autowired
RetryService retryService;
@GetMapping("/retry")
public String retry (@RequestParam("num") final int num) throws Exception {
return retryService.doRetry(num);
}
}
③ 在需要重試的接口上添加@Retryable註解
添加重試註解,當有異常時觸發重試機制,設置重試4次,默認是3.延時2000ms再次執行,每次延時是上次延時的1.5倍.當返回結果不符合要求時,主動報錯觸發重試.
@Retryable(value = Exception.class, maxAttempts = 4, backoff = @Backoff(delay = 2000, multiplier = 1.5))
public String doRetry (int num) throws Exception {
System.err.println("doRetry開始執行" + LocalDateTime.now());
if (num <= 0) {
throw new Exception("異常了");
}
return "輸入的數值是:" + num;
}
④ 增加重試依然失敗後回調的方法上加@Recover註解,如果不寫,將正常的拋出異常
@Recover
public String recover (Exception e) {
return "num必須大於0";
}
採坑記錄:
1. retry重試機制無效
由於retry用到了aspect增強,所有會有aspect的坑,就是在同一類中方法內部調用,會使aspect增強失效,那麼retry當然也會失效。
public class demo {
public void A() {
B();
}
@Retryable(Exception.class)
public void B() {
throw new RuntimeException("retry...");
}
}
這種情況,方法B是不會重試執行的
2. recover回調報錯
org.springframework.retry.ExhaustedRetryException: Cannot locate recovery method
報錯顯示找不到recovery方法
解決方案就這這兩句話:
-
異常類型需要與Recover方法參數類型保持一致
-
recover方法返回值需要與重試方法返回值保證一致
異常類型和返回值要一致!