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-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()
WebContentGenerator
还接受一个更简单的cachePeriod
属性(以秒为单位)的设置,工作如下:
-
值为
-1
不生成Cache-Control
响应头。 -
值为
0
通过使用'Cache-Control: no-store'
指令来防止缓存。 -
值为
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)
}
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。