对于最新的稳定版本,请使用 Spring Framework 6.2.0spring-doc.cn

HTTP 缓存

HTTP 缓存可以显著提高 Web 应用程序的性能。HTTP 缓存 围绕响应头和后续条件请求 标头,例如 和 . 建议私有(例如,浏览器) 和 public (例如 proxy) caches,了解如何缓存和重用响应。使用标头 要发出可能导致 304 (NOT_MODIFIED) 没有正文的条件请求, 如果内容未更改。 可以看作是 标题。Cache-ControlLast-ModifiedETagCache-ControlETagETagLast-Modifiedspring-doc.cn

本节描述了 Spring WebFlux 中可用的 HTTP 缓存相关选项。spring-doc.cn

CacheControl

CacheControl 支持 配置与标头相关的设置,并接受为参数 在许多地方:Cache-Controlspring-doc.cn

虽然 RFC 7234 描述了所有可能的 directives 的 Response,该类型采用 面向用例的方法,侧重于常见场景,如下例所示:Cache-ControlCacheControlspring-doc.cn

// 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()

控制器

控制器可以添加对 HTTP 缓存的显式支持。我们建议这样做,因为需要先计算资源的 or 值,然后才能进行比较 针对条件请求标头。控制器可以将 和 设置添加到 ,如下例所示:lastModifiedETagETagCache-ControlResponseEntityspring-doc.cn

@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) 响应,如果比较 添加到条件请求标头中,表示内容未更改。否则,将 and 标头添加到响应中。ETagCache-Controlspring-doc.cn

你也可以在控制器中对条件请求头进行检查, 如下例所示:spring-doc.cn

@RequestMapping
public String myHandleMethod(ServerWebExchange exchange, Model model) {

	long eTag = ... (1)

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

	model.addAttribute(...); (3)
	return "myViewName";
}
1 特定于应用程序的计算。
2 响应已设置为 304 (NOT_MODIFIED)。无需进一步处理。
3 继续进行请求处理。
@RequestMapping
fun myHandleMethod(exchange: ServerWebExchange, model: Model): String? {

	val eTag: Long = ... (1)

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

	model.addAttribute(...) (3)
	return "myViewName"
}
1 特定于应用程序的计算。
2 响应已设置为 304 (NOT_MODIFIED)。无需进一步处理。
3 继续进行请求处理。

有三种变体可用于根据值和/或值检查条件请求。对于 conditional 和 requests,您可以将响应设置为 304 (NOT_MODIFIED)。对于条件 、 、 和 ,您可以改为设置响应 设置为 412 (PRECONDITION_FAILED) 以防止并发修改。eTaglastModifiedGETHEADPOSTPUTDELETEspring-doc.cn

静态资源

您应该使用 a 和条件响应标头来提供静态资源 以获得最佳性能。请参阅有关配置静态资源的部分。Cache-Controlspring-doc.cn