【Android】使用 Retrofit/OkHttpClient 时的缓存详解

·  阅读 2717
【Android】使用 Retrofit/OkHttpClient 时的缓存详解
原文链接: www.jianshu.com

首选说下个人觉得网络缓存控制的优势:

  • 1.帮app端用户减少流量消耗(因为很多情况下,请求网络返回的response并没有变化),同时提升用户体验,可以在没有网络的情况下也可以查看上次的数据;
  • 2.根据业务场景,设置不同的缓存时间,app端的用户体验提高,稳定性能提高;
  • 3.通过减少很多不必要的http请求,减轻服务器负载,同时也可以减少服务端消耗的数据流量。

本文demo地址

常用的缓存方式:

如果你的网路请求框架是Retrofit或OkHttpClient,那么只需要通过设置cache和Interceptor即可,cache的作用是指定缓存文件地址、大小,Interceptor稍微复杂一些,分为应用拦截、网络拦截两种,主要控制缓存的时间、方式、过滤等。

具体通过代码来讲解:

if (retrofit == null) {
                    retrofit=new Retrofit.Builder().baseUrl("http://gank.io/api/")
                            .addConverterFactory(GsonConverterFactory.create())
                            .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                            //偷个懒直接写一起
                            .client(new OkHttpClient.Builder()
                                    .cache(new Cache(new File(context.getExternalCacheDir(),"test_cache"),10 * 1024 * 1024))
                                    .addInterceptor(new CaheInterceptor(context))
                                    .addNetworkInterceptor(new CaheInterceptor(context))
                                    .connectTimeout(5, TimeUnit.SECONDS)
                                    .build())
                            .build();
                }

上述代码就为retrofit单例添加了缓存机制,最大缓存空间为10Mb,应用拦截与网络拦截也采用了同一个拦截器,简单区别就是

addNetworkInterceptor添加的是网络拦截器,他会在在request和resposne是分别被调用一次,
能够操作中间过程的响应,如重定向和重试;
而addinterceptor添加的是aplication拦截器,他只会在response被调用一次,
且总是只调用一次,不需要担心中间过程的响应。

Interceptor的具体实现也很简单,只需要重写一个intercept方法,在其中处理多种缓存状态,例有网络,无网络,网络状态差等等。

@Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        if (NetworkUtils.isNetworkAvailable(context)) {
            Response response = chain.proceed(request);
            // read from cache for 0 s  有网络不会使用缓存数据
            int maxAge = 10;
            String cacheControl = request.cacheControl().toString();
            return response.newBuilder()
                    .removeHeader("Pragma")
                    .removeHeader("Cache-Control")
                    .header("Cache-Control", "public, max-age=" + maxAge)
                    .build();
        } else {
            //无网络时强制使用缓存数据
            request = request.newBuilder()
                    .cacheControl(CacheControl.FORCE_CACHE)
                    .build();
            Response response = chain.proceed(request);
            //set cahe times ; value is useless at all !
//            int maxStale = 60;
            int maxStale = 60 * 60 * 24 * 3;
            return response.newBuilder()
                    .removeHeader("Pragma")
                    .removeHeader("Cache-Control")
                    .header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
                    .build();
        }
    }

上面的代码仅根据当前有无网络,对返回的数据response做了一个拦截处理,其中需要注意的是

  • removeHeader();去除相关Cache-Control(缓存控制)的HTTP头信息,不用去管,一般都是固定的格式;
  • int maxAge = 10; 该值表示有网络的时候,希望在10S内不去重新获取网络数据,而是直接使用缓存数据;
  • int maxStale = 60 60 24 * 3; 表示在无网络的情况下,在3天内使用缓存数据?但是在demo中实际调试发现,该值并没有什么软用,即使你设置为0,无网络时也会使用缓存数据。原因在这里:
            //无网络时强制使用缓存数据
            request = request.newBuilder()
                    .cacheControl(CacheControl.FORCE_CACHE)
                    .build();

追踪CacheControl.FORCE_CACHE型的cacheControl源码,发现其内部,已经将maxStale 设置为无限大了。

  public static final CacheControl FORCE_CACHE = new Builder()
      .onlyIfCached()
      .maxStale(Integer.MAX_VALUE, TimeUnit.SECONDS)
      .build();

这样,一个简单的缓存方式就完成了,看下demo效果,当我在10S内去不停地获取Gank.io中图片时,返回的一直是同一张,仅当超过设置的maxAge时间后,picurl才更新了:

04-14 16:32:27.858 21905-21905/com.blink.dagger.democache D/luck: pic url :http://ww2.sinaimg.cn/large/7a8aed7bgw1ewees6m58qj20dw0kuadj.jpg
04-14 16:32:27.860 21905-21905/com.blink.dagger.democache D/luck: current time :2017-04-14 16:32:27
04-14 16:32:29.989 21905-21905/com.blink.dagger.democache D/luck: pic url :http://ww2.sinaimg.cn/large/7a8aed7bgw1ewees6m58qj20dw0kuadj.jpg
04-14 16:32:29.991 21905-21905/com.blink.dagger.democache D/luck: current time :2017-04-14 16:32:29
04-14 16:32:31.098 21905-21905/com.blink.dagger.democache D/luck: pic url :http://ww2.sinaimg.cn/large/7a8aed7bgw1ewees6m58qj20dw0kuadj.jpg
04-14 16:32:31.099 21905-21905/com.blink.dagger.democache D/luck: current time :2017-04-14 16:32:31
04-14 16:32:32.481 21905-21905/com.blink.dagger.democache D/luck: pic url :http://ww2.sinaimg.cn/large/7a8aed7bgw1ewees6m58qj20dw0kuadj.jpg
04-14 16:32:32.482 21905-21905/com.blink.dagger.democache D/luck: current time :2017-04-14 16:32:32
04-14 16:32:34.327 21905-21905/com.blink.dagger.democache D/luck: pic url :http://ww2.sinaimg.cn/large/7a8aed7bgw1ewees6m58qj20dw0kuadj.jpg
04-14 16:32:34.328 21905-21905/com.blink.dagger.democache D/luck: current time :2017-04-14 16:32:34
04-14 16:32:36.865 21905-21905/com.blink.dagger.democache D/luck: pic url :http://ww1.sinaimg.cn/large/7a8aed7bjw1ezf3wrxcx2j20p011i7b2.jpg
04-14 16:32:36.867 21905-21905/com.blink.dagger.democache D/luck: current time :2017-04-14 16:32:36

而我们的手机ExternalCacheDir路径下,多了一些二进制文件,所以如果需要做一个清除缓存的功能,在业务代码中delete file即可。


cache_file.png
Cookie缓存:

一般的场景应该都用不到这种缓存方式,仅在每一次请求访问网络的时候,需要根据url将Cookie中的缓存数据提交给后台时才用的着。
使用方法:

.cookieJar(new NovateCookieManger(context))

而且要实现CookieJar非常麻烦:

  • 1.首选需要根据httpurl保存/发送Cookie(实现CookieJar接口);
  • 2.将Map形式的cookies缓存至内存中;
  • 3.将cookies序列化后通过SP持久化至本地;

好在这种反人类的缓存方式一般不用。

Cookie难以被缓存,且大多情境下是没有必要的。如果你非得使用Cookie,建议用在动态页面上。

具体的代码太长了,这儿就不贴了,直接放在demo中了。

不错的参考资料:

Web 开发人员需知的 Web 缓存知识
OkHttp3 (四)——Cookie与拦截器

收藏成功!
已添加到「」, 点击更改