Okhttp之BridgeInterceptor攔截器解析

如果研究過(guò)okhttp源碼,應(yīng)該知道okhttp的核心是攔截器,而攔截器所采用的設(shè)計(jì)模式是責(zé)任鏈設(shè)計(jì),即每個(gè)攔截器只處理與自己相關(guān)的業(yè)務(wù)邏輯。

之前已經(jīng)分析了Okhttp的RetryAndFollowUpInterceptor的原理

攔截器的核心代碼都在intercept(Chain chain )方法中,所以有必要徹底研究該方法是如何處理即可理解BridgeInterceptor的作用和實(shí)現(xiàn)。

1、okhttp中RealCall中請(qǐng)求網(wǎng)絡(luò)及添加攔截器的核心代碼

如下是okhttp中RealCall.java文件中的將一個(gè)request請(qǐng)求,得到response的核心代碼,getResponseWithInterceptorChain(),即一進(jìn)方法就添加了好幾個(gè)攔截器。

  Response getResponseWithInterceptorChain() throws IOException {
    // Build a full stack of interceptors.
    List<Interceptor> interceptors = new ArrayList<>();
    interceptors.addAll(client.interceptors());
    interceptors.add(retryAndFollowUpInterceptor);
    interceptors.add(new BridgeInterceptor(client.cookieJar()));
    interceptors.add(new CacheInterceptor(client.internalCache()));
    interceptors.add(new ConnectInterceptor(client));
    if (!forWebSocket) {
      interceptors.addAll(client.networkInterceptors());
    }
    interceptors.add(new CallServerInterceptor(forWebSocket));

    Interceptor.Chain chain = new RealInterceptorChain(interceptors, null, null, null, 0,
        originalRequest, this, eventListener, client.connectTimeoutMillis(),
        client.readTimeoutMillis(), client.writeTimeoutMillis());

    return chain.proceed(originalRequest);
  }

2、 開(kāi)始分析之前,先來(lái)了解一下正常的一次網(wǎng)絡(luò)請(qǐng)求過(guò)程

一次Http請(qǐng)求必須要攜帶一些特定的Header信息,例如:以請(qǐng)求百度主頁(yè)為例,Request中攜帶的信息如下:


request.png

額,貌似有點(diǎn)看不清,看下圖,是不是高清無(wú)碼


request頭信息.png

標(biāo)紅的這些字段,即Header信息必要字段,水了這么多,就是為了說(shuō)明白,一次http網(wǎng)絡(luò)請(qǐng)求并不是只需要設(shè)置一個(gè)地址就可以,而是要封裝一個(gè)特定的格式和必要的參數(shù)(即Header信息)。

3、BridgeInterceptor的核心偽代碼

有了上面的這思想,看BridgeInterceptor的核心偽代碼,是不是恍然大悟了!(具體方法作用都表明了注釋)

public final class BridgeInterceptor implements Interceptor {
  private final CookieJar cookieJar;

  public BridgeInterceptor(CookieJar cookieJar) {
    this.cookieJar = cookieJar;
  }

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

    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) {
        //添加Content-Length頭信息
        requestBuilder.header("Content-Length", Long.toString(contentLength));
        requestBuilder.removeHeader("Transfer-Encoding");
      } else {
        requestBuilder.header("Transfer-Encoding", "chunked");
        requestBuilder.removeHeader("Content-Length");
      }
    }
    //添加Host信息
    if (userRequest.header("Host") == null) {
      requestBuilder.header("Host", hostHeader(userRequest.url(), false));
    }

    //添加Connection信息
    if (userRequest.header("Connection") == null) {
      requestBuilder.header("Connection", "Keep-Alive");
    }

    //添加 Accept-Encoding信息
    boolean transparentGzip = false;
    if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
      transparentGzip = true;
      requestBuilder.header("Accept-Encoding", "gzip");
    }

    List<Cookie> cookies = cookieJar.loadForRequest(userRequest.url());
    //添加Cookie頭信息
    if (!cookies.isEmpty()) {
      requestBuilder.header("Cookie", cookieHeader(cookies));
    }

     //添加User-Agent信息
    if (userRequest.header("User-Agent") == null) {
      requestBuilder.header("User-Agent", Version.userAgent());
    }

    Response networkResponse = chain.proceed(requestBuilder.build());

    HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers());

    Response.Builder responseBuilder = networkResponse.newBuilder()
        .request(userRequest);
    //如果服務(wù)器返回的response是壓縮過(guò)的,即獲取GzipSource輸入流,讀取返回的數(shù)據(jù)
    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);
      String contentType = networkResponse.header("Content-Type");
      responseBuilder.body(new RealResponseBody(contentType, -1L, Okio.buffer(responseBody)));
    }

    return responseBuilder.build();
  }

//返回并封裝為key=value 形式的cookie信息
  private String cookieHeader(List<Cookie> cookies) {
    StringBuilder cookieHeader = new StringBuilder();
    for (int i = 0, size = cookies.size(); i < size; i++) {
      if (i > 0) {
        cookieHeader.append("; ");
      }
      Cookie cookie = cookies.get(i);
      cookieHeader.append(cookie.name()).append('=').append(cookie.value());
    }
    return cookieHeader.toString();
  }
}

3.1 方法注釋已添加到method上

即獲取到用戶創(chuàng)建request對(duì)象,然后在該基礎(chǔ)上添加http請(qǐng)求必要的頭信息。如果返回的response信息是壓縮后的,在通過(guò)okio壓縮輸入流處理response。

3.2 再來(lái)看看構(gòu)造方法中傳入的CookieJar

public BridgeInterceptor(CookieJar cookieJar) 

構(gòu)造中穿傳入的CookieJar,會(huì)通過(guò)cookieHeader()方法,封裝為key=value的形式,添加到Header信息中的cookie字段中。

4、總結(jié)一下BridgeInterceptor的作用:

4.1 封裝request頭信息
4.2 處理cookie信息
4.3 處理服務(wù)器壓縮后的response
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容