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

HTTP 缓存

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

本节描述了 Spring Web MVC 中可用的 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()

WebContentGenerator还接受一个 Simpler 属性(以秒为单位定义),该属性 工作原理如下:cachePeriodspring-doc.cn

  • 值不会生成响应标头。-1Cache-Controlspring-doc.cn

  • 值通过使用指令阻止缓存。0'Cache-Control: no-store'spring-doc.cn

  • 值使用指令将给定的响应缓存几秒钟。n > 0n'Cache-Control: max-age=n'spring-doc.cn

控制器

控制器可以添加对 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(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 继续进行请求处理。

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

静态资源

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

ETagFilter

您可以使用 添加从 响应内容,因此可以节省带宽,但不能节省 CPU 时间。参见浅层 ETagShallowEtagHeaderFiltereTagspring-doc.cn