简介

okhttp的网络请求采用interceptors链的模式。每一级interceptor只处理自己的工作，然后将剩余的工作，交给下一级interceptor。本文将主要阅读okhttp中的BridgeInterceptor，了解它的作用和工作原理。

BridgeInterceptor

BridgeInterceptor从名字上很难看出它的含义。其实，它是一个处理请求与返回的拦截器，它会对请求的Header进行一些处理，然后将工作交到下一级Interceptor，下一级完成后，再对返回进行处理。

  1. /**
  2.  * Bridges from application code to network code. First it builds a network request from a user
  3.  * request. Then it proceeds to call the network. Finally it builds a user response from the network
  4.  * response.
  5.  */
  6. class BridgeInterceptor(private val cookieJar: CookieJar) : Interceptor {
  7.   ...
  8. }

从注释中我们也可以看出，BridgeInterceptor的实现主要分两部分：请求的处理和返回的处理。

Request

  1. override fun intercept(chain: Interceptor.Chain): Response {
  2.     val userRequest = chain.request()
  3.     val requestBuilder = userRequest.newBuilder()
  5.     val body = userRequest.body()
  6.     if (body != null) {
  7.       val contentType = body.contentType()
  8.       if (contentType != null) {
  9.         requestBuilder.header("Content-Type", contentType.toString())
  10.       }
  12.       val contentLength = body.contentLength()
  13.       if (contentLength != -1L) {
  14.         requestBuilder.header("Content-Length", contentLength.toString())
  15.         requestBuilder.removeHeader("Transfer-Encoding")
  16.       } else {
  17.         requestBuilder.header("Transfer-Encoding", "chunked")
  18.         requestBuilder.removeHeader("Content-Length")
  19.       }
  20.     }
  22.     if (userRequest.header("Host") == null) {
  23.       requestBuilder.header("Host", hostHeader(userRequest.url(), false))
  24.     }
  26.     if (userRequest.header("Connection") == null) {
  27.       requestBuilder.header("Connection", "Keep-Alive")
  28.     }
  30.     // If we add an "Accept-Encoding: gzip" header field we're responsible for also decompressing
  31.     // the transfer stream.
  32.     var transparentGzip = false
  33.     if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
  34.       transparentGzip = true
  35.       requestBuilder.header("Accept-Encoding", "gzip")
  36.     }
  38.     val cookies = cookieJar.loadForRequest(userRequest.url())
  39.     if (cookies.isNotEmpty()) {
  40.       requestBuilder.header("Cookie", cookieHeader(cookies))
  41.     }
  43.     if (userRequest.header("User-Agent") == null) {
  44.       requestBuilder.header("User-Agent", userAgent)
  45.     }
  46.     ...
  47. }

这一部分，主要是对Request的Headers进行处理。如果调用者，有自行设置相关的Header，则直接从userRequest的body中获取，然后设置到requestBuilder中。这里有几处参数的处理值得注意。

contentLength

  1. val contentLength = body.contentLength()
  2.       if (contentLength != -1L) {
  3.         requestBuilder.header("Content-Length", contentLength.toString())
  4.         requestBuilder.removeHeader("Transfer-Encoding")
  5.       } else {
  6.         requestBuilder.header("Transfer-Encoding", "chunked")
  7.         requestBuilder.removeHeader("Content-Length")
  8.       }

获取body的内容长度。如果内容长度不为-1，则设置长度，并去除”Transfer-Encoding”。如果内容长度为-1，则是chunked模式，去掉”Content-Length”。

gzip

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

如果用户没有指定Accept-Encoding，且请求没有带Range字段时，可以自动转换为gzip。

Response

完成了Request后，我们会委托给下层进行实现，然后将networkResponse返回给我们。Response中，主要是需要对transparentGzip进行判断。如果是gzip模式，则需要进行一些处理。

  1. ...
  2.     val networkResponse = chain.proceed(requestBuilder.build())
  4.     HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers())
  6.     val responseBuilder = networkResponse.newBuilder()
  7.         .request(userRequest)
  9.     if (transparentGzip &&
  10.         "gzip".equals(networkResponse.header("Content-Encoding"), ignoreCase = true) &&
  11.         HttpHeaders.hasBody(networkResponse)) {
  12.       val responseBody = networkResponse.body()
  13.       if (responseBody != null) {
  14.         val gzipSource = GzipSource(responseBody.source())
  15.         val strippedHeaders = networkResponse.headers().newBuilder()
  16.             .removeAll("Content-Encoding")
  17.             .removeAll("Content-Length")
  18.             .build()
  19.         responseBuilder.headers(strippedHeaders)
  20.         val contentType = networkResponse.header("Content-Type")
  21.         responseBuilder.body(RealResponseBody(contentType, -1L, gzipSource.buffer()))
  22.       }
  23.     }
  25.     return responseBuilder.build()
  26.   }

如果Response是gzip模式且transparentGzip为true且HttpHeaders.hasBody为true时，会去掉Headers中的”Content-Encoding”和”Content-Length”。

这个地方值得深究一下。

transparentGzip为true的条件是:

  1. var transparentGzip = false
  2.     if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
  3.       transparentGzip = true
  4.       requestBuilder.header("Accept-Encoding", "gzip")
  5.     }
  1. /** Returns true if the response must have a (possibly 0-length) body. See RFC 7231. */
  2.   public static boolean hasBody(Response response) {
  3.     // HEAD requests never yield a body regardless of the response headers.
  4.     if (response.request().method().equals("HEAD")) {
  5.       return false;
  6.     }
  8.     int responseCode = response.code();
  9.     if ((responseCode < HTTP_CONTINUE || responseCode >= 200)
  10.         && responseCode != HTTP_NO_CONTENT
  11.         && responseCode != HTTP_NOT_MODIFIED) {
  12.       return true;
  13.     }
  15.     // If the Content-Length or Transfer-Encoding headers disagree with the response code, the
  16.     // response is malformed. For best compatibility, we honor the headers.
  17.     if (contentLength(response) != -1
  18.         || "chunked".equalsIgnoreCase(response.header("Transfer-Encoding"))) {
  19.       return true;
  20.     }
  22.     return false;
  23.   }

所以，okhttp会去掉Headers中的”Content-Encoding”和”Content-Length”的条件是：

  • 用户未设置Request的”Accept-Encoding”
  • 用户未设置Request的”Range”
  • Response中”Content-Encoding”为gzip

当用户未设置Accep-Encoding时，用户期望的Content-Length是返回的内容长度。但由于okhttp在用户未设置Accep-Encoding时，会进行gzip的转换。

当HTTP使用gzip方式时，Content-Length的返回是根据gzip压缩后的长度进行返回的。此时Content-Length的值与用户所期望的不符的。因为用户并没有主动使用gzip模式。

所以，此时okhttp选择将Content-Length remove掉，以免让调用者产生误解。

不得不说okhttp在此处的处理略显粗暴，但也不是完全不能理解。
Issue中也有相关的讨论

okhttp——BridgeInterceptor - 图1

总结

okhttp的BridgeInterceptor处理了HTTP的请求中对于请求Header和返回Header。对于HTTP模式的各种匹配做了相应的适配和容错。

如有问题，欢迎指正。