对于最新的稳定版本,请使用 Spring Framework 6.2.0! |
HTTP 缓存
HTTP 缓存可以显著提高 Web 应用程序的性能。HTTP 缓存
围绕Cache-Control
响应标头和后续条件请求
标头,例如Last-Modified
和ETag
.Cache-Control
建议私有(例如,浏览器)
和 public (例如 proxy) caches,了解如何缓存和重用响应。一ETag
header 的
要发出可能导致 304 (NOT_MODIFIED) 没有正文的条件请求,
如果内容未更改。ETag
可以看作是
这Last-Modified
页眉。
本节描述了 Spring WebFlux 中可用的 HTTP 缓存相关选项。
CacheControl
CacheControl
提供支持
配置与Cache-Control
header 并被接受为参数
在许多地方:
虽然 RFC 7234 描述了所有可能的
指令的Cache-Control
response 标头中,CacheControl
type 接受
面向用例的方法,侧重于常见场景,如下例所示:
-
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 缓存的显式支持。我们建议这样做,因为lastModified
或ETag
需要先计算资源的值,然后才能进行比较
针对条件请求标头。控制器可以添加ETag
和Cache-Control
settings 设置为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
requests 中,您可以将响应设置为
304 (NOT_MODIFIED)。对于有条件的POST
,PUT
和DELETE
中,您可以改为设置响应
设置为 412 (PRECONDITION_FAILED) 以防止并发修改。
静态资源
您应该使用Cache-Control
和条件响应标头
以获得最佳性能。请参阅有关配置静态资源的部分。