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

本节介绍 Spring Web MVC 中可用的 HTTP 缓存相关选项。

CacheControl

CacheControl 提供对 配置与标头相关的设置,并被接受为参数 在许多地方:Cache-Control

虽然 RFC 7234 描述了所有可能 响应标头的指令,类型采用 面向用例的方法,重点关注常见方案:Cache-ControlCacheControl

  • 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

  • 值不会生成响应标头。-1Cache-Control

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

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

控制器

控制器可以添加对 HTTP 缓存的显式支持。我们建议这样做,因为在比较资源之前需要计算资源的 or 值 针对条件请求标头。控制器可以向 添加标头和设置,如以下示例所示:lastModifiedETagETagCache-ControlResponseEntity

  • 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) 响应,如果比较 到条件请求标头表示内容未更改。否则,将 和 标头添加到响应中。ETagCache-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 继续处理请求。

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

静态资源

应提供带有条件响应标头的静态资源 以获得最佳性能。请参阅有关配置静态资源的部分。Cache-Control

ETag滤波器

您可以使用 添加从 响应内容,从而节省带宽,但不节省 CPU 时间。请参阅浅层 ETagShallowEtagHeaderFiltereTag