OKhttp源码学习(五)—— 拦截器_BridgeInterceptor

BridgeInterceptor拦截器分析

源码地址:https://github.com/square/okhttp

作为内置的第二个拦截器,这个拦截器在RetryAndFollowUpInterceptor之后又做了些什么呢?

1. 整体结构:

和第一个拦截器对比,整体结构简单多了。

一个构造方法,一个拦截方法,一个处理cookieHeader的方法。

整体结构

2. 主要功能

  1. 在请求前对Header进行处理,如果用户有设置就直接使用,如果没有设置就使用默认的。
  2. 通过Chain调用下一个拦截器。
  3. 对与返回的结果,进行Gzip, Header, 以及cookie的处理。

3. 源码分析

intercept 方法

其实前面提到的主要功能就是在这个intercept 方法中体现,

下面在代码中注析了对应的功能

  @Override public Response intercept(Chain chain) throws IOException {
    Request userRequest = chain.request();
    Request.Builder requestBuilder = userRequest.newBuilder();
    
    //下面一大段代码都是处理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");
    }

    //如果我们不自定义编解码方式的方式,这里添加了Gzip的编解码
    // 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");
    }

    //在创建ohHttpClient的时候,添加的cookiejar, 这里会对其进行写入。
    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());
    }
   
   //以上是请求前的,前期头的处理
   //通过chain,调用下一个拦截器,并得到结果
    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);
      responseBuilder.body(new RealResponseBody(strippedHeaders, Okio.buffer(responseBody)));
    }

    return responseBuilder.build();
  }

cookie处理

   //从前面okHttpClient 中设置的cookieJar,然后设置到请求头的Cookie中去。
    List<Cookie> cookies = cookieJar.loadForRequest(userRequest.url());
    if (!cookies.isEmpty()) {
      requestBuilder.header("Cookie", cookieHeader(cookies));
    }
     略
    Response networkResponse = chain.proceed(requestBuilder.build());
    //收到结果之后,是否保存cookie
    HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers());

这里涉及到CookieJar,对cookie的处理。其中loadForRequest 就是获取cookie,而saveFromResponse 就是把cookie保存下来,这个都是我们自定义的,在okHttpClient创建的时候,可以进行对应的定制,保存在哪里,从哪里获取。

Gzip

okHttp3 默认使用Gzip,不过是使用okio进行处理的。

最后会把前面的头处理新建一个response的body,进行返回。

4. 总结

这个拦截器其实是比较简单的,主要处理请求头,Gzip,以及cookie的处理。

系列(简书地址):
OKhttp源码学习(一)—— 基本请求流程
OKhttp源码学习(二)—— OkHttpClient
OKhttp源码学习(三)—— Request, RealCall
OKhttp源码学习(四)——RetryAndFollowUpInterceptor拦截器
OKhttp源码学习(六)—— CacheInterceptor拦截器
OKhttp源码学习(七)—— ConnectInterceptor拦截器
OKhttp源码学习(八)——CallServerInterceptor拦截器
OKhttp源码学习(九)—— 任务管理(Dispatcher)

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章