需求

• 手機無網絡時能查看緩存數據
• 有些數據變動較小，不必每次重新請求，緩解服務器壓力

結果

• 所有返回均自動緩存，無網絡時默認使用緩存數據 （如果有）
• 所有請求默認復用時間為 10s，復用時間內新的請求不訪問服務器，使用緩存數據 （如果有）
• 可針對不同接口設置復用時間，也可不復用 （設置為 0s）

條件

GET請求

實現

• 設置緩存存儲位置及大小

Cache cache = new Cache(new File(getCacheDir(mContext), "responses"), 1024 * 1024 * 50)

• 自定義緩存攔截器

public class OKHttpCacheInterceptor implements Interceptor {

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        if (!isNetworkAvailable(App.getApplication())) {
            // 網絡不可用時強制使用緩存
            request = request.newBuilder()
                    .cacheControl(CacheControl.FORCE_CACHE)
                    .build();
        } else if (TextUtils.isEmpty(request.header("Cache-Control"))) {
            // 網絡可用 && 未設置復用時間 -> 默認復用時間為 10s
            request = request.newBuilder()
                    .header("Cache-Control", "private, max-stale=10")
                    .build();
        }
        Response response = chain.proceed(request);
        if (response.code() == 504) {
            throw new IOException("網絡連接不可用");
        }
        return response.newBuilder()
                .removeHeader("Pragma")
                .build();
    }

    /**
     * 判斷網絡是否有效
     */
    private boolean isNetworkAvailable(Context context) {
        NetworkInfo netInfo = getNetworkInfo(context);
        return netInfo != null && netInfo.isAvailable();
    }

    /**
     * 獲取當前網絡信息
     */
    private NetworkInfo getNetworkInfo(Context context) {
        if (null != context) {
            ConnectivityManager mConnectivityManager = (ConnectivityManager) context
                    .getSystemService(Context.CONNECTIVITY_SERVICE);
            return mConnectivityManager.getActiveNetworkInfo();
        }
        return null;
    }
}

• 創建客戶端實例

new OkHttpClient.Builder()
    .addInterceptor(new OKHttpCacheInterceptor ())
    .cache(cache)
    .build()

• Retrofit 初始化

ClientAPI api = new Retrofit.Builder()
    .baseUrl(BASE_URL) 
    .addConverterFactory(converterFactory)
    .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
    .client(client)
    .build()
    .create(ClientAPI.class);

• API接口

public interface ClientAPI {

    /**
     * get 
     *
     * @return Daily
     */
    // 指定返回復用時間為 60s
    @Headers("Cache-Control: max-stale=60")
    @GET("news/latest")
    Observable<Daily> getDaily();

    ...
}

• 使用

api.getDaily()
    .subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(daily -> {
        ...
     }, e -> Snackbar.make(binding.recycler, e.getMessage(), Snackbar.LENGTH_INDEFINITE).show());

• 補充
  當服務器返回Cache-Control: must-revalidate時無法緩存，此時需加上另外一個網絡攔截器（慎用）

@Override
  public Response intercept(Chain chain) throws IOException {
    return chain.proceed(chain.request())
        .newBuilder()
        .removeHeader("Pragma")
        .removeHeader("Cache-Control")
        .build();
  }

addNetworkInterceptor(new OKHttpCacheNetworkInterceptor())

• 完整代碼已上傳至 github
  https://github.com/gavinxxxxxx/Sensual