HTTP 缓存
HTTP缓存可以显著提高Web应用程序的性能。HTTP缓存主要依赖于Cache-Control响应头,以及随后的条件请求头(如Last-Modified和ETag)。Cache-Control头指导私有缓存(例如浏览器缓存)和公共缓存(例如代理缓存)如何缓存和重用响应内容。ETag头用于发送条件请求,如果内容没有发生变化,该请求可能会返回304(NOT MODIFYED)状态码且不包含响应体。可以说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'指令来禁止缓存。 - 值大于
0(即n > 0)时,会使用'Cache-Control: max-age=n'指令将响应缓存n秒。
控制器
控制器可以明确支持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 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
}
modele.addAttribute(...); 3
return "myViewName";
}
应用程序特定的计算。
响应状态被设置为304(NOT_MODIFIED)——不再进行进一步处理。
继续请求处理。
@RequestMapping
fun myHandleMethod(request: WebRequest, model: Model): String? {
val eTag: Long = ... 1
if (request.checkNotModified(eTag)) {
return null 2
}
:model[...] = ... 3
return "myViewName"
}
应用程序特定的计算。
响应状态被设置为304(NOT_MODIFIED)——不再进行进一步处理。
- \ [#3] 继续请求处理。
有三种方法可以用来根据eTag值、lastModified值或两者来检查条件请求。对于条件性的GET和HEAD请求,你可以将响应设置为304(NOT_MODIFIED)。而对于条件性的POST、PUT和DELETE请求,你可以将响应设置为412(PRECONDITION_FAILED),以防止并发修改。
静态资源
为了获得最佳性能,你应该使用 Cache-Control 和条件响应头来提供静态资源。请参阅关于配置静态资源的章节。
ETag 过滤器
你可以使用ShallowEtagHeaderFilter来添加从响应内容中计算出的“浅层”eTag值,这样可以节省带宽,但不会消耗CPU时间。请参阅浅层ETag。