使用Retrofit和Okhttp实现网络缓存。无网读缓存，有网根据过时时间从新请求 （转）

使用Retrofit和Okhttp实现网络缓存，更新于2016.02.02
原文连接：http://www.jianshu.com/p/9c3b4ea108a7

---

本文使用 Retrofit2.0.0-beta二、Okhttp 2.6.0（Okhttp3.0以后api写法有变化）

• 配置Okhttp的Cache
• 配置请求头中的cache-control或者统一处理全部请求的请求头
• 云端配合设置响应头或者本身写拦截器修改响应头中cache-control

---

最后实现的效果是：有网的时候根据你每一个接口设置的须要缓存的时间（1分钟、5分钟等）进行缓存，过了时间从新请求；没网的时候读缓存。

在这里插一句为何要作缓存，或者说有什么好处？
减小服务器负荷，下降延迟提高用户体验。复杂的缓存策略会根据用户当前的网络状况采起不一样的缓存策略，好比在2g网络不好的状况下，提升缓存使用的时间；不用的应用、业务需求、接口所须要的缓存策略也会不同，有的要保证数据的实时性，因此不能有缓存，有的你能够缓存5分钟，等等。你要根据具体状况所需数据的时效性状况给出不一样的方案。固然你也能够所有都同样的缓存策略，看你本身。

1.配置okhttp中的Cache

OkHttpClient okHttpClient = new OkHttpClient();
File cacheFile = new File(context.getCacheDir(), "[缓存目录]");
Cache cache = new Cache(cacheFile, 1024 * 1024 * 100); //100Mb
okHttpClient.setCache(cache);

2.配置请求头中的cache-control

缓存的相关知识和参数的说明,我是个连接

在Retrofit中，咱们能够经过@Headers来配置，如：

@Headers("Cache-Control: public, max-age=3600) @GET("merchants/{shopId}/icon") Observable<ShopIconEntity> getShopIcon(@Path("shopId") long shopId);

没有设置的能够即为有网的时候不进行缓存。

或者你全部接口在有网的时候都不须要缓存或者都须要缓存且时间同样，那么也不用配置每一个接口的@Headers的Cache-Control了。

3.云端配合设置响应头或者本身写拦截器修改响应头response中cache-control

到这一步缓存就已经待在你的缓存目录了。
若是云端有处里cache的话，就已经能够了。
可是极可能云端没有处理，因此返回的响应头中cache-control是no-cache，这时候你仍是没法作缓存，你们能够用okhttp的写日志拦截器查看响应头的内容。

Okhttp Interceptors 使用说明,我是个连接

若是云端如今不方便处理的话，你也能够本身搞定缓存的，那就是写拦截器修改响应头中的cache-control。我把请求头中的cache-control读出来而后设置到了响应头中。

设置拦截器：
REWRITE_CACHE_CONTROL_INTERCEPTOR拦截器须要同时设置networkInterceptors和interceptors（OKHTTP3.0配置是否有效待我测试）

okHttpClient.interceptors().add(LoggingInterceptor);
okHttpClient.networkInterceptors().add(REWRITE_CACHE_CONTROL_INTERCEPTOR);
okHttpClient.interceptors().add(REWRITE_CACHE_CONTROL_INTERCEPTOR);

拦截器以下：云端响应头拦截器，用来配置缓存策略

/** * 云端响应头拦截器，用来配置缓存策略 * Dangerous interceptor that rewrites the server's cache-control header. */private final Interceptor REWRITE_CACHE_CONTROL_INTERCEPTOR = chain -> {
    Request request = chain.request();
    if(!NetUtils.hasNetwork(context)){
        request = request.newBuilder()
                .cacheControl(CacheControl.FORCE_CACHE)
                .build();
        Logger.t(TAG).w("no network");
    }
    Response originalResponse = chain.proceed(request);
    if(NetUtils.hasNetwork(context)){
        //有网的时候读接口上的@Headers里的配置，你能够在这里进行统一的设置String cacheControl = request.cacheControl().toString();
        return originalResponse.newBuilder()
                .header("Cache-Control", cacheControl)
                .removeHeader("Pragma")
                .build();
    }else{
        return originalResponse.newBuilder()
                .header("Cache-Control", "public, only-if-cached, max-stale=2419200")
                .removeHeader("Pragma")
                .build();
    }
};

最后日志拦截器也贴上来吧

private final Interceptor LoggingInterceptor = chain -> { 
    Request request = chain.request(); 
    long t1 = System.nanoTime();
    Logger.t(TAG).i(String.format("Sending request %s on %s%n%s", request.url(),  chain.connection(), request.headers()));
    Response response = chain.proceed(request); 
    long t2 = System.nanoTime(); 
    Logger.t(TAG).i(String.format("Received response for %s in %.1fms%n%s", response.request().url(), (t2 - t1) / 1e6d, response.headers())); 
    return response; 
};

---

如下测试Cache-Control的配置在请求头和响应头中都有且同样。

max-stale在请求头设置有效，在响应头设置无效。
max-stale和max-age同时设置的时候，缓存失效的时间按最长的算。
关于max-age和max-stale我这里作了一个测试：
测试结果：
我在请求头中设置了：Cache-Control: public, max-age=60,max-stale=120,响应头的Cache-Control和请求头同样。

• 在第一次请求数据到一分钟以内，响应头有：Cache-Control: public, max-age=60,max-stale=120
• 在1分钟到3分钟在之间，响应头有：Cache-Control: public, max-age=60,max-stale=120
  Warning: 110 HttpURLConnection "Response is stale"
  能够发现多了一个Warning。
• 三分钟的时候：从新请求了数据，如此循环，若是到了从新请求的节点此时没有网，则请求失败。

另外关于缓存有一个rxcache也能够试试。

文／never615（简书做者）

来自为知笔记(Wiz)