|
对于最新的稳定版本,请使用 Spring Framework 7.0.6! |
HTTP缓存
HTTP 缓存可以显著提高 Web 应用程序的性能。HTTP 缓存围绕 Cache-Control 响应头以及随后的条件请求头(如 Last-Modified 和 ETag)。Cache-Control 指导私有(例如,浏览器)和公共(例如,代理)缓存如何缓存和重用响应。ETag 头用于发出条件请求,如果内容未更改,则可能导致 304(NOT_MODIFIED)响应而不带正文。ETag 可以被视为 Last-Modified 头的更高级继任者。
本节描述了Spring Web MVC中可用的与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()
WebContentGenerator 还接受一个更简单的 cachePeriod 属性(以秒为单位定义),其工作方式如下:
-
一个
-1值不会生成一个Cache-Control响应头。 -
一个
0值通过使用'Cache-Control: no-store'指令来防止缓存。 -
一个
n > 0值将使用'Cache-Control: max-age=n'指令将给定的响应缓存n秒。
控制器
Controllers 可以显式添加对 HTTP 缓存的支持。我们建议这样做,因为资源的 lastModified 或 ETag 值需要在与条件请求头进行比较之前计算出来。控制器可以向 5 添加一个 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),以防止并发修改。
静态资源
您应该使用 Cache-Control 和条件响应头来提供静态资源,以获得最佳性能。请参见配置静态资源的部分。
ETag 过滤器
您可以使用 ShallowEtagHeaderFilter 来添加“浅层”eTag 值,这些值是从响应内容中计算得出的,因此可以节省带宽但不能节省CPU时间。请参见浅层ETag。