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

HTTP缓存

HTTP 缓存可以显著提高 Web 应用程序的性能。HTTP 缓存围绕 Cache-Control 响应头和后续的条件请求头,如 Last-ModifiedETagCache-Control 指导私有(例如,浏览器)和公共(例如,代理)缓存如何缓存和重用响应。一个 ETag 头用于发出条件请求,如果内容未更改,则可能返回 304 (NOT_MODIFIED) 而没有正文。ETag 可以被视为 Last-Modified 头的更高级继任者。spring-doc.cadn.net.cn

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

CacheControl

CacheControl 提供支持以配置与 Cache-Control 标头相关的设置,并且可以作为多个地方的参数接受:spring-doc.cadn.net.cn

虽然RFC 7234描述了Cache-Control响应头的所有可能指令,但CacheControl类型采用了一种以使用场景为导向的方法,重点关注常见场景,如下例所示:spring-doc.cadn.net.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()

控制器

Controllers 可以显式地支持 HTTP 缓存。我们建议这样做,因为资源的 lastModifiedETag 值需要在与条件请求头进行比较之前计算出来。控制器可以添加一个 ETagCache-Control 设置到一个 ResponseEntity,如下例所示:spring-doc.cadn.net.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)响应,且响应体为空。否则,将ETagCache-Control头添加到响应中。spring-doc.cadn.net.cn

你也可以在控制器中针对条件请求头进行检查,如下例所示:spring-doc.cadn.net.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 继续处理请求。

有三种变体用于检查针对eTag值、lastModified值或两者组合的条件请求。对于条件GETHEAD请求,您可以将响应设置为304(NOT_MODIFIED)。对于条件POSTPUTDELETE,您可以将响应设置为412(PRECONDITION_FAILED),以防止并发修改。spring-doc.cadn.net.cn

静态资源

您应该使用 Cache-Control 和条件响应头来提供静态资源,以获得最佳性能。请参见配置静态资源的部分。spring-doc.cadn.net.cn