本文是精講RestTemplate第8篇,前篇的blog訪問地址如下:
- 精講RestTemplate第1篇-在Spring或非Spring環境下如何使用
- 精講RestTemplate第2篇-多種底層HTTP客戶端類庫的切換
- 精講RestTemplate第3篇-GET請求使用方法詳解
- 精講RestTemplate第4篇-POST請求方法使用詳解
- 精講RestTemplate第5篇-DELETE、PUT等請求方法使用詳解
- 精講RestTemplate第6篇-文件上傳下載與大文件流式下載
- 精講RestTemplate第7篇-自定義請求失敗異常處理
在上一節我們為大家介紹了,當RestTemplate發起遠程請求異常時的自定義處理方法,我們可以通過自定義的方式解析出HTTP Status Code狀態碼,然后根據狀態碼和業務需求決定程序下一步該如何處理。
本節為大家介紹另外一種通用的異常的處理機制:那就是自動重試。也就是說,在RestTemplate發送請求得到非200狀態結果的時候,間隔一定的時間再次發送n次請求。n次請求都失敗之后,最后拋出HttpClientErrorException。
在開始本節代碼之前,將上一節的RestTemplate自定義異常處理的代碼注釋掉,否則自動重試機制不會生效。如下(參考上一節代碼):
//restTemplate.setErrorHandler(new MyRestErrorHandler());
一、Spring Retry配置生效
通過maven坐標引入spring-retry,spring-retry的實現依賴於面向切面編程,所以引入aspectjweaver。以下配置過程都是基於Spring Boot應用。
<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 應用入口啟動類,也就是配置類的上面加上@SpringRetry注解,表示讓重試機制生效。
二、使用案例
- 寫一個模擬的業務類RetryService ,在其里面注入RestTemplate 。RestTemplate 實例化Bean配置參考: 《精講RestTemplate第1篇-在Spring或非Spring環境下如何使用》 和 《精講RestTemplate第2篇-多種底層HTTP客戶端類庫的切換》 進行實現。
- 將正確的請求服務地址由“/posts/1”改成“/postss/1”。服務不存在所以拋出404異常,是為了觸發重試機制。
@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("發起遠程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(); // 獲取響應碼
}
}
@Retryable
注解的方法在發生異常時會重試,參數說明:- value:當指定異常發生時會進行重試 ,HttpClientErrorException是RestClientException的子類。
- include:和value一樣,默認空。如果 exclude也為空時,所有異常都重試
- exclude:指定異常不重試,默認空。如果 include也為空時,所有異常都重試
- maxAttemps:最大重試次數,默認3
- backoff:重試等待策略,默認空
@Backoff
注解為重試等待的策略,參數說明:- delay:指定重試的延時時間,默認為1000毫秒
- multiplier:指定延遲的倍數,比如設置delay=5000,multiplier=2時,第一次重試為5秒后,第二次為10(5x2)秒,第三次為20(10x2)秒。
寫一個測試的RetryController 對RetryService 的testEntity方法進行調用
@RestController
public class RetryController {
@Resource
private RetryService retryService;
@GetMapping("/retry")
public HttpStatus test() {
return retryService.testEntity();
}
}
三、測試結果
向 http://localhost:8080/retry 發起請求,結果如下:
從結果可以看出:
- 第一次請求失敗之后,延遲5秒后重試
- 第二次請求失敗之后,延遲10秒后重試
- 第三次請求失敗之后,拋出異常
歡迎關注我的博客,里面有很多精品合集
- 本文轉載注明出處(必須帶連接,不能只轉文字):字母哥博客。
覺得對您有幫助的話,幫我點贊、分享!您的支持是我不竭的創作動力! 。另外,筆者最近一段時間輸出了如下的精品內容,期待您的關注。