【Android】OkHttp系列(三)：橋接攔截器BridgeInterceptor

該系列OkHttp源碼分析基於OkHttp3.14.0版本

概述

官方的英文註釋是這樣寫的：`

Bridges from application code to network code. First it builds a network request from a user request. Then it proceeds to call the network. Finally it builds a user response from the network response.

撇腳翻譯：

應用程序代碼和網絡代碼之間轉換的橋樑。首先，它根據一個用戶請求構建一個網絡請求。然後用網絡請求向服務器發起。最後再將網絡響應轉換爲用戶響應。

同樣，對於攔截器我們優先關注它的intercept()方法。整體來看，該攔截器主要就是添加了一些header，如：Content-Type、Content-Length、Host、Connection、Accept-Encoding、Cookie、User-Agent等。對於服務器的響應，如果開啓了gzip壓縮的話(默認是開啓的，除非手動設置了)，也會進行解壓縮。

這個攔截器的邏輯比較簡單，因此我就直接貼代碼寫註釋了。

源碼分析

UserRequest轉換爲NetworkRequest

@Override public Response intercept(Chain chain) throws IOException {
  Request userRequest = chain.request();
  Request.Builder requestBuilder = userRequest.newBuilder();

  //構造一個新的Request，添加了一些header
  RequestBody body = userRequest.body();
  if (body != null) {
    MediaType contentType = body.contentType();
    if (contentType != null) {
      requestBuilder.header("Content-Type", contentType.toString());
    }

    long contentLength = body.contentLength();
    if (contentLength != -1) {
      requestBuilder.header("Content-Length", Long.toString(contentLength));
      requestBuilder.removeHeader("Transfer-Encoding");
    } else {
      requestBuilder.header("Transfer-Encoding", "chunked");
      requestBuilder.removeHeader("Content-Length");
    }
  }

  if (userRequest.header("Host") == null) {
    requestBuilder.header("Host", hostHeader(userRequest.url(), false));
  }

  if (userRequest.header("Connection") == null) {
    requestBuilder.header("Connection", "Keep-Alive");
  }

  // If we add an "Accept-Encoding: gzip" header field we're responsible for also decompressing
  // the transfer stream.
  // 如果我們添加“ Accept-Encoding：gzip”標頭字段，則我們還要負責解壓縮傳輸流。
  boolean transparentGzip = false;
  if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
    transparentGzip = true;
    requestBuilder.header("Accept-Encoding", "gzip");
  }

  // 這裏可以看到，每次請求的時候會從cookieJar中根據url獲取cookie
  // 並且會將所有cookie都添加到Request中
  List<Cookie> cookies = cookieJar.loadForRequest(userRequest.url());
  if (!cookies.isEmpty()) {
    requestBuilder.header("Cookie", cookieHeader(cookies));
  }

  if (userRequest.header("User-Agent") == null) {
    requestBuilder.header("User-Agent", Version.userAgent());
  }
    ...省略部分響應轉換代碼

  return responseBuilder.build();
}

通過源碼可以看到，該攔截器只是負責添加了一些請求頭而已，並沒有對請求進行多少改動，尤其是gzip這個請求頭，並沒有在這裏進行壓縮，猜測應該是在最後和服務器進行交互的地方纔壓縮。

NetworkResponse轉換爲UserResponse

@Override public Response intercept(Chain chain) throws IOException {
  Request userRequest = chain.request();
  Request.Builder requestBuilder = userRequest.newBuilder();
  
  ...省略部分構建NetworkRequset的代碼
  
  //用新構建的Request去請求，獲取到的是網絡響應
  Response networkResponse = chain.proceed(requestBuilder.build());

  //如果響應頭中包含了cookie，則會調用cookieJar.saveFromResponse()
  HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers());

  // 構建用戶響應
  Response.Builder responseBuilder = networkResponse.newBuilder()
      .request(userRequest);

  if (transparentGzip
      && "gzip".equalsIgnoreCase(networkResponse.header("Content-Encoding"))
      && HttpHeaders.hasBody(networkResponse)) {
    // gzip解壓
    GzipSource responseBody = new GzipSource(networkResponse.body().source());
    Headers strippedHeaders = networkResponse.headers().newBuilder()
        .removeAll("Content-Encoding")
        .removeAll("Content-Length")
        .build();
    responseBuilder.headers(strippedHeaders);
    String contentType = networkResponse.header("Content-Type");
    responseBuilder.body(new RealResponseBody(contentType, -1L, Okio.buffer(responseBody)));
  }

  return responseBuilder.build();
}

可以看到，對於返回的響應，該攔截器的主要操作就是進行gzip解壓，使用到了Okio。