HTTP Caching

HTTP 缓存可以显著提高 Web 应用程序的性能。HTTP 缓存围绕 Cache-Control 响应头以及随后的条件请求头（例如 Last-Modified 和 ETag）。Cache-Control 为私有（例如浏览器）和公有（例如代理）缓存如何缓存和重新使用响应提供建议。如果内容没有更改，则 ETag 头用于进行条件请求，这可能会导致没有正文的 304（未修改）。ETag 可以看作是 Last-Modified 头的一个更精细的后继。 本节介绍 Spring Web MVC 中提供的与 HTTP 缓存相关的选项。

CacheControl

CacheControl 提供对与 Cache-Control 头部相关的设置的支持，并且被当作参数接受在多个位置：

尽管https://datatracker.ietf.org/doc/html/rfc7234#section-5.2.2[RFC 7234] 描述了 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`秒。

Controllers

控制器可以添加对 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
@RequestMapping
public String myHandleMethod(WebRequest request, Model model) {

	long eTag = ... (1)

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

	model.addAttribute(...); (3)
	return "myViewName";
}
1 Application-specific calculation.
2 响应已被设置为 304 (未修改) — 无法进行进一步处理。
3 继续请求处理。
Kotlin
@RequestMapping
fun myHandleMethod(request: WebRequest, model: Model): String? {

	val eTag: Long = ... (1)

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

	model[...] = ... (3)
	return "myViewName"
}
4 Application-specific calculation.
5 响应已被设置为 304 (未修改) — 无法进行进一步处理。
6 继续请求处理。

有三个变体用于针对 eTag 值、lastModified 值或同时针对两者检查条件请求。对于条件 GET 和 HEAD 请求，可以将响应设置为 304 (NOT_MODIFIED)。对于条件 POST、PUT 和 DELETE，可以将响应设置为 412 (PRECONDITION_FAILED)，以防止并发修改。

Static Resources

你应当利用 Cache-Control 和条件响应头部提供静态资源以实现最佳性能。查阅配置 Static Resources 这一部分。

ETag Filter

你可以使用 ShallowEtagHeaderFilter 添加 “shallow” eTag 值，这些值是从响应内容中计算得出的，从而能够节省带宽，但不能节省 CPU 时间。请参阅 Shallow ETag。