okhttp——BridgeInterceptor

簡(jiǎn)介

okhttp的網(wǎng)絡(luò)請(qǐng)求采用interceptors鏈的模式聚霜。每一級(jí)interceptor只處理自己的工作爵卒,然后將剩余的工作蛤高,交給下一級(jí)interceptor贾费。本文將主要閱讀okhttp中的BridgeInterceptor古毛,了解它的作用和工作原理翻翩。

BridgeInterceptor

BridgeInterceptor從名字上很難看出它的含義。其實(shí)稻薇,它是一個(gè)處理請(qǐng)求返回的攔截器嫂冻,它會(huì)對(duì)請(qǐng)求的Header進(jìn)行一些處理,然后將工作交到下一級(jí)Interceptor塞椎,下一級(jí)完成后桨仿,再對(duì)返回進(jìn)行處理。

/**
 * 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.
 */
class BridgeInterceptor(private val cookieJar: CookieJar) : Interceptor {
  ...
}

從注釋中我們也可以看出忱屑,BridgeInterceptor的實(shí)現(xiàn)主要分兩部分:請(qǐng)求的處理返回的處理蹬敲。

Request

  override fun intercept(chain: Interceptor.Chain): Response {
    val userRequest = chain.request()
    val requestBuilder = userRequest.newBuilder()

    val body = userRequest.body()
    if (body != null) {
      val contentType = body.contentType()
      if (contentType != null) {
        requestBuilder.header("Content-Type", contentType.toString())
      }

      val contentLength = body.contentLength()
      if (contentLength != -1L) {
        requestBuilder.header("Content-Length", contentLength.toString())
        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.
    var transparentGzip = false
    if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
      transparentGzip = true
      requestBuilder.header("Accept-Encoding", "gzip")
    }

    val cookies = cookieJar.loadForRequest(userRequest.url())
    if (cookies.isNotEmpty()) {
      requestBuilder.header("Cookie", cookieHeader(cookies))
    }

    if (userRequest.header("User-Agent") == null) {
      requestBuilder.header("User-Agent", userAgent)
    }
    ...
}

這一部分,主要是對(duì)Request的Headers進(jìn)行處理莺戒。如果調(diào)用者伴嗡,有自行設(shè)置相關(guān)的Header,則直接從userRequestbody中獲取从铲,然后設(shè)置到requestBuilder中瘪校。這里有幾處參數(shù)的處理值得注意。

contentLength

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

獲取body的內(nèi)容長(zhǎng)度名段。如果內(nèi)容長(zhǎng)度不為-1阱扬,則設(shè)置長(zhǎng)度,并去除"Transfer-Encoding"伸辟。如果內(nèi)容長(zhǎng)度為-1麻惶,則是chunked模式,去掉"Content-Length"信夫。

gzip

    // If we add an "Accept-Encoding: gzip" header field we're responsible for also decompressing
    // the transfer stream.
    var transparentGzip = false
    if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
      transparentGzip = true
      requestBuilder.header("Accept-Encoding", "gzip")
    }

如果用戶沒(méi)有指定Accept-Encoding窃蹋,且請(qǐng)求沒(méi)有帶Range字段時(shí),可以自動(dòng)轉(zhuǎn)換為gzip静稻。

Response

完成了Request后警没,我們會(huì)委托給下層進(jìn)行實(shí)現(xiàn),然后將networkResponse返回給我們振湾。Response中杀迹,主要是需要對(duì)transparentGzip進(jìn)行判斷。如果是gzip模式押搪,則需要進(jìn)行一些處理树酪。

    ...
    val networkResponse = chain.proceed(requestBuilder.build())

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

    val responseBuilder = networkResponse.newBuilder()
        .request(userRequest)

    if (transparentGzip &&
        "gzip".equals(networkResponse.header("Content-Encoding"), ignoreCase = true) &&
        HttpHeaders.hasBody(networkResponse)) {
      val responseBody = networkResponse.body()
      if (responseBody != null) {
        val gzipSource = GzipSource(responseBody.source())
        val strippedHeaders = networkResponse.headers().newBuilder()
            .removeAll("Content-Encoding")
            .removeAll("Content-Length")
            .build()
        responseBuilder.headers(strippedHeaders)
        val contentType = networkResponse.header("Content-Type")
        responseBuilder.body(RealResponseBody(contentType, -1L, gzipSource.buffer()))
      }
    }

    return responseBuilder.build()
  }

如果Response是gzip模式且transparentGzip為true且HttpHeaders.hasBody為true時(shí)浅碾,會(huì)去掉Headers中的"Content-Encoding"和"Content-Length"。

這個(gè)地方值得深究一下嗅回。

transparentGzip為true的條件是:

    var transparentGzip = false
    if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
      transparentGzip = true
      requestBuilder.header("Accept-Encoding", "gzip")
    }
  /** Returns true if the response must have a (possibly 0-length) body. See RFC 7231. */
  public static boolean hasBody(Response response) {
    // HEAD requests never yield a body regardless of the response headers.
    if (response.request().method().equals("HEAD")) {
      return false;
    }

    int responseCode = response.code();
    if ((responseCode < HTTP_CONTINUE || responseCode >= 200)
        && responseCode != HTTP_NO_CONTENT
        && responseCode != HTTP_NOT_MODIFIED) {
      return true;
    }

    // If the Content-Length or Transfer-Encoding headers disagree with the response code, the
    // response is malformed. For best compatibility, we honor the headers.
    if (contentLength(response) != -1
        || "chunked".equalsIgnoreCase(response.header("Transfer-Encoding"))) {
      return true;
    }

    return false;
  }

所以及穗,okhttp會(huì)去掉Headers中的"Content-Encoding"和"Content-Length"的條件是:

  • 用戶未設(shè)置Request的"Accept-Encoding"
  • 用戶未設(shè)置Request的"Range"
  • Response中"Content-Encoding"為gzip

當(dāng)用戶未設(shè)置Accep-Encoding時(shí),用戶期望的Content-Length是返回的內(nèi)容長(zhǎng)度绵载。但由于okhttp在用戶未設(shè)置Accep-Encoding時(shí)埂陆,會(huì)進(jìn)行g(shù)zip的轉(zhuǎn)換。

當(dāng)HTTP使用gzip方式時(shí)娃豹,Content-Length的返回是根據(jù)gzip壓縮后的長(zhǎng)度進(jìn)行返回的焚虱。此時(shí)Content-Length的值與用戶所期望的不符的。因?yàn)橛脩舨](méi)有主動(dòng)使用gzip模式懂版。

所以鹃栽,此時(shí)okhttp選擇將Content-Length remove掉,以免讓調(diào)用者產(chǎn)生誤解躯畴。

不得不說(shuō)okhttp在此處的處理略顯粗暴民鼓,但也不是完全不能理解。
Issue中也有相關(guān)的討論

issue

總結(jié)

okhttpBridgeInterceptor處理了HTTP的請(qǐng)求中對(duì)于請(qǐng)求Header和返回Header蓬抄。對(duì)于HTTP模式的各種匹配做了相應(yīng)的適配和容錯(cuò)丰嘉。

如有問(wèn)題,歡迎指正嚷缭。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末饮亏,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子阅爽,更是在濱河造成了極大的恐慌路幸,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,372評(píng)論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件付翁,死亡現(xiàn)場(chǎng)離奇詭異简肴,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)百侧,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門着帽,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人移层,你說(shuō)我怎么就攤上這事『罩啵” “怎么了观话?”我有些...
    開(kāi)封第一講書人閱讀 162,415評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)越平。 經(jīng)常有香客問(wèn)我频蛔,道長(zhǎng)灵迫,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書人閱讀 58,157評(píng)論 1 292
  • 正文 為了忘掉前任晦溪,我火速辦了婚禮瀑粥,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘三圆。我一直安慰自己狞换,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,171評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布舟肉。 她就那樣靜靜地躺著修噪,像睡著了一般。 火紅的嫁衣襯著肌膚如雪路媚。 梳的紋絲不亂的頭發(fā)上黄琼,一...
    開(kāi)封第一講書人閱讀 51,125評(píng)論 1 297
  • 那天,我揣著相機(jī)與錄音整慎,去河邊找鬼脏款。 笑死,一個(gè)胖子當(dāng)著我的面吹牛裤园,可吹牛的內(nèi)容都是我干的撤师。 我是一名探鬼主播,決...
    沈念sama閱讀 40,028評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼比然,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼丈氓!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起强法,我...
    開(kāi)封第一講書人閱讀 38,887評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤万俗,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后饮怯,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體闰歪,經(jīng)...
    沈念sama閱讀 45,310評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,533評(píng)論 2 332
  • 正文 我和宋清朗相戀三年蓖墅,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了库倘。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,690評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡论矾,死狀恐怖教翩,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情贪壳,我是刑警寧澤饱亿,帶...
    沈念sama閱讀 35,411評(píng)論 5 343
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響彪笼,放射性物質(zhì)發(fā)生泄漏钻注。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,004評(píng)論 3 325
  • 文/蒙蒙 一配猫、第九天 我趴在偏房一處隱蔽的房頂上張望幅恋。 院中可真熱鬧,春花似錦泵肄、人聲如沸捆交。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)零渐。三九已至,卻和暖如春系忙,著一層夾襖步出監(jiān)牢的瞬間诵盼,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 32,812評(píng)論 1 268
  • 我被黑心中介騙來(lái)泰國(guó)打工银还, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留风宁,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,693評(píng)論 2 368
  • 正文 我出身青樓蛹疯,卻偏偏與公主長(zhǎng)得像戒财,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子捺弦,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,577評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容