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

okhttp.jpg

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

  • 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与拦截器

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,612评论 5 471
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,345评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,625评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,022评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,974评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,227评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,688评论 3 392
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,358评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,490评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,402评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,446评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,126评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,721评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,802评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,013评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,504评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,080评论 2 341

推荐阅读更多精彩内容