OkHttp 缓存实战

1、简介

在实际业务中可能某些查询数据，不经常变化，为了节省流量、提高响应速度和增强用户体验等，把变化频率小的数据缓存到本地，以实现复用。

OkHttp 的缓存功能使用起来也比较简单和灵活，接下来我们就来看看

2、配置缓存

配置缓存首先需要创建一个Cache 对象，并且指定缓存目录和缓存大小，然后，调用用 OkHttpClient.Builder() 的 cache() 方法来配置创建的缓存对象。如下所示：

    // 缓存大小
    int cacheSize = 10 * 1024 * 1024; // 10 MiB
    // 缓存目录
    File file = new File("F:\\httpcache");
    // 创建缓存对象
    Cache cache = new Cache(file, cacheSize);
    httpClient = new OkHttpClient.Builder()
        // 设置缓存
        .cache(cache)
        .build();

如果在服务端的接口响应中包含了合适 Cache-Control 响应头，那么，OkHttp 就会默认按此响应头，对数据进行缓存。

Cache-Control 响应头是缓存的一个重点，如果包含了此响应头，在网络请求时，会首先判断缓存是否有效，若有效则直接读取缓存数据，如果失效则会重新请求接口数据。

3、拦截器

有些服务端接口，比如老接口或第三方接口，在响应头中不包含Cache-Control，或者缓存已被禁用。这种情况下要想让缓存功能正常工作，就需要使用自定义拦截器，通过拦截器在给请求的响应中添加合适的Cache-Control响应头即可。如下所示：

// 自定义缓存拦截器
public class CacheInterceptor implements Interceptor{
    private static final String CACHE_CONTROL = "Cache-Control";
    // 缓存时间
    private static final int MAX_AGE = 60;
    private static final String STR_MAX_AGE = "max-age=" + MAX_AGE;

    @NotNull
    @Override
    public Response intercept(@NotNull Chain chain) throws IOException {
        Response response = chain.proceed(chain.request());
        return  response.newBuilder()
            .removeHeader("pragma")
            .addHeader(CACHE_CONTROL, STR_MAX_AGE)
            .build();
    }
}


// 缓存大小
int cacheSize = 10 * 1024 * 1024; // 10 MiB
// 缓存目录
File file = new File("F:\\httpcache");
// 创建缓存对象
Cache cache = new Cache(file, cacheSize);
httpClient = new OkHttpClient.Builder()
    // 设置缓存
    .cache(cache)
    // 添加缓存拦截器
    .addNetworkInterceptor(new CacheInterceptor())
    .build();

4、缓存控制器

以上情况，无论是服务端响应包含Cache-Control 头信息，还是通过拦截器设置的此头信息都属于全局配置，即所有的请求都会缓存，且缓存的时间相同。在实际业务中，可能是有些接口不需要缓存，或者不同接口要求缓存的时间要求不同。要解决这个问题有如下两种办法：

• 在拦截器中根据 请求路径 request.url() 判断设置数据缓存时间。此种方式不优雅，在这就不考虑了
• 使用 OkHttp提供的缓存控制器CacheControl来处理。

OkHttp提供了如下两种默认的缓存控制器：

• CacheControl.FORCE_CACHE 强制使用本地缓存，若缓存不存在则返回一个 code 为 504 的响应
• CacheControl.FORCE_NETWORK 强制使用网络请求

除了上面提供的默认缓存控制器外，还可以通过 CacheControl.Builder() 构建自定义的缓存控制器，可选的设置方法如下：

• noCache() 不使用缓存，使用网络请求
• noStore 不使用缓存，也不存储缓存数据
• maxAge() 缓存的有效时间，超过此时间会重新请求数据
• maxStale() 超过缓存有效时间后，可继续使用旧缓存的时间，之后需要重新请求数据。
• minFresh() 增加额外的缓存有效时间，之后需要重新请求数据
• onlyCached 只是用缓存，不使用网络请求
• noTransform() 不接受经过转码的响应
• immutable() 缓存有效时间内，响应不会变化，避免服务端处理 304 响应

构建一个自定义缓存器如下所示：

// 构建自定义 缓存控制器
CacheControl cacheControl = new CacheControl.Builder()
    .maxAge(10, TimeUnit.SECONDS)
    .maxStale(10, TimeUnit.SECONDS)
    .build();

Request request = new Request.Builder()
    .get()
    // 设置自定义缓存控制器
    .cacheControl(cacheControl)
    .url("http://localhost:10010/index?name=zhangsan&age=20")
    .build();

Call call = httpClient.newCall(request);
Response response = call.execute();

当通过 CacheControl 类设置的缓存时间大于 Cache-Control 响应头时间时，缓存的有效时间为Cache-Control响应头时间，否则使用CacheControl 类设置的时间。

基于此，所以我们可以给有需要的接口请求通过CacheControl类设置缓存策略，然后在拦截器中判断请求是否包含Cache-Control请求头，如果有就把Cache-Control请求头添加到响应中去，这样问题就解决了，修改后的拦截器如下：

 // 自定义缓存拦截器
    public class CacheInterceptor implements Interceptor{
        private static final String CACHE_CONTROL = "Cache-Control";
        // 缓存时间
        private static final int MAX_AGE = 60;
        private static final String STR_MAX_AGE = "max-age=" + MAX_AGE;

        @NotNull
        @Override
        public Response intercept(@NotNull Chain chain) throws IOException {
            Request request = chain.request();
            Response response = chain.proceed(request);
            String header = request.header(CACHE_CONTROL);
            if(header != null && !"".equals(header.trim())){
                return  response.newBuilder()
                        .removeHeader("pragma")
                        .addHeader(CACHE_CONTROL, header)
                        .build();
            }else{
                return response;
            }
        }
    }

5、总结

在OkHttp中也可以使用缓存来减少网络请求。在OkHttp可以通过响应头中的Cache-Control 控制缓存的有效时间，在服务端无法提供Cache-Control 响应头时，可以通过自定义拦截器，在拦截器中对请求响应添加Cache-Control响应头。因为在拦截器中添加的响应头对所有的请求都生效，并且缓存策略相同，如果想不同的请求缓存控制不同，可以通过在 构造 Request 对象时，设置 CacheControl 对象，构建个性化缓存控制策略。