如何為RestTemplate設置可定製的連接超時時間

一、RestTemplate簡介

首先，我們來介紹一下什麼是RestTemplate。在Spring框架中，RestTemplate是一個非常重要的組件，它提供了一種簡單方便的方式用來訪問外部API或者服務。

RestTemplate是基於HTTP協議的，支持豐富的HTTP請求方式，例如GET、POST、PUT、DELETE等，同時也支持發送HTTP請求頭和請求體。很多的Spring應用都會用到它，但是在使用RestTemplate時，我們必須要注意一些問題，例如連接超時、讀取超時等，這將在下面的內容中詳細闡述。

二、RestTemplate設置連接超時

RestTemplate默認的連接超時時間是沒有限制的，而在實際開發中，很多時候需要我們自己來設置連接超時時間。

我們可以通過如下代碼來設置連接超時時間：

RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());

private ClientHttpRequestFactory getClientHttpRequestFactory() {
  int timeout = 5000;
  HttpComponentsClientHttpRequestFactory clientHttpRequestFactory
    = new HttpComponentsClientHttpRequestFactory();
  clientHttpRequestFactory.setConnectTimeout(timeout);
  return clientHttpRequestFactory;
}

我們可以看到，首先需要創建一個RestTemplate實例，然後通過getClientHttpRequestFactory()方法來獲取ClientHttpRequestFactory實例，最後用RestTemplate構建出來的實例來發送HTTP請求。

在getClientHttpRequestFactory()方法中，我們使用HttpComponentsClientHttpRequestFactory來實現ClientHttpRequestFactory接口，然後調用setConnectTimeout()方法來設置超時時間。在本例中，超時時間被設置為5秒。

三、可定製的連接超時時間

如果我們希望設置不同的超時時間來應對不同的請求，我們可以考慮使用攔截器和配置類來實現，在配置類中分別為不同的請求設置不同的連接超時時間。

1、攔截器的使用

攔截器是RestTemplate的一個重要特性，使用攔截器我們可以方便地為不同的請求進行定製。

下面是一個使用攔截器設置連接超時時間的例子：

public class CustomClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {
  @Override
  public ClientHttpResponse intercept(
    HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {

    HttpHeaders headers = request.getHeaders();
    headers.add("Content-Type", "application/json");
    headers.add("Accept", "application/json");
 
    // 連接超時時間
    int connectTimeout = 5000;
    RequestConfig requestConfig = RequestConfig
      .custom()
      .setConnectTimeout(connectTimeout)
      .build();
    HttpClient httpClient = HttpClientBuilder
      .create()
      .setDefaultRequestConfig(requestConfig)
      .build();
 
    HttpComponentsClientHttpRequestFactory factory = 
      new HttpComponentsClientHttpRequestFactory(httpClient);
 
    return factory.createRequest(request.getMethod(), request.getURI()).execute();
  }
}

RestTemplate restTemplate = new RestTemplate();
restTemplate.setInterceptors(Collections.singletonList(new CustomClientHttpRequestInterceptor()));

在上面的例子中，我們先定義了CustomClientHttpRequestInterceptor攔截器，在攔截器中設置了默認的Content-Type和Accept類型，並且定製了連接超時時間。

然後在創建RestTemplate實例時，調用setInterceptors()方法對RestTemplate進行配置。

2、配置類的使用

另一種解決方案是使用配置類。這種方式下，我們可以實現一個配置類，然後為不同的請求設置不同的連接超時時間。

下面是一個使用配置類設置連接超時時間的例子：

@Configuration
public class RestTemplateConfig {
 
  @Bean
  @Qualifier("customRestTemplate")
  public RestTemplate customRestTemplate(ClientHttpRequestFactory factory) {
    RestTemplate restTemplate = new RestTemplate(factory);
    return restTemplate;
  }
 
  @Bean
  public ClientHttpRequestFactory simpleClientHttpRequestFactory() {
    SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
    // 連接超時時間
    factory.setConnectTimeout(5000);
    return factory;
  }
 
  @Bean
  @Qualifier("longRestTemplate")
  public RestTemplate longRestTemplate(@Qualifier("longClientHttpRequestFactory") ClientHttpRequestFactory factory) {
    RestTemplate restTemplate = new RestTemplate(factory);
    return restTemplate;
  }
 
  @Bean
  @Qualifier("longClientHttpRequestFactory")
  public ClientHttpRequestFactory longClientHttpRequestFactory() {
    HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
    // 連接超時時間
    factory.setConnectTimeout(30000);
    return factory;
  }
}

在上面的例子中，我們定義了一個RestTemplateConfig配置類，使用@Bean註解來定義了兩種不同的RestTemplate和ClientHttpRequestFactory實例。

在simpleClientHttpRequestFactory()方法中，我們設置了默認的連接超時時間為5秒。而在longClientHttpRequestFactory()方法中，設置的連接超時時間為30秒。

最後在使用的時候，我們可以使用@Qualifier註解來指定使用哪個RestTemplate實例，例如使用_customRestTemplate來使用定義的customRestTemplate實例。

四、總結

在本文中，我們介紹了如何為RestTemplate設置可定製的連接超時時間。我們可以使用默認的連接超時時間，也可以通過攔截器或者配置類來實現為不同的請求設置不同的連接超時時間。

連接超時是很多HTTP請求中的必要操作，我們需要使用合適的方法來保護我們的程序，並且幫助我們更好地理解RestTemplate的使用。