OkHttp源码阅读(五) —— 拦截器之BridgeInter

2021-04-12  本文已影响0人  Sherlock丶Aza

   BridgeInterceptor是OkHttp内置拦截器的第二层拦截器，从字面上理解bridge桥梁的意思，暂且咱就叫它桥接拦截器，那具体是桥接什么内容的呢？

简介

  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. 用官方的翻译解释桥接拦截器的意思是该拦截器是链接客户端请求和网络请求的桥梁，它首先将客户端构建的Request对象信息构建成真正的网络请求;然后发起网络请求，最后就是将服务器返回的消息封装成一个Response对象。

intercept方法实现

  前面已经说过拦截器的核心逻辑是在intercept方法中，所以直接看代码:

设置请求头

 @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) {
        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.
    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());
    if (!cookies.isEmpty()) {
      requestBuilder.header("Cookie", cookieHeader(cookies));
    }

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

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

在看这些代码的时候还要明白一些定义，要先了解一个http请求都包括哪些信息，随便打开一个网址，用浏览器的开发者工具看一下:

<img src="https://user-images.githubusercontent.com/30682550/38075864-67389470-3366-11e8-8f25-bd9dd79769b1.jpg" width="50%" height="50%">

看到上边请求内容字段发现和intercept方法中的设置属性字段完全一样，所以印证之前说法，BridgeInterceptor的核心功能就是将用户请求完全变成一个真正的网络请求，具体字段的含义如下:

  1. Content-Type 定义网络文件的类型和网页的编码,如果未指定 ContentType,默认为[TEXT]/[HTML]
  2. Content-Length 表示的是请求体内容的长度。它和 Transfer-Encoding 是互斥的,主要根据 Content-Length 是否为 -1 进行判读使用哪一个请求头。
  3. Transfer-Encoding Transfer-Encoding 值为 chunked 表示请求体的内容大小是未知的。
  4. Host 客户端指定想访问的http服务器的域名/IP和端口号
  5. Connection 默认就是 "Keep-Alive",就是一个 TCP 连接之后不会关闭,保持连接状态。
  6. Accept-Encoding 优先的内容编码,默认是 "gzip" 告诉服务器客户端支持 gzip 编码的响应。
  7. Range 实体的字节范围
  8. Cookie 当请求设置了 Cookie 那么就是添加 Cookie 这个请求头。
  9. User-Agent HTTP客户端程序的信息

有了上边字段的定义解释，具体的代码实现机会不赘述了，总之上面的所有字段的赋值都是讲一个普通的用户Request添加很多头部信息，让其成为可以发送网络请求的真正的Request。

转换Response

  将网络请求回来的响应 Response 转化为用户可用的 Response。 这句话怎么理解呢?例如 OKHTTP 默认就是支持 GZIP 压缩的,若服务器返回的响应体是经过 GZIP 压缩的,那么 BridgeInterceptor 就有责任将其进行解压,那么调用者无需关系这个过程了,只要得到最终的 Response 即可。

获取服务器返回的 Cookie

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

将网络请求返回的响应进行转化

当 transparentGzip 为 true ,表示请求设置的 Accept-Encoding 是 支持gzip 压缩的,意思就是告知服务器客户端是支持 gzip 压缩的,然后再判断服务器的响应头 Content-Encoding 是否也是 GZIP 压缩的,意思就是响应体内容是否是经过 GZIP 压缩的,如果都成立的条件下,那么它会将 Resposonse.body().source() 的输入流 BufferedSource 转化为 GzipSource 类型,这样的目的就是让调用者在使用 Response.body().string() 获取响应内容时就是以解压的方式进行读取流数据。

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); 
responseBuilder.body(new RealResponseBody(strippedHeaders, Okio.buffer(responseBody))); 
}

总结

BridgeInterceptor的主要业务比较简单，对Request添加一些头部信息，转换成为真正的网络请求，然后针对请求响应做些处理，大致流程如下:

  1. 获取请求，请求的body,根据body的长度进行相关的 头
  2. 其他一些头的设置，如"User-Agent"、"Connection"等
  3. 调用chain.proceed(requestBuilder.build());传递给下一个拦截器进行处理，并返回Response
  4. 是否有cookie,响应是否使用了gzip，如果有的话重新设置响应的body
上一篇下一篇

猜你喜欢

热点阅读