HTTP 缓存

查看 Servlet stack 中的等效内容

HTTP 缓存可以显著提升 Web 应用的性能。HTTP 缓存围绕 Cache-Control 响应头以及随后的条件请求头，如 Last-Modified 和 ETag。Cache-Control 指示私有（例如，浏览器）和公共（例如，代理）缓存如何缓存和重用响应。ETag 头用于发起条件请求，如果内容未更改，则可能返回一个不带响应体的 304 (NOT_MODIFIED)。ETag 可以看作是 Last-Modified 头的更高级的后续者。

本节描述了 Spring WebFlux 中可用的与 HTTP 缓存相关的选项。

`CacheControl`

查看 Servlet stack 中的等效内容

CacheControl 提供了配置与 Cache-Control 头相关设置的支持，并在许多地方接受作为参数。

控制器
静态资源

尽管 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()

控制器

查看 Servlet stack 中的等效内容

控制器可以添加对 HTTP 缓存的显式支持。我们建议这样做，因为资源的 lastModified 或 ETag 值需要在与条件请求头进行比较之前计算出来。控制器可以向 ResponseEntity 添加 ETag 和 Cache-Control 设置，如下例所示：

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
Kotlin

@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 值或两者都对照。对于条件 GET 和 HEAD 请求，可以将响应设置为 304 (NOT_MODIFIED)。对于条件 POST、PUT 和 DELETE，可以将其响应设置为 412 (PRECONDITION_FAILED) 以防止并发修改。

静态资源

查看 Servlet stack 中的等效内容

为了获得最佳性能，应使用 Cache-Control 和条件响应头来提供静态资源。请参阅配置静态资源一节。