使用Retrofit和Okhttp实现网络缓存，更新于2016.02.02
本文使用 Retrofit2.0.0-beta2、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
缓存的相关知识和参数的说明,我是个链接1
缓存的相关知识和参数的说明,我是个链接2
在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 使用说明,我是个链接](https://github.com/square/okhttp/wiki/Interceptors" target="_blank)
如果云端现在不方便处理的话，你也可以自己搞定缓存的，那就是写拦截器修改响应头中的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-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也可以试试。
感谢@Picasso_L一起讨论研究
网友评论
1.首先执行用户自定义的，这里是你自己的CacheInterceptor
也就是说，你这里的response是没有写入到缓存目录中去的，那你后续取出来的response的header的数据里面的Cache-Controll还是noCahce吧
https://github.com/yale8848/RetrofitCache
return originalResponse.newBuilder()
.header("Cache-Control", "public, only-if-cached, max-stale=2419200")
.removeHeader("Pragma")
.build();
我的需求是:有网走网络不走缓存,无网走缓存.
楼主能解答下嘛
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
//有网的时候,读接口上的@Headers里的注解配置
String cacheControl = request.cacheControl().toString();
//没有网络并且添加了注解,才使用缓存.
if (!Utils.isOpenInternet()&&!TextUtils.isEmpty(cacheControl)){
//重置请求体;
request = request.newBuilder()
.cacheControl(CacheControl.FORCE_CACHE)
.build();
}
//如果没有添加注解,则不缓存
if (TextUtils.isEmpty(cacheControl)) {
//响应头设置成无缓存
cacheControl = "no-cache";
}
//返回设置好的响应体
Response response = chain.proceed(request);
HLog.i("httpInterceptor", cacheControl);
return response.newBuilder()
.header("Cache-Control", cacheControl)
.removeHeader("Pragma")
.build();
}
};
我现在是这样设置的
return originalResponse.newBuilder()
.header("Cache-Control", "public, only-if-cached, max-stale=2419200")
.removeHeader("Pragma")
.build();
这个断网情况下对应的请求头的max-stale在代码中传的实际是Integer.MAX_VALUE,所以按理说也应该返回这个值.
你可以删掉试一下,看看还可不可以.做一下测试
正常使用应该是,请求者设置max-stale请求服务器,服务器根据这个参数做出相应的响应.返回的响应头还带着这个参数返回.咱们这个做法是本地自己拦截改了响应,正常响应是不会主动设置这个参数的.你可以自己改改做做测试.
Cache cache = provideCache();
OkHttpClient client = new OkHttpClient().newBuilder()
.addNetworkInterceptor(REWRITE_CACHE_CONTROL_INTERCEPTOR)
.cache(cache)
.connectTimeout(20, TimeUnit.SECONDS)
.readTimeout(20, TimeUnit.SECONDS)
.build();
Http 504 Unsatisfiable Request(only-if-cache)
英文文档: https://msdn.microsoft.com/en-us/library/27w3sx5e(v=vs.110).aspx
到头还是去看了英文的文档才能没有歧义地去理解
英文文档: https://msdn.microsoft.com/en-us/library/27w3sx5e(v=vs.110).aspx
因为我看文章也有点讨厌那种就是要讲一个使用的东西,开始就讲各种原理.我的想法是我需要知道这些原理我就去搜这些原理了,所以我也看过你发的那个文档.我想知道一个东西怎么用,那就直说怎么用.
com.google.gson.stream.MalformedJsonException: Use JsonReader.setLenient(true) to accept malformed JSON at line 1 column 1 path $
Use JsonReader.setLenient(true) to accept malformed JSON at line 1 column 1 path $
class java.lang.String
dalvik.system.PathClassLoader[DexPathList[[zip file "/data/app/com.yoloho.lv.httpproject-1/base.apk"],nativeLibraryDirectories=[/data/app/com.yoloho.lv.httpproject-1/lib/arm64, /vendor/lib64, /system/lib64]]]
这里有问题吧。response里的no-cache的意思仅仅是说，在你从缓存中取数据之前要先去服务端做验证，而不是说不能缓存。其实客户端还是做了缓存的。
这个在OKHttp的注释里写的很清楚。
* In a response, this field's name "no-cache" is misleading. It doesn't
* prevent us from caching the response; it only means we have to validate the
* response with the origin server before returning it. We can do this with a
* conditional GET.
请求 @Headers("Cache-Control public,max-age=640000") 也加了 interceptor 打印的日志 显示 请求 和 响应 的 Cache-Control 都是我改之后的了。
可是就是没有写缓存文件-。-，缓存路径：getExternalCacheDir()，大小 20*1024*1024
还有可能有别的什么因素会导致不写缓存么？
我看_set_cookie 里一长串 还跟着个 only-http 会不会和这个有关？
我在@head 里面添加Cache-Control，有网络时也会一直使用缓存到max-stale时间结束，在Interceptor 的request中设置Cache-Control 却 只作用于max-age
int maxStale = 60 * 60 * 24 * 2;
return response.newBuilder().removeHeader("Cache-Control") .header("Cache-Control", "max-age=30,max-stale=" + maxStale).build();
我开飞行模式，超过max-age时间后，maxStale属性没有起作用，并没有读取缓存？
@FormUrlEncoded
@POST("forward/default")
Observable<CommonDataResponse> commonRequest(@Header("cookie") String cookie, @field("content") String context);