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-Control: max-age=3600"
CacheControl ccCacheOneHour = CacheControl.maxAge(1, TimeUnit.HOURS);

// 防止缓存 - "Cache-Control: no-store"
CacheControl ccNoStore = CacheControl.noStore();

// 在公共和私有缓存中缓存十天，
// 公共缓存不应转换响应
// "Cache-Control: max-age=864000, public, no-transform"
CacheControl ccCustom = CacheControl.maxAge(10, TimeUnit.DAYS).noTransform().cachePublic();
// 缓存一小时 - "Cache-Control: max-age=3600"
val ccCacheOneHour = CacheControl.maxAge(1, TimeUnit.HOURS)

// 防止缓存 - "Cache-Control: no-store"
val ccNoStore = CacheControl.noStore()

// 在公共和私有缓存中缓存十天，
// 公共缓存不应转换响应
// "Cache-Control: max-age=864000, public, no-transform"
val ccCustom = CacheControl.maxAge(10, TimeUnit.DAYS).noTransform().cachePublic()

控制器

在Servlet堆栈中查看等效内容

控制器可以显式支持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也可用
			.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也可用
			.body(book)
}

前面的示例如果与条件请求标头的比较表明内容未更改，则发送一个带有空主体的304（未修改）响应。否则，将向响应添加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（未修改）。不再进行进一步处理。
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（未修改）。不再进行进一步处理。
3 继续请求处理。

有三种变体可用于检查条件请求与eTag值、lastModified值或两者之间的比较。对于条件GET和HEAD请求，您可以将响应设置为304（未修改）。对于条件POST、PUT和DELETE请求，您可以将响应设置为412（前提条件失败）以防止并发修改。

静态资源

在Servlet堆栈中查看等效内容

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