OkHttpClient源碼分析(二) —— RetryAndFollowUpInterceptor和BridgeInterceptor

OkHttp攔截器

??攔截器是OkHttp中提供的一種強大機制,它可以實現網絡監聽、請求以及響應重寫、請求失敗重試等功能。

image

如上圖所示,這就OkHttp內部提供給我們的攔截器,就是當我們發起一個http請求的時候,OkHttp就會通過這個攔截器鏈來執行http請求。其中包括:

  • RetryAndFollowUpInterceptor 重試和重定向攔截器
  • BridgeInterceptor :橋接和適配攔截器
  • CacheInterceptor :緩存攔截器
  • ConnectInterceptor :鏈接攔截器
  • CallServerInterceptor :請求和處理響應攔截器

BridgeInterceptorCacheInterceptor 主要是用來補充用戶請求創建當中缺少的一些必需的http請求頭和處理緩存的功能。

ConnectInterceptor 主要是負責建立可用的鏈接,CallServerInterceptor 主要是負責將http請求寫進網絡的IO流當中,并且從網絡IO流當中讀取服務端返回給客戶端的數據。

源碼分析

getResponseWithInterceptorChain()

上篇文章 OkHttpClient源碼分析(一)——同步、異步請求的執行流程和源碼分析 有提及到一個很重要的方法getResponseWithInterceptorChain(),同步請求的話,是在RealCall類中的excute()方法中調用到該方法,而異步請求是在RealCall的內部類AsyncCal中的excute()方法中調用,查看該方法的源碼:

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);
}

一、方法里初始化了一個Interceptor的集合,添加了OkHttpClient中配置的攔截器集合,然后依次添加了上述提及到的那五個攔截器;

二、創建一個攔截器鏈RealInterceptorChain,并執行攔截器鏈的proceed()方法;

查看RealInterceptorChain類的proceed()方法:

 public Response proceed(Request request, StreamAllocation streamAllocation, HttpStream httpStream,
      Connection connection) throws IOException {
      
      ...
      
      // Call the next interceptor in the chain.
    RealInterceptorChain next = new RealInterceptorChain(
        interceptors, streamAllocation, httpStream, connection, index + 1, request);
    Interceptor interceptor = interceptors.get(index);
    Response response = interceptor.intercept(next);
    
    ...
 }

其中,核心的代碼就在這里,這里再次創建了RealInterceptorChain對象,此時創建的是下一個攔截器鏈,傳入的是index + 1,并通過調用當前Interceptor的intercept()方法,將下一個攔截器鏈傳入,得到Response對象,至于攔截器的intercept()方法,下面將會分析。

RetryAndFollowUpInterceptor

主要作用是負責網絡請求失敗重連,需要注意的是,并不是所有的網絡請求失敗以后都可以進行重連,它是有一定的限制范圍的,OkHttp內部會幫我們檢測網絡異常和響應碼的判斷,如果都在它的限制范圍內的話,就會進行網絡重連。

源碼主要看intercept()方法:

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

    streamAllocation = new StreamAllocation(
        client.connectionPool(), createAddress(request.url()));

    int followUpCount = 0;
    Response priorResponse = null;
    ...
}

這里創建了一個StreamAllocation對象,StreamAllocation對象是用來建立執行Http請求所需要的網絡組件的,從它名字可以看出,它是用來分配stream的,主要是用于獲取連接服務端的connection和用于與服務端進行數據傳輸的輸入輸出流 。

詳細的邏輯都在intercept()方法中的while循環中,這里不做詳細介紹,主要是介紹其中的這個:

 while (true) {
    ...
    
    try {
        response = ((RealInterceptorChain) chain).proceed(request, streamAllocation, null, null);
        releaseConnection = false;
      }
      
      ...
    
    if (++followUpCount > MAX_FOLLOW_UPS) {
        streamAllocation.release();
        throw new ProtocolException("Too many follow-up requests: " + followUpCount);
    }
    
    ...
 }

這里我們可以發現,RealInterceptorChain調用proceed()方法,方法里又創建了一個RealInterceptorChain對象(下一個攔截器鏈 index + 1),然后通過index獲取到當前執行到的攔截器,調用攔截器的intercept()方法,這里intercept()方法中,再次調用了RealInterceptorChain的proceed()方法,形成了遞歸。

以上代碼是對重試的次數進行判斷,由此可知,并不是無限次的進行網絡重試,而是有一定的重試次數的,MAX_FOLLOW_UPS 是一個常量,值為20,也就是說最多進行20次重試,如果還不成功的話,就會釋放StreamAllocation對象和拋出ProtocolException異常。

總結:

  1. 創建StreamAllocation對象
  2. 調用RealInterceptorChain.proceed()進行網絡請求
  3. 根據異常結果或響應結果判斷是否要進行重新請求
  4. 調用下一個攔截器,對response進行處理,返回給上一個攔截器

BridgeInterceptor

同樣也是看核心方法intercept():

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

    ...

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

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

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

    ...

    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();
  }

這里并沒有貼上整個方法的代碼,省略了部分,主要的操作就是為發起的Request請求添加請求頭信息,其中同樣也調用了proceed()方法遞歸調用下個攔截器,最后面是針對經過gzip壓縮過的Response進行解壓處理,這里通過判斷是否支持gzip壓縮且請求頭里面的"Content-Encoding"的value是否是"gzip"來判斷是否需要進行gzip解壓。

總結:

  1. 負責將用戶構建的Request請求轉化為能夠進行網絡訪問的請求;
  2. 將這個符合網絡請求的Request進行網絡請求;
  3. 將網絡請求回來的的相應Response轉化為用戶可用的Response

下一篇將為大家介紹OkHttp的緩存機制,感興趣的朋友可以繼續閱讀:

OkHttpClient源碼分析(三)—— 緩存機制介紹

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,923評論 6 535
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,740評論 3 420
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,856評論 0 380
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,175評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,931評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,321評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,383評論 3 443
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,533評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,082評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,891評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,067評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,618評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,319評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,732評論 0 27
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,987評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,794評論 3 394
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,076評論 2 375

推薦閱讀更多精彩內容