此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Framework 6.2.10! |
HTTP 缓存
HTTP 缓存可以显着提高 Web 应用程序的性能。HTTP 缓存围绕Cache-Control
response 标头,随后的条件请求标头(例如Last-Modified
和ETag
).Cache-Control
建议私有(例如浏览器)和公共(例如代理)缓存,了解如何缓存和重用响应。 一ETag
标头发出条件请求,可能导致没有正文的 304 (NOT_MODIFIED),如果内容没有改变。ETag
可以看作是更复杂的继任者 这Last-Modified
页眉。
本节介绍 Spring Web MVC 中可用的 HTTP 缓存相关选项。
CacheControl
CacheControl
提供支持配置与Cache-Control
标头,并被接受为参数在许多地方:
虽然 RFC 7234 描述了所有可能的指令Cache-Control
response 标头,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
response 标头。 -
一个
0
值通过使用'Cache-Control: no-store'
命令。 -
一
n > 0
value 缓存给定的响应n
秒,使用'Cache-Control: max-age=n'
命令。
控制器
控制器可以添加对 HTTP 缓存的显式支持。我们建议这样做,因为lastModified
或ETag
需要先计算资源的值,然后才能对其进行比较与条件请求标头。控制器可以添加ETag
header 和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(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),以防止并发修改。
静态资源
您应该使用Cache-Control
和条件响应标头
以获得最佳性能。请参阅有关配置静态资源的部分。
ETag
Filter
您可以使用ShallowEtagHeaderFilter
添加“浅”eTag
从
响应内容,从而节省带宽,但不能节省 CPU 时间。请参阅浅 ETag。