HTTP缓存

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

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

CacheControl

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

控制器

控制器可以添加对HTTP缓存的显式支持。我们建议这样做,因为资源的lastModifiedETag值需要在与条件请求头进行比较之前计算出来。控制器可以向ResponseEntity添加ETagCache-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)响应。否则,将ETagCache-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值或两者进行比较。对于条件GETHEAD请求,您可以将响应设置为304(NOT_MODIFIED)。对于条件POSTPUTDELETE,您可以改为将响应设置为412(PRECONDITION_FAILED)以防止并发修改。

静态资源

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