本文是精講RestTemplate第8篇，前篇的blog訪問地址如下：
- 精講RestTemplate第1篇-在Spring或非Spring環(huán)境下如何使用
- 精講RestTemplate第2篇-多種底層HTTP客戶端類庫的切換
- 精講RestTemplate第3篇-GET請求使用方法詳解
- 精講RestTemplate第4篇-POST請求方法使用詳解
- 精講RestTemplate第5篇-DELETE、PUT等請求方法使用詳解
- 精講RestTemplate第6篇-文件上傳下載與大文件流式下載
- 精講RestTemplate第7篇-自定義請求失敗異常處理
在上一節(jié)我們?yōu)榇蠹医榻B了，當(dāng)RestTemplate發(fā)起遠(yuǎn)程請求異常時(shí)的自定義處理方法，我們可以通過自定義的方式解析出HTTP Status Code狀態(tài)碼，然后根據(jù)狀態(tài)碼和業(yè)務(wù)需求決定程序下一步該如何處理。
本節(jié)為大家介紹另外一種通用的異常的處理機(jī)制：那就是自動(dòng)重試。也就是說，在RestTemplate發(fā)送請求得到非200狀態(tài)結(jié)果的時(shí)候，間隔一定的時(shí)間再次發(fā)送n次請求。n次請求都失敗之后，最后拋出HttpClientErrorException。
在開始本節(jié)代碼之前，將上一節(jié)的RestTemplate自定義異常處理的代碼注釋掉，否則自動(dòng)重試機(jī)制不會(huì)生效。如下（參考上一節(jié)代碼）：
//restTemplate.setErrorHandler(new MyRestErrorHandler());
一、Spring Retry配置生效
通過maven坐標(biāo)引入spring-retry，spring-retry的實(shí)現(xiàn)依賴于面向切面編程，所以引入aspectjweaver。以下配置過程都是基于Spring Boot應(yīng)用。
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
<version>1.2.5.RELEASE</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
</dependency>
在Spring Boot 應(yīng)用入口啟動(dòng)類，也就是配置類的上面加上@SpringRetry注解，表示讓重試機(jī)制生效。
二、使用案例
- 寫一個(gè)模擬的業(yè)務(wù)類RetryService ，在其里面注入RestTemplate 。RestTemplate 實(shí)例化Bean配置參考： 《精講RestTemplate第1篇-在Spring或非Spring環(huán)境下如何使用》 和 《精講RestTemplate第2篇-多種底層HTTP客戶端類庫的切換》 進(jìn)行實(shí)現(xiàn)。
- 將正確的請求服務(wù)地址由“/posts/1”改成“/postss/1”。服務(wù)不存在所以拋出404異常，是為了觸發(fā)重試機(jī)制。
@Service
public class RetryService {
@Resource
private RestTemplate restTemplate;
private static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
@Retryable(value = RestClientException.class, maxAttempts = 3,
backoff = @Backoff(delay = 5000L,multiplier = 2))
public HttpStatus testEntity() {
System.out.println("發(fā)起遠(yuǎn)程API請求:" + DATE_TIME_FORMATTER.format(LocalDateTime.now()));
String url = "http://jsonplaceholder.typicode.com/postss/1";
ResponseEntity<String> responseEntity
= restTemplate.getForEntity(url, String.class);
return responseEntity.getStatusCode(); // 獲取響應(yīng)碼
}
}
-
@Retryable注解的方法在發(fā)生異常時(shí)會(huì)重試，參數(shù)說明：- value：當(dāng)指定異常發(fā)生時(shí)會(huì)進(jìn)行重試 ,HttpClientErrorException是RestClientException的子類。
- include：和value一樣，默認(rèn)空。如果 exclude也為空時(shí)，所有異常都重試
- exclude：指定異常不重試，默認(rèn)空。如果 include也為空時(shí)，所有異常都重試
- maxAttemps：最大重試次數(shù)，默認(rèn)3
- backoff：重試等待策略，默認(rèn)空
-
@Backoff注解為重試等待的策略，參數(shù)說明：- delay：指定重試的延時(shí)時(shí)間，默認(rèn)為1000毫秒
- multiplier：指定延遲的倍數(shù)，比如設(shè)置delay=5000，multiplier=2時(shí)，第一次重試為5秒后，第二次為10(5x2)秒，第三次為20(10x2)秒。
寫一個(gè)測試的RetryController 對RetryService 的testEntity方法進(jìn)行調(diào)用
@RestController
public class RetryController {
@Resource
private RetryService retryService;
@GetMapping("/retry")
public HttpStatus test() {
return retryService.testEntity();
}
}
三、測試結(jié)果
向 http://localhost:8080/retry 發(fā)起請求，結(jié)果如下：
從結(jié)果可以看出：
- 第一次請求失敗之后，延遲5秒后重試
- 第二次請求失敗之后，延遲10秒后重試
- 第三次請求失敗之后，拋出異常
歡迎關(guān)注我的博客，里面有很多精品合集
- 本文轉(zhuǎn)載注明出處（必須帶連接，不能只轉(zhuǎn)文字）：字母哥博客。
覺得對您有幫助的話，幫我點(diǎn)贊、分享！您的支持是我不竭的創(chuàng)作動(dòng)力！ 。另外，筆者最近一段時(shí)間輸出了如下的精品內(nèi)容，期待您的關(guān)注。
