HTTP 缓存

查看 Reactive 堆栈中的等效项

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

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

CacheControl

查看 Reactive 堆栈中的等效项

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

WebContentGenerator 还接受一个更简单的 cachePeriod 属性（以秒为单位定义），其工作方式如下

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

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

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

控制器

查看 Reactive 堆栈中的等效项

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

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

静态资源

查看 Reactive 堆栈中的等效项

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

ETag 过滤器

您可以使用 ShallowEtagHeaderFilter 添加“浅层”eTag 值，这些值是从响应内容计算得出的，因此可以节省带宽，但不会节省 CPU 时间。请参阅 浅层 ETag。