使用Retrofit2.0+OkHttp3.0实现缓存处理

最近在写一个信息流的项目,整个架构是基于 MVP + Retrofit + Rxjava 实现的,由于刚刚使用 RxJava + Retrofit,对它理解不深,所以在一开始做数据缓存的时候还是用常规思维来设计的。

想到的缓存处理方式:

  • 使用 sharedpreferences
  • 使用 SqLite 数据库

但是有一个问题:

  • Retrofit + RxJava 之所以强大,有一点,是可以直接将返回的JSON数据转化为我们的 JavaBean 对象,直接操作。
  • 如果使用常规方式处理,我们只是缓存JSON数据,在操作的时候还是要通过GSON转化为对象。
  • 那这样,我们就没有体现出 Retrofit 的强大之处,所以我想如果Retrofit能够做缓存处理就好了。

这里要吐槽一句,网上关于 Retrofit 和 RxJava 的相关资料真的很少,而且大部分都是重复或只写了一个片段,但功夫不负有心人,还是找到了一些解决方法。

先说一下为什么要做缓存处理?

有一篇文章是这样说的:

减少服务器负荷,降低延迟提升用户体验。复杂的缓存策略会根据用户当前的网络情况采取不同的缓存策略,比如在2g网络很差的情况下,提高缓存使用的时间;不用的应用、业务需求、接口所需要的缓存策略也会不一样,有的要保证数据的实时性,所以不能有缓存,有的你可以缓存5分钟,等等。你要根据具体情况所需数据的时效性情况给出不同的方案。当然你也可以全部都一样的缓存策略,看你自己。

Retrofit+OkHttp的缓存机制

  • 在响应请求之后在 data/data/<包名>/cache 下建立一个response 文件夹,保持缓存数据。
  • 这样我们就可以在请求的时候,如果判断到没有网络,自动读取缓存的数据。
  • 同样这也可以实现,在我们没有网络的情况下,重新打开App可以浏览的之前显示过的内容。
  • 也就是:判断网络,有网络,则从网络获取,并保存到缓存中,无网络,则从缓存中获取。

缓存实现方式

  1. 先开启OkHttp缓存

    在Retrofit2.0版本之后,Retrofit底层自动依赖了OkHttp,所以我们不用重复依赖Okhttp了

    File httpCacheDirectory = new File(MyApp.mContext.getCacheDir(), "responses");
    int cacheSize = 10 * 1024 * 1024; // 10 MiB
    Cache cache = new Cache(httpCacheDirectory, cacheSize);
    
    OkHttpClient client = new OkHttpClient.Builder()
            .addInterceptor(REWRITE_CACHE_CONTROL_INTERCEPTOR)
            .cache(cache).build();
    

    这一步是设置缓存路径,以及缓存大小,其中addInterceptor是我们第二步的内容。

  2. 设置 OkHttp 拦截器

    主要是拦截操作,包括控制缓存的最大生命值,控制缓存的过期时间

    两个操作都是在 Interceptor 中进行的

    • 通过 CacheControl 控制缓存数据
      CacheControl.Builder cacheBuilder = new CacheControl.Builder();
      cacheBuilder.maxAge(0, TimeUnit.SECONDS);//这个是控制缓存的最大生命时间
      cacheBuilder.maxStale(365,TimeUnit.DAYS);//这个是控制缓存的过时时间
      CacheControl cacheControl = cacheBuilder.build();
      
  • 设置拦截器
Request request = chain.request();
if(!StateUtils.isNetworkAvailable(MyApp.mContext)){
    request = request.newBuilder()
            .cacheControl(cacheControl)
            .build();
}
Response originalResponse = chain.proceed(request);
if (StateUtils.isNetworkAvailable(MyApp.mContext)) {
    int maxAge = 60; // read from cache
    return originalResponse.newBuilder()
            .removeHeader("Pragma")
            .header("Cache-Control", "public ,max-age=" + maxAge)
            .build();
} else {
    int maxStale = 60 * 60 * 24 * 28; // tolerate 4-weeks stale
    return originalResponse.newBuilder()
            .removeHeader("Pragma")
            .header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
            .build();
}

可以看到上面两个有设置了相同的内容,有什么区别呢?

有篇文章是这样解释的:

如果.maxAge(0,TimeUnit.SECONDS)设置的时间比拦截器长是不起效果,如果设置比拦截器设置的时间短就会以这个时间为主,我觉得是为了方便控制。.maxStale(365, TimeUnit.DAYS)设置的是过时时间,我觉得okthhp缓存分成了两个来考虑,一个是为了请求时直接拿缓存省流量,一个是为了下次进入应用时可以直接拿缓存。

全部代码

通过这样,我们就可以直接使用同一个Retrofit请求方法,无论是最新数据还是缓存数据,都可以转化为我们需要的对象,直接来使用。

weiBoApiRetrofit() {

    //cache url
    File httpCacheDirectory = new File(MyApp.mContext.getCacheDir(), "responses");
    int cacheSize = 10 * 1024 * 1024; // 10 MiB
    Cache cache = new Cache(httpCacheDirectory, cacheSize);

    OkHttpClient client = new OkHttpClient.Builder()
            .addInterceptor(REWRITE_CACHE_CONTROL_INTERCEPTOR)
            .cache(cache).build();

    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(BASE_URL)
            .client(client)
            .addConverterFactory(GsonConverterFactory.create())
            .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
            .build();

    WeiBoApiService = retrofit.create(WeiBoApi.class);
}

  //cache
  Interceptor REWRITE_CACHE_CONTROL_INTERCEPTOR = chain -> {

      CacheControl.Builder cacheBuilder = new CacheControl.Builder();
      cacheBuilder.maxAge(0, TimeUnit.SECONDS);
      cacheBuilder.maxStale(365,TimeUnit.DAYS);
      CacheControl cacheControl = cacheBuilder.build();

      Request request = chain.request();
      if(!StateUtils.isNetworkAvailable(MyApp.mContext)){
          request = request.newBuilder()
                  .cacheControl(cacheControl)
                  .build();
      }
      Response originalResponse = chain.proceed(request);
      if (StateUtils.isNetworkAvailable(MyApp.mContext)) {
          int maxAge = 0; // read from cache
          return originalResponse.newBuilder()
                  .removeHeader("Pragma")
                  .header("Cache-Control", "public ,max-age=" + maxAge)
                  .build();
      } else {
          int maxStale = 60 * 60 * 24 * 28; // tolerate 4-weeks stale
          return originalResponse.newBuilder()
                  .removeHeader("Pragma")
                  .header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
                  .build();
      }
    };
}

注意的问题

  • 缓存是在每一次网络请求之后,重新保存的,所以在超过缓存过期时间后,Retrofit会在检查到没缓存之后自动请求网络服务器数据,这里要自己处理好后续的操作,比如弹个吐司什么的告诉用户没有网络了。
  • 缓存数据也是需要网络下载的,所以在网络不好的情况下,可能不能立即缓存,这也是我之前犯晕的地方:明明已经设置好缓存了,为什么有时候有缓存,有时候没有呢?- -真是对自己的智商捉急。

相关文章

Contact Me

因为我也是刚刚接触 Retrofit + RxJava ,所以有写的不好或不对,以及表达不清楚的地方,请及时指出,我及时修改,PS:不过上面的代码在我测试后是完全可以进行缓存的,希望可以帮到你们。

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

推荐阅读更多精彩内容