Android okHttp網路請求之快取控制Cache-Control

總李寫程式碼發表於2016-05-28
AndroidHTTP快取

前言：

   　前面的學習基本上已經可以完成開發需求了，但是在專案中有時會遇到對請求做個快取，當沒網路的時候優先載入本地快取，基於這個需求我們來學習一直okHttp的Cache-Control。

     okHttp相關文章地址：

Cache-Control：

     Cache-Control指定請求和響應遵循的快取機制。在請求訊息或響應訊息中設定Cache-Control並不會修改另一個訊息處理過程中的快取處理過程。請求時的快取指令有下幾種：

  • Public指示響應可被任何快取區快取。
  • Private指示對於單個使用者的整個或部分響應訊息，不能被共享快取處理。這允許伺服器僅僅描述當使用者的部分響應訊息，此響應訊息對於其他使用者的請求無效。
  • no-cache指示請求或響應訊息不能快取
  • no-store用於防止重要的資訊被無意的釋出。在請求訊息中傳送將使得請求和響應訊息都不使用快取。
  • max-age指示客戶機可以接收生存期不大於指定時間（以秒為單位）的響應。
  • min-fresh指示客戶機可以接收響應時間小於當前時間加上指定時間的響應。
  • max-stale指示客戶機可以接收超出超時期間的響應訊息。如果指定max-stale訊息的值，那麼客戶機可以接收超出超時期指定值之內的響應訊息。

 

CacheControl.java類介紹：

   1.)常用的函式：如下程式碼，裡面已經加了註釋就不一一解釋了，每個函式都是對應一個快取指令設定
           final CacheControl.Builder builder = new CacheControl.Builder();
            builder.noCache();//不使用快取，全部走網路
            builder.noStore();//不使用快取，也不儲存快取
            builder.onlyIfCached();//只使用快取
            builder.noTransform();//禁止轉碼
            builder.maxAge(10, TimeUnit.MILLISECONDS);//指示客戶機可以接收生存期不大於指定時間的響應。
            builder.maxStale(10, TimeUnit.SECONDS);//指示客戶機可以接收超出超時期間的響應訊息
            builder.minFresh(10, TimeUnit.SECONDS);//指示客戶機可以接收響應時間小於當前時間加上指定時間的響應。
            CacheControl cache = builder.build();//cacheControl
 2.)兩個CacheControl常量介紹：
            CacheControl.FORCE_CACHE; //僅僅使用快取
            CacheControl.FORCE_NETWORK;// 僅僅使用網路

舉例，我們設定一個有效期為10秒的CacheControl

            final CacheControl.Builder builder = new CacheControl.Builder();
            builder.maxAge(10, TimeUnit.MILLISECONDS);
            CacheControl cache = builder.build();
3.)請求時如何使用
            final CacheControl.Builder builder = new CacheControl.Builder();
            builder.maxAge(10, TimeUnit.MILLISECONDS);
            CacheControl cache = builder.build();
            final Request request = new Request.Builder().cacheControl(cache).url(requestUrl).build();
            final Call call = mOkHttpClient.newCall(request);//
            call.enqueue(new Callback() {
                @Override
                public void onFailure(Call call, IOException e) {
                    failedCallBack("訪問失敗", callBack);
                    Log.e(TAG, e.toString());
                }

                @Override
                public void onResponse(Call call, Response response) throws IOException {
                    if (response.isSuccessful()) {
                        String string = response.body().string();
                        Log.e(TAG, "response ----->" + string);
                        successCallBack((T) string, callBack);
                    } else {
                        failedCallBack("伺服器錯誤", callBack);
                    }
                }
            });
            return call;
        } catch (Exception e) {
            Log.e(TAG, e.toString());
        }

以上如果cache沒有過去會直接返回cache而不會發起網路請求，若過期會自動發起網路請求。注意：如果您使用FORCE_CACHE和網路的響應需求，OkHttp則會返回一個504提示，告訴你不可滿足請求響應。所以我們加一個判斷在沒有網路的情況下使用

       //判斷網路是否連線
        boolean connected = NetworkUtil.isConnected(context);
         if (!connected) {
             request = request.newBuilder().cacheControl(CacheControl.FORCE_CACHE).build();
          }

okHtitp知識擴充套件：

1.)Interceptor攔截器，見名知意就是攔截操作，這裡用來攔截Request對其做一些特殊處理，舉例：比如上面我們使用到了CacheControl，我們怎麼攔截一個請求在網路不可用的時候使用CacheControl.FORCE_CACHE；
        OkHttpClient.Builder newBuilder = mOkHttpClient.newBuilder();
         newBuilder.addInterceptor(new Interceptor() {
            @Override
            public Response intercept(Chain chain) throws IOException {
                Request request = chain.request();
                boolean connected = NetworkUtil.isConnected(context);
                if (!connected) {
                    request = request.newBuilder().cacheControl(CacheControl.FORCE_CACHE).build();
                }
                Response response = chain.proceed(request);

                return response;
            }
        });
2.）OkHttp 提供了對使用者認證的支援。當 HTTP 響應的狀態程式碼是 401 時，OkHttp 會從設定的 Authenticator 物件中獲取到新的 Request 物件並再次嘗試發出請求。Authenticator 介面中的 authenticate 方法用來提供進行認證的 Request 物件.
        OkHttpClient client = new OkHttpClient();
        client.newBuilder().authenticator(new Authenticator() {
            @Override
            public Request authenticate(Route route, Response response) throws IOException {
                String credential = Credentials.basic("user", "password");
                return response.request().newBuilder()
                        .header("Authorization", credential)
                        .build();
            }
        });

小結：okHttp的簡單使用到此介紹完畢，至於很多高階使用還有待研究。接下來準備研究下OkHttp與retrofit結合使用。

 

相關文章