HTTP キャッシング

Reactive スタックに相当する部分を参照

HTTP キャッシングは、Web アプリケーションのパフォーマンスを大幅に改善できます。HTTP キャッシングは、Cache-Control レスポンスヘッダーと、その後の条件付きリクエストヘッダー（Last-Modified や ETag など）を中心に展開します。Cache-Control は、レスポンスをキャッシュおよび再利用する方法について、プライベート（ブラウザーなど）およびパブリック（プロキシなど）のキャッシュにアドバイスします。コンテンツが変更されていない場合、ETag ヘッダーを使用して、本文のない 304（NOT_MODIFIED）になる条件付きリクエストを作成します。ETag は、Last-Modified ヘッダーの後継として洗練されたものと見なすことができます。

このセクションでは、Spring Web MVC で使用可能な HTTP キャッシュ関連オプションについて説明します。

CacheControl

Reactive スタックに相当する部分を参照

CacheControl (Javadoc) は、Cache-Control ヘッダーに関連する設定の構成をサポートし、多くの場所で引数として受け入れられます。

RFC 7234 [IETF] (英語) は Cache-Control レスポンスヘッダーのすべての可能なディレクティブを記述していますが、CacheControl 型は、一般的なシナリオに焦点を当てたユースケース指向のアプローチを採用しています。

  • Java

  • Kotlin

// Cache for an hour - "Cache-Control: max-age=3600"
CacheControl ccCacheOneHour = CacheControl.maxAge(1, TimeUnit.HOURS);

// Prevent caching - "Cache-Control: no-store"
CacheControl ccNoStore = CacheControl.noStore();

// Cache for ten days in public and private caches,
// public caches should not transform the response
// "Cache-Control: max-age=864000, public, no-transform"
CacheControl ccCustom = CacheControl.maxAge(10, TimeUnit.DAYS).noTransform().cachePublic();
// Cache for an hour - "Cache-Control: max-age=3600"
val ccCacheOneHour = CacheControl.maxAge(1, TimeUnit.HOURS)

// Prevent caching - "Cache-Control: no-store"
val ccNoStore = CacheControl.noStore()

// Cache for ten days in public and private caches,
// public caches should not transform the response
// "Cache-Control: max-age=864000, public, no-transform"
val ccCustom = CacheControl.maxAge(10, TimeUnit.DAYS).noTransform().cachePublic()

WebContentGenerator は、次のように機能する、より単純な cachePeriod プロパティ（秒単位で定義）も受け入れます。

  • -1 値は、Cache-Control レスポンスヘッダーを生成しません。

  • 0 値は、'Cache-Control: no-store' ディレクティブを使用してキャッシュを防ぎます。

  • n > 0 値は、'Cache-Control: max-age=n' ディレクティブを使用して、指定されたレスポンスを n 秒間キャッシュします。

コントローラー

Reactive スタックに相当する部分を参照

コントローラーは、HTTP キャッシングの明示的なサポートを追加できます。リソースの lastModified または ETag 値は、条件付きリクエストヘッダーと比較する前に計算する必要があるため、そうすることをお勧めします。次の例に示すように、コントローラーは ETag ヘッダーと Cache-Control 設定を ResponseEntity に追加できます。

  • Java

  • Kotlin

@GetMapping("/book/{id}")
public ResponseEntity<Book> showBook(@PathVariable Long id) {

	Book book = findBook(id);
	String version = book.getVersion();

	return ResponseEntity
			.ok()
			.cacheControl(CacheControl.maxAge(30, TimeUnit.DAYS))
			.eTag(version) // lastModified is also available
			.body(book);
}
@GetMapping("/book/{id}")
fun showBook(@PathVariable id: Long): ResponseEntity<Book> {

	val book = findBook(id);
	val version = book.getVersion()

	return ResponseEntity
			.ok()
			.cacheControl(CacheControl.maxAge(30, TimeUnit.DAYS))
			.eTag(version) // lastModified is also available
			.body(book)
}

前の例では、条件付きリクエストヘッダーとの比較でコンテンツが変更されていないことが示された場合、本文が空の 304（NOT_MODIFIED）レスポンスを送信します。それ以外の場合は、ETag ヘッダーと Cache-Control ヘッダーがレスポンスに追加されます。

次の例に示すように、コントローラーの条件付きリクエストヘッダーに対してチェックを行うこともできます。

  • Java

  • Kotlin

@RequestMapping
public String myHandleMethod(WebRequest request, Model model) {

	long eTag = ... (1)

	if (request.checkNotModified(eTag)) {
		return null; (2)
	}

	model.addAttribute(...); (3)
	return "myViewName";
}
1 アプリケーション固有の計算。
2 レスポンスは 304（NOT_MODIFIED）に設定されています。それ以上の処理はありません。
3 リクエスト処理を続行します。
@RequestMapping
fun myHandleMethod(request: WebRequest, model: Model): String? {

	val eTag: Long = ... (1)

	if (request.checkNotModified(eTag)) {
		return null (2)
	}

	model[...] = ... (3)
	return "myViewName"
}
1 アプリケーション固有の計算。
2 レスポンスは 304（NOT_MODIFIED）に設定されています。それ以上の処理はありません。
3 リクエスト処理を続行します。

条件付きリクエストを eTag 値、lastModified 値、その両方に対してチェックするための 3 つのバリアントがあります。条件付き GET および HEAD リクエストの場合、レスポンスを 304（NOT_MODIFIED）に設定できます。条件付き POST、PUT、DELETE の場合、代わりにレスポンスを 412（PRECONDITION_FAILED）に設定して、同時変更を防ぐことができます。

静的リソース

Reactive スタックに相当する部分を参照

最適なパフォーマンスを得るには、Cache-Control と条件付きレスポンスヘッダーで静的リソースを提供する必要があります。静的リソースの構成に関するセクションを参照してください。

ETag フィルター

ShallowEtagHeaderFilter を使用して、レスポンスコンテンツから計算される「浅い」 eTag 値を追加し、CPU 時間ではなく帯域幅を節約できます。浅い ETag を参照してください。