spring 之 Http Cache 和 Etag

0 前沿

缓存对于计算机网络是一个很重要的概念。比如cpu的一级、二级，甚至三级缓存，内存由可以理解为cpu高速缓存的缓存，而磁盘（硬盘）是内存的缓存。那磁盘的缓存呢？那当然是网络了。http同样也对缓存提供了支持。http头中有这样两个属性：Cache-Control和If-None-Match

• Cache-Control:max-age=xxx 在该时间内，浏览器如果发起请求，会直接去获取浏览器的缓存，而不是向服务器发送请求
• If-None-Match:< ETag> 浏览器发起请求到服务器，如果服务器通过计算请求资源的Etag和请求携带的Etag值相同，则返回空body的304（表示资源未修改），否则返回请求资源（这种模式只是节省了网络带宽，但是并未节省服务器端的cpu资源，因为你还是需要计算请求资源的Etag）

1 Spring 实现Etag

spring默认是通过ShallowEtagHeaderFilter这个过滤器来实现的。该过滤器会计算资源的md5位Etag。注意是response body的md5值，response body 可能是html,css,json等等资源。

1.1 如何配置该过滤器呢（笔者使用的是springboot）

@Configuration
public class WebConfig {
  @Bean
  public Filter shallowEtagHeaderFilter() {
    return new ShallowEtagHeaderFilter();
  }
}

很简单，声明一个bean就可以了

1.2 测试（笔者使用了 Restlet Client 插件）

handler实现

@GetMapping("/doc2")
public String getDoc1() {
    return "doc";
}

request header

http://localhost:8080/doc2

response

ETag:   "09a09b4dfda82e3e665e31092d1c3ec8d"
Content-Type:   text/plain;charset=UTF-8
Content-Length: 3 bytes
Date:   
Thu, 08 Mar 2018 06:37:33 GMT
Body:doc

但是计算md5 cpu开销太大，有时后服务器只是返回资源的版本，那如何实现呢？

1.3 ResponseEntity

@GetMapping("/book/{id}")
public ResponseEntity<Book> showBook(@PathVariable Long id) {

    Book book = findBook(id);
    String version = book.getVersion();

    return ResponseEntity
                .ok()
                .eTag(version) // lastModified is also available
                .body(book);
}

最后的return语句会有如下效果，如果服务器计算的etag和请求头的etag相同,则返回状态码304的空响应；否则返回请求资源。是不是发现不管etag是否相等，整个请求还是完整的走了一遍。（当然这时候你不应该再配置ShallowEtagHeaderFilter了）。

2 spring 实现 Cache-Control

2.1 Static resources

@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());
    }
}

2.2 @Controller

@GetMapping("/doc")
    public ResponseEntity<String> getDoc() {
        if (doc_version%5 == 0) etag_version++;
        return ResponseEntity
                .ok()
                .cacheControl(CacheControl.maxAge(5, TimeUnit.MINUTES))
                .body(doc + doc_version++);
    }

2.3 测试

handler

@GetMapping("/doc")
    public ResponseEntity<String> getDoc() {
        if (doc_version%5 == 0) etag_version++;
        return ResponseEntity
                .ok()
                .cacheControl(CacheControl.maxAge(5, TimeUnit.MINUTES))
                .body(doc + doc_version++);
    }

request hander

http://localhost:8080/doc

response

Cache-Control:  max-age=5
Content-Type:   text/plain;charset=UTF-8
Content-Length: 8 bytes
Date:   Thu, 08 Mar 2018 07:13:13 GMT
Body: version1

3 重点总结

Etag 只会节省网络带宽资源，并不会节省服务器cpu资源，因为服务器会为每个请求计算请求资源的Etag。