【Android】OkHttp系列(三)：桥接拦截器BridgeInterceptor

该系列OkHttp源码分析基于OkHttp3.14.0版本

概述

官方的英文注释是这样写的：`

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.

撇脚翻译：

应用程序代码和网络代码之间转换的桥梁。首先，它根据一个用户请求构建一个网络请求。然后用网络请求向服务器发起。最后再将网络响应转换为用户响应。

同样，对于拦截器我们优先关注它的intercept()方法。整体来看，该拦截器主要就是添加了一些header，如：Content-Type、Content-Length、Host、Connection、Accept-Encoding、Cookie、User-Agent等。对于服务器的响应，如果开启了gzip压缩的话(默认是开启的，除非手动设置了)，也会进行解压缩。

这个拦截器的逻辑比较简单，因此我就直接贴代码写注释了。

源码分析

UserRequest转换为NetworkRequest

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

  //构造一个新的Request，添加了一些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");
  }

  // If we add an "Accept-Encoding: gzip" header field we're responsible for also decompressing
  // the transfer stream.
  // 如果我们添加“ Accept-Encoding：gzip”标头字段，则我们还要负责解压缩传输流。
  boolean transparentGzip = false;
  if (userRequest.header("Accept-Encoding") == null && userRequest.header("Range") == null) {
    transparentGzip = true;
    requestBuilder.header("Accept-Encoding", "gzip");
  }

  // 这里可以看到，每次请求的时候会从cookieJar中根据url获取cookie
  // 并且会将所有cookie都添加到Request中
  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());
  }
    ...省略部分响应转换代码

  return responseBuilder.build();
}

通过源码可以看到，该拦截器只是负责添加了一些请求头而已，并没有对请求进行多少改动，尤其是gzip这个请求头，并没有在这里进行压缩，猜测应该是在最后和服务器进行交互的地方才压缩。

NetworkResponse转换为UserResponse

@Override public Response intercept(Chain chain) throws IOException {
  Request userRequest = chain.request();
  Request.Builder requestBuilder = userRequest.newBuilder();
  
  ...省略部分构建NetworkRequset的代码
  
  //用新构建的Request去请求，获取到的是网络响应
  Response networkResponse = chain.proceed(requestBuilder.build());

  //如果响应头中包含了cookie，则会调用cookieJar.saveFromResponse()
  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)) {
    // gzip解压
    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();
}

可以看到，对于返回的响应，该拦截器的主要操作就是进行gzip解压，使用到了Okio。