一个好的HTTP缓存策略可以极大的提升web应用的性能和体验。主要使用的HTTP 的响应头Cache-Control
来控制,也可以选择使用Last-Modified
和ETag
。
HTTP响应头Cache-Control
建议私有缓存(例如,浏览器)和公有缓存(例如,代理)如何缓存HTTP响应以便日后重用。
ETag
是又兼容HTTP/1.1
的服务器返回的,用来检测一个URL的返回值是否有变化。可以被认为是Last-Modified
更复杂的一个继承者。当server返回一个带有ETag
的响应的时候,客户端可以在随后的GET请求中带上If-None-Match
,如果内容未变,那么服务器就会返回: 304 Not Modified。
Spring MVC 支持多种方式配置Cache-Control
。RFC 7234详细描述了这个header。
Spring MVC使用setCachePeriod(int seconds)
进行配置:
Cache-Control
Cache-Control: no-store
Cache-Control: max-age=n
CacheControl
类可以表示Cache-Control
指令,是的构建缓存策略更加的简单。一旦构建完成,就可以在多个Spring MVC的API中使用CacheControl
。例如:
// 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-Control
。配置ResourceHttpRequestHandler
不仅仅会给根据文件的元信息添加Last-Modified
,也会根据配置添加合适的Cache-Control
。
可以通过设置ResourceHttpRequestHandler
的cachePeriod
或者使用CacheControl
。
Java 配置如下:
@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/resources/**")
.addResourceLocations("/public-resources/")
.setCacheControl(CacheControl.maxAge(1, TimeUnit.HOURS).cachePublic());
}
}
XML 配置如下:
<mvc:resources mapping="/resources/**" location="/public-resources/">
<mvc:cache-control max-age="3600" cache-public="true"/>
</mvc:resources>
controller支持Cache-Control
,ETag
,Last-Modified-Since
的请求。比较推荐的做法是在响应中添加Cache-Control
。controller可以返回一个包含cache信息的ResponseEntity
,例如:
@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);
}
这么做不仅仅是在响应中添加ETag
和Cache-Control
头,再次请求如果客户端发送的请求和controller的cache信息匹配,会返回一个不包含响应体的304 Not Modified。
@RequestMapping
同样也支持这么做,示例:
@RequestMapping
public String myHandleMethod(WebRequest webRequest, Model model) {
long lastModified = // 1. application-specific calculation
if (request.checkNotModified(lastModified)) {
// 2. shortcut exit - no further processing necessary
return null;
}
// 3. or otherwise further request processing, actually preparing content
model.addAttribute(...);
return "myViewName";
}
这里有两个关键点,调用request.checkNotModified(lastModified)
和返回null
。前者设置合适的响应状态和头,后者告诉Spring MVC无需继续处理。
注意,这个函数有三个签名:
request.checkNotModified(lastModified) 通过
If-Modified-Since或者
If-Unmodified-Since`和上次修改时间对比。request.checkNotModified(eTag)
对比请求头的If-None-Match
。当发送GET,HEAD请求的时候,checkNotModified
检测资源收否被修改,如果未修改返回304,当发送POST,PUT,DELETE请求的时候检测资源是否已经被修改了,如果被修改了返回409 防止并发修改。
由ShallowEtagHeaderFilter
提供ETag过滤器的支持,这个一个标准的Servlet过滤器,所以可以很方便的与SpringMVC集成。ShallowEtagHeaderFilter
根据要缓存的内容计算MD5,然后写入的响应头中,等下次客户端访问的时候获取If-None-Match
值,然后继续正常的处理请求,请求返回的时候对返回内容计算MD5,如果两者相同直接返回304。
注意:因为整个处理流程仍然走了以便,所以这种方式虽然节省了带宽但是并没有节省计算量。上述其他的策略是可以避免计算的。