使用Retrofit2.0+OkHttp3.0實現緩存處理

最近在寫一個信息流的項目,整個架構是基于 MVP + Retrofit + Rxjava 實現的,由于剛剛使用 RxJava + Retrofit,對它理解不深,所以在一開始做數據緩存的時候還是用常規(guī)思維來設計的。

想到的緩存處理方式:

  • 使用 sharedpreferences
  • 使用 SqLite 數據庫

但是有一個問題:

  • Retrofit + RxJava 之所以強大,有一點,是可以直接將返回的JSON數據轉化為我們的 JavaBean 對象,直接操作。
  • 如果使用常規(guī)方式處理,我們只是緩存JSON數據,在操作的時候還是要通過GSON轉化為對象。
  • 那這樣,我們就沒有體現出 Retrofit 的強大之處,所以我想如果Retrofit能夠做緩存處理就好了。

這里要吐槽一句,網上關于 Retrofit 和 RxJava 的相關資料真的很少,而且大部分都是重復或只寫了一個片段,但功夫不負有心人,還是找到了一些解決方法。

先說一下為什么要做緩存處理?

有一篇文章是這樣說的:

減少服務器負荷,降低延遲提升用戶體驗。復雜的緩存策略會根據用戶當前的網絡情況采取不同的緩存策略,比如在2g網絡很差的情況下,提高緩存使用的時間;不用的應用、業(yè)務需求、接口所需要的緩存策略也會不一樣,有的要保證數據的實時性,所以不能有緩存,有的你可以緩存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();
}

可以看到上面兩個有設置了相同的內容,有什么區(qū)別呢?

有篇文章是這樣解釋的:

如果.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會在檢查到沒緩存之后自動請求網絡服務器數據,這里要自己處理好后續(xù)的操作,比如彈個吐司什么的告訴用戶沒有網絡了。
  • 緩存數據也是需要網絡下載的,所以在網絡不好的情況下,可能不能立即緩存,這也是我之前犯暈的地方:明明已經設置好緩存了,為什么有時候有緩存,有時候沒有呢?- -真是對自己的智商捉急。

相關文章

Contact Me

因為我也是剛剛接觸 Retrofit + RxJava ,所以有寫的不好或不對,以及表達不清楚的地方,請及時指出,我及時修改,PS:不過上面的代碼在我測試后是完全可以進行緩存的,希望可以幫到你們。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內容

友情鏈接更多精彩內容