Android的OkHttp包中的HTTP攔截器Interceptor用法示例

更新時間：2016年07月13日 11:30:08 作者：bng86

攔截器是OkHttp處理HTTP請求方面所具有的一個強大特性,這里我們就來看一下Android的OkHttp包中的HTTP攔截器Interceptor用法示例,需要的朋友可以參考下

OkHttp（GitHub：https://github.com/square/okhttp）的 Interceptor 就如同名稱「攔截器」一樣，攔截你的 Request 做一些你想做的事情再送出去。例如：
1.自動加上使用者目前使用的語言送出去取得對應(yīng)語言的回傳內(nèi)容。
2.將 Request 計算出這個 Request 的 sigunature 再附加上送出去。
在 okHttp 中分成 Application Interceptor 和 Network Interceptor 兩種。 Application Interceptor 是會可以被 cache 起來的。如官網(wǎng)的圖片：

2016713112153384.png (1200×1100)

攔截器是 OkHttp 提供的對 HTTP 請求和響應(yīng)進行統(tǒng)一處理的強大機制。攔截器在實現(xiàn)和使用上類似于 Servlet 規(guī)范中的過濾器。多個攔截器可以鏈接起來，形成一個鏈條。攔截器會按照在鏈條上的順序依次執(zhí)行。攔截器在執(zhí)行時，可以先對請求的 Request 對象進行修改；再得到響應(yīng)的 Response 對象之后，可以進行修改之后再返回。
Interceptor 接口只包含一個方法 intercept，其參數(shù)是 Chain 對象。Chain 對象表示的是當(dāng)前的攔截器鏈條。通過 Chain 的 request 方法可以獲取到當(dāng)前的 Request 對象。在使用完 Request 對象之后，通過 Chain 對象的 proceed 方法來繼續(xù)攔截器鏈條的執(zhí)行。當(dāng)執(zhí)行完成之后，可以對得到的 Response 對象進行額外的處理。
記錄請求和響應(yīng)信息的攔截器：

public class LoggingInterceptor implements Interceptor {
public Response intercept(Chain chain) throws IOException {
 Request request = chain.request();

 long t1 = System.nanoTime();
 System.out.println(String.format("發(fā)送請求: [%s] %s%n%s",
   request.url(), chain.connection(), request.headers()));

 Response response = chain.proceed(request);

 long t2 = System.nanoTime();
 System.out.println(String.format("接收響應(yīng): [%s] %.1fms%n%s",
   response.request().url(), (t2 - t1) / 1e6d, response.headers()));

 return response;
}
}

OkHttp 中的攔截器分成應(yīng)用和網(wǎng)絡(luò)攔截器兩種。應(yīng)用攔截器對于每個 HTTP 響應(yīng)都只會調(diào)用一次，可以通過不調(diào)用 Chain.proceed 方法來終止請求，也可以通過多次調(diào)用 Chain.proceed 方法來進行重試。網(wǎng)絡(luò)攔截器對于調(diào)用執(zhí)行中的自動重定向和重試所產(chǎn)生的響應(yīng)也會被調(diào)用，而如果響應(yīng)來自緩存，則不會被調(diào)用。
添加應(yīng)用和網(wǎng)絡(luò)攔截器

client.interceptors().add(new LoggingInterceptor()); //添加應(yīng)用攔截器
client.networkInterceptors().add(new LoggingInterceptor()); //添加網(wǎng)絡(luò)攔截器

要做計算 Request 的 sigunature ，則使用方式如下：

public class ApiClient {
 Interceptor signedRequestInterceptor = new Interceptor() {
  @Override
  public Response intercept(Chain chain) throws IOException {
   Response response = null;
   try {
    Request originalRequest = chain.request();
    Request signedRequest = SignRequestUtil.signRequest(originalRequest);
    response = chain.proceed(signedRequest);
   } catch (NoSuchAlgorithmException | InvalidKeyException e) {
     e.printStackTrace();
   }

   return response;
  }
 };

 OkHttpClient client = new OkHttpClient();
 client.networkInterceptors().add(signedRequestInterceptor);
}
public class SignRequestUtil {
 public static Request signRequest(Request originalRequest) {
  Request.Builder requestBuilder = originalRequest.newBuilder();

  // 在這做所有你需要做的事情，重新產(chǎn)生一個 Request 送出去。
  return requestBuilder
   .headers(getSignedHeaders(originalRequest))
   .build();
 }
}

您可能感興趣的文章: