タイムアウト

時間を制限するプロパティは三つあります。server.connection-timeout (ネットワークが沈黙している)、server.request-timeout (アプリケーションが遅い)、spring.mvc.async.request-timeout (SseEmitter が開いたまま) です。

使う理由

いつまでも待つサーバーは、誰にでも足止めされてしまいます。

各プロパティは、これらのケースの一つを扱います。互いの代わりにはなりません。

プロパティ 制限するもの デフォルト 超えると
server.connection-timeout リクエストボディを読む間の沈黙、アイドル状態のキープアライブ接続 60s 408 で接続が閉じる。アイドル接続は閉じる
server.request-timeout フィルターとハンドラーが応答を始めるまでの時間 制限なし 503。リクエストの RequestDeadline が過ぎている
spring.mvc.async.request-timeout 独自のタイムアウトを持たない SseEmitter の寿命 制限なし onTimeout コールバックの後、エミッターが完了する

例

# lib/resources/application.yml
server:
  connection-timeout: 30s
  request-timeout: 10s
spring:
  mvc:
    async:
      request-timeout: 30m
server.connection-timeout=30s
server.request-timeout=10s
spring.mvc.async.request-timeout=30m

ステップの間で期限を読むハンドラー:

import 'package:spring_boot_starter_web/spring_boot_starter_web.dart';

@RestController()
@RequestMapping('/api/reports')
class ReportController {
  ReportController(this.sales, this.stock);
  final SalesClient sales;   // Feign クライアント: リクエストの期限で止まる
  final StockService stock;

  @GetMapping('/daily')
  Future<Report> daily() async {
    final totals = await sales.totals();
    RequestDeadline.current?.check(); // もう誰も待っていない: ここで止める
    final levels = await stock.levels();
    return Report(totals, levels);
  }
}

server.connection-timeout

server.request-timeout

メンバー 内容
RequestDeadline.current 現在実行中のコードの期限、または null
budget 与えられた長さ
remaining 残り時間。負になることはない
isExpired 時間が過ぎたかどうか
check() 時間が過ぎていれば RequestDeadlineExceededException を投げる
RequestDeadline.run(budget, body) 独自の期限の下で body を実行する。別の期限の中では、早く終わるほうが採用される

しないこと

spring.mvc.async.request-timeout

@GetMapping('/api/orders/updates')
SseEmitter updates() {
  final emitter = SseEmitter(); // spring.mvc.async.request-timeout の後に終わる
  emitter.onTimeout(() => emitter.send('bye'));
  orders.watch(emitter);
  return emitter;
}

サーバー送信イベント を参照してください。

組み合わせたときの動作

シャットダウン時は、spring.lifecycle.timeout-per-shutdown-phase が、実行中のリクエストにまだかけられる時間を制限します。シャットダウン を参照してください。

Spring (Java) との対応

server.tomcat.connection-timeout=30s
spring.mvc.async.request-timeout=30m

重要な違い:

関連項目