快捷導(dǎo)航

SpringBoot API接口超時時間的五種配置方式詳解

更新時間：2025年03月21日 09:09:38 作者：小馬不敲代碼

在開發(fā)API接口時,配置API接口的超時時間是一項(xiàng)非常重要的任務(wù),SpringBoot中有多種方式可以配置API接口的超時時間,下面小編就為大家介紹一下吧

1、簡介

在開發(fā)API接口時，配置API接口的超時時間是一項(xiàng)非常重要的任務(wù)。超時時間的設(shè)置對于確保系統(tǒng)的穩(wěn)定性和響應(yīng)性至關(guān)重要。當(dāng)客戶端發(fā)送請求到服務(wù)器時，如果服務(wù)器由于某些原因（如數(shù)據(jù)庫查詢緩慢、外部服務(wù)調(diào)用失敗等）無法及時響應(yīng)，那么設(shè)置合理的超時時間可以防止服務(wù)器資源被長時間占用，從而避免系統(tǒng)崩潰或性能下降。

在Spring Boot中，有多種方式可以配置API接口的超時時間。針對不同的應(yīng)用場景，選擇正確的配置方式，可以確保系統(tǒng)在面對各種復(fù)雜場景時都能保持高效和穩(wěn)定。

介紹如下幾種API超時情況的配置：

1.事務(wù)超時時間配置

如果你的當(dāng)前的API接口涉及到事務(wù)相關(guān)，那么我們可以通過設(shè)置設(shè)置的超時時間來確保由于數(shù)據(jù)庫緩慢要引起的超時情況。

2.基于Resilience4j的超時保護(hù)機(jī)制

我們可以通過Resilience4j提供的超時機(jī)制來設(shè)置有效的超時時間。

3.異步請求超時

如果你當(dāng)前請求是異步請求，那么我們可以通過配置異步超時時間來限制接口等待時間。

4.HTTP Client超時配置

我們將介紹3種HTTP Client超時的配置，分別是RestTemplate，RestClient，WebClient。

5.基于NGINX代理超時配置

通常我們的后端接口一般會通過NGINX進(jìn)行反向代理，在這種情況下，我們可以在其代理上配置超時時間。

2、實(shí)戰(zhàn)案例

2.1 事務(wù)超時配置

我們可以在數(shù)據(jù)庫調(diào)用中實(shí)現(xiàn)請求超時的一種方法是利用Spring的@Transactional注解。該注解具有一個可以設(shè)置的超時屬性。該屬性的默認(rèn)值為-1，相當(dāng)于沒有設(shè)置任何超時。

@Transactional(timeout = 1)
public List<User> query() {
  this.userRepository.findById(8L).ifPresent(System.out::println) ;
  try {
    TimeUnit.SECONDS.sleep(1) ;
  } catch (InterruptedException e) {}
  return this.userRepository.findAll() ;
}

如上配置注解中配置超時時間為1s，內(nèi)部執(zhí)行時先根據(jù)id查詢，此時能正常執(zhí)行，當(dāng)休眠1s后，再次執(zhí)行數(shù)據(jù)庫操作將拋出超時異常。

首先，我們進(jìn)行如下異常配置：

@ExceptionHandler(TransactionTimedOutException.class)
public ResponseEntity<Object> txTimeout(TransactionTimedOutException ex) {
  return ResponseEntity.ok("請求超時: " + ex.getMessage()) ;
}

測試接口

@GetMapping
public ResponseEntity<Object> query() {
  return ResponseEntity.ok(this.userService.query()) ;
}

測試結(jié)果

以上我們利用了事務(wù)的超時時間來保護(hù)接口。

2.2 基于Resilience4j的超時保護(hù)機(jī)制

Resilience4j提供了一個TimeLimiter模塊，專門用來處理超時保護(hù)的。

首先，引入下面依賴：

<dependency>
  <groupId>io.github.resilience4j</groupId>
  <artifactId>resilience4j-spring-boot3</artifactId>
  <version>2.2.0</version>
</dependency>

接下來，通過注解配置需要保護(hù)的接口

@TimeLimiter(name = "queryUser", fallbackMethod = "fallbackQuery")
@GetMapping
public CompletionStage<ResponseEntity<Object>> query() {
  return CompletableFuture.supplyAsync(() -> {
    try {
      // 模擬耗時操作
      TimeUnit.SECONDS.sleep(2) ;
    } catch (InterruptedException e) {}
    return ResponseEntity.ok("success") ;
  }) ;
}
public CompletionStage<ResponseEntity<Object>> fallbackQuery(Throwable e) {
  return CompletableFuture.completedStage(ResponseEntity.ok(e.getMessage())) ;
}

說明：

name：在配置文件中定義的超時相關(guān)配置，如果配置文件中沒有配置則使用默認(rèn)的配置。
fallbackMethod：當(dāng)發(fā)生超時現(xiàn)象將調(diào)用的降級方法。

注意：方法的返回值必須是CompletionStage類型。

最后，配置超時

resilience4j:
  timelimiter:
    instances:
      #該名稱為上面注解中的name
      queryUser:
        timeout-duration: 1s

測試結(jié)果

此種方式是不是非常的簡單好用，一個注解搞定。

2.3 異步請求超時配置

當(dāng)我們的API接口是異步請求時，我們可以直接在配置文件中對異步請求的超時時間進(jìn)行配置：

spring:
  mvc:
    async:
      request-timeout: 1s

異步請求接口

@GetMapping("/async")
public Callable<String> async() {
  return () -> {
    try {
      TimeUnit.SECONDS.sleep(10) ;
    } catch (InterruptedException e) {
      return "任務(wù)中斷 - " + e.getMessage() ;
    }
    return "異步請求成功" ;
  } ;
}

測試結(jié)果

雖然這里休眠了10s，但在1s后，直接輸出了異常信息。

2.4 HTTP Client超時配置

這里我們將介紹3種接口調(diào)用的超時配置，分別是：RestTemplate，RestClient已經(jīng)WebClient，其中RestTemplate與RestClient是基于阻塞式調(diào)用并且RestClient是Spring6.1版本開始提供的；而WebClient則是基于響應(yīng)式的調(diào)用（非阻塞）。官方推薦使用WebClient。

RestTemplate超時配置

@Bean
RestTemplate restTemplate(RestTemplateBuilder builder) {
  return builder
      // 連接超時配置
      .connectTimeout(Duration.ofSeconds(1))
      // 讀取超時配置
      .readTimeout(Duration.ofSeconds(1))
      .build() ;
}

這是最簡單的配置，你還可以通過如下工廠方式配置

@Bean
RestTemplate restTemplate() {
  ClientHttpRequestFactorySettings settings = ClientHttpRequestFactorySettings.defaults()
      .withConnectTimeout(Duration.ofSeconds(1))
      .withReadTimeout(Duration.ofSeconds(1));
  RestTemplate restTemplate = new RestTemplate(
    ClientHttpRequestFactoryBuilder.detect().build(settings)) ;
  return restTemplate ;
}

根據(jù)你的環(huán)境選擇不同的方式進(jìn)行配置。

RestClient超時配置

RestClient的配置方式與上面的RestTemplate差不多。

@Bean
RestClient restClient() {
  ClientHttpRequestFactorySettings settings = ClientHttpRequestFactorySettings.defaults()
      .withConnectTimeout(Duration.ofSeconds(1))
      .withReadTimeout(Duration.ofSeconds(1)) ;
  return RestClient
      .builder()
      .requestFactory(ClientHttpRequestFactoryBuilder.detect().build(settings))
      .build() ;
}

最后，我們再來介紹官方推薦的WebClient。

WebClient超時配置

首先，我們要引入以下的依賴：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

下面進(jìn)行超時配置

@Bean
WebClient webClient() {
  HttpClient httpClient = HttpClient.create()
      .doOnConnected(conn -> conn
          .addHandlerLast(new ReadTimeoutHandler(1))
          .addHandlerLast(new WriteTimeoutHandler(1))) ;
  return WebClient.builder()
      .clientConnector(new ReactorClientHttpConnector(httpClient ))
      .build() ;
}

下面我們通過WebClient進(jìn)行接口調(diào)用進(jìn)行測試

訪問接口

@GetMapping("/client")
public String client() {
  try {
    TimeUnit.SECONDS.sleep(3) ;
  } catch (InterruptedException e) {
    return "任務(wù)中斷 - " + e.getMessage() ;
  }
  return "success" ;
}

通過WebClient訪問該接口

private final WebClient webClient ;
this.webClient
  .get()
  .uri("http://localhost:8080/api/users/client")
  .retrieve()
  .bodyToMono(String.class)
  // 當(dāng)發(fā)生錯誤時會自動調(diào)用該方法進(jìn)行恢復(fù)繼續(xù)執(zhí)行
  .onErrorResume(ex -> {
    return Mono.just("發(fā)生錯誤: " + ex.getMessage()) ;
  }) 
  .subscribe(System.out::println) ;

測試結(jié)果

io.netty.handler.timeout.ReadTimeoutException: null
發(fā)生錯誤: null

以上就是關(guān)于HTTP Client的超時配置。

2.5 基于NGINX代理超時配置

通過NGINX反向代理配置超時時間

location / {
  proxy_pass http://127.0.0.1:8080;
  proxy_connect_timeout 1s;  # 連接超時時間為30秒
  proxy_send_timeout 1s;     # 發(fā)送請求超時時間為60秒
  proxy_read_timeout 1s;     # 讀取響應(yīng)超時時間為60秒
}

當(dāng)發(fā)生超時時，我們這里通過日志查看：

[error] 11172#27080: *1 upstream timed out
(10060: A connection attempt failed because the connected
party did not properly respond after a period of time,
or established connection failed because connected
host has failed to respond) while reading
response header from upstream,
client: 127.0.0.1, server: localhost,
request: "GET /api/users/client HTTP/1.1",
upstream: "http://127.0.0.1:8080/api/users/client",
host: "localhost:1080"

當(dāng)發(fā)生異常，我們還可以進(jìn)行如下的配置，進(jìn)行友好提示：

location / {
proxy_pass http://127.0.0.1:8080;
proxy_connect_timeout 1s; # 連接超時時間為30秒
proxy_send_timeout 1s; # 發(fā)送請求超時時間為60秒
proxy_read_timeout 1s; # 讀取響應(yīng)超時時間為60秒
# 指定自定義錯誤頁面
error_page 504 /timeout.html;

# 指定自定義錯誤頁面的位置
location = /timeout.html {
root D:/all/html/;
internal;
}
}

以上就是SpringBoot API接口超時時間的五種配置方式詳解的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot API接口超時配置的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: