HTTP 缓存

查看 Servlet 堆栈中的等效项

HTTP 缓存可以显著提高 Web 应用程序的性能。HTTP 缓存围绕 Cache-Control 响应头和随后的条件请求头（如 Last-Modified 和 ETag）展开。Cache-Control 建议私有（例如，浏览器）和公共（例如，代理）缓存如何缓存和重新使用响应。ETag 头用于发出条件请求，如果内容未更改，则可能导致 304（NOT_MODIFIED）而没有主体。ETag 可以被视为 Last-Modified 头的更复杂的后继者。

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

CacheControl

查看 Servlet 堆栈中的等效项

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 堆栈中的等效项

控制器可以添加对 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

  • 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 堆栈中的等效项

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