OKhttp源碼學習(五)—— BridgeInterceptor

BridgeInterceptor攔截器分析

源碼地址:https://github.com/square/okhttp

作爲內置的第二個攔截器,這個攔截器在RetryAndFollowUpInterceptor之後又做了些什麼呢?

1. 整體結構:

和第一個攔截器對比,整體結構簡單多了。

一個構造方法,一個攔截方法,一個處理cookieHeader的方法。

整體結構

2. 主要功能

  1. 在請求前對Header進行處理,如果用戶有設置就直接使用,如果沒有設置就使用默認的。
  2. 通過Chain調用下一個攔截器。
  3. 對與返回的結果,進行Gzip, Header, 以及cookie的處理。

3. 源碼分析

intercept 方法

其實前面提到的主要功能就是在這個intercept 方法中體現,

下面在代碼中注析了對應的功能

  @Override public Response intercept(Chain chain) throws IOException {
    Request userRequest = chain.request();
    Request.Builder requestBuilder = userRequest.newBuilder();
    
    //下面一大段代碼都是處理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");
    }

    //如果我們不自定義編解碼方式的方式,這裏添加了Gzip的編解碼
    // If we add an "Accept-Encoding: gzip" header field we're responsible for also decompressing
    // the transfer stream.
    boolean transparentGzip = false;
    if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
      transparentGzip = true;
      requestBuilder.header("Accept-Encoding", "gzip");
    }

    //在創建ohHttpClient的時候,添加的cookiejar, 這裏會對其進行寫入。
    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());
    }
   
   //以上是請求前的,前期頭的處理
   //通過chain,調用下一個攔截器,並得到結果
    Response networkResponse = chain.proceed(requestBuilder.build());

    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)) {
      GzipSource responseBody = new GzipSource(networkResponse.body().source());
      Headers strippedHeaders = networkResponse.headers().newBuilder()
          .removeAll("Content-Encoding")
          .removeAll("Content-Length")
          .build();
      responseBuilder.headers(strippedHeaders);
      responseBuilder.body(new RealResponseBody(strippedHeaders, Okio.buffer(responseBody)));
    }

    return responseBuilder.build();
  }

cookie處理

   //從前面okHttpClient 中設置的cookieJar,然後設置到請求頭的Cookie中去。
    List<Cookie> cookies = cookieJar.loadForRequest(userRequest.url());
    if (!cookies.isEmpty()) {
      requestBuilder.header("Cookie", cookieHeader(cookies));
    }
     略
    Response networkResponse = chain.proceed(requestBuilder.build());
    //收到結果之後,是否保存cookie
    HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers());

這裏涉及到CookieJar,對cookie的處理。其中loadForRequest 就是獲取cookie,而saveFromResponse 就是把cookie保存下來,這個都是我們自定義的,在okHttpClient創建的時候,可以進行對應的定製,保存在哪裏,從哪裏獲取。

Gzip

okHttp3 默認使用Gzip,不過是使用okio進行處理的。

最後會把前面的頭處理新建一個response的body,進行返回。

4. 總結

這個攔截器其實是比較簡單的,主要處理請求頭,Gzip,以及cookie的處理。

系列(簡書地址):
OKhttp源碼學習(一)—— 基本請求流程
OKhttp源碼學習(二)—— OkHttpClient
OKhttp源碼學習(三)—— Request, RealCall
OKhttp源碼學習(四)——RetryAndFollowUpInterceptor攔截器
OKhttp源碼學習(六)—— CacheInterceptor攔截器
OKhttp源碼學習(七)—— ConnectInterceptor攔截器
OKhttp源碼學習(八)——CallServerInterceptor攔截器
OKhttp源碼學習(九)—— 任務管理(Dispatcher)

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章