1. 程式人生 > 實用技巧 >精講RestTemplate第8篇-請求失敗自動重試機制

精講RestTemplate第8篇-請求失敗自動重試機制

本文是精講RestTemplate第8篇,前篇的blog訪問地址如下:

在上一節我們為大家介紹了,當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註解,表示讓重試機制生效。

二、使用案例

@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秒後重試
  • 第三次請求失敗之後,丟擲異常

歡迎關注我的部落格,裡面有很多精品合集

  • 本文轉載註明出處(必須帶連線,不能只轉文字):字母哥部落格

覺得對您有幫助的話,幫我點贊、分享!您的支援是我不竭的創作動力! 。另外,筆者最近一段時間輸出瞭如下的精品內容,期待您的關注。