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。