OkHttp的桥拦截器的源码解读

2019-01-29  本文已影响0人  几行代码

OkHttp的重定向及重试拦截器的源码解读:https://www.jianshu.com/p/d70f07288afc
BridgeInterceptor 桥接拦截器:
主要用于设置 内容长度、编码方式、压缩等等 主要添加头部的作用 成为一个可以发送网络请求的request。

下面是主要实现的拦截方法:

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

        RequestBody body = userRequest.body();
        if (body != null) {
            // 进行Header的包装
            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");
        }

        // 创建OkhttpClient配置的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());
        }

        // 执行拦截器链的操作,相当于发起一个网络请求
        Response networkResponse = chain.proceed(requestBuilder.build());

        // 解析服务器返回的Header,如果没有这个cookie,则不进行解析
        HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers());
        
        // 这里为省事题外一个方法: *********** start *************
        public static void HttpHeaders.receiveHeaders(CookieJar cookieJar, HttpUrl url, Headers headers) {
            if (cookieJar == CookieJar.NO_COOKIES) return;

            List<Cookie> cookies = Cookie.parseAll(url, headers);
            if (cookies.isEmpty()) return;

            cookieJar.saveFromResponse(url, cookies);
        }
        // *********** end *************

        Response.Builder responseBuilder = networkResponse.newBuilder()
                .request(userRequest);

        // 第一个条件为true告诉服务端表示支持gzip压缩 第二个条件 判断服务器返回的相应体内容是否经过"gzip"压缩
        if (transparentGzip
                && "gzip".equalsIgnoreCase(networkResponse.header("Content-Encoding"))
                && HttpHeaders.hasBody(networkResponse)) {
            // 将输入流转换成GzipSource实体解压的数据流
            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");
            // 这里可以看到压缩解压的操作是由Okio库来处理的
            responseBuilder.body(new RealResponseBody(contentType, -1L, Okio.buffer(responseBody)));
        }

        return responseBuilder.build();
    }

使用注意点:
方法intercept()主要是针对请求头(Header)做了一些处理,这里主要提一下"Accept-Encoding", "gzip",关于它有以下几点需要注意:

  1. 开发者没有添加Accept-Encoding时,自动添加Accept-Encoding: gzip
  2. 自动添加Accept-Encoding,会对request,response进行自动解压
  3. 手动添加Accept-Encoding,不负责解压缩
  4. 自动解压时移除Content-Length,所以上层Java代码想要contentLength时为-1
  5. 自动解压时移除 Content-Encoding
  6. 自动解压时,如果是分块传输编码,Transfer-Encoding: chunked不受影响

总结一下BridgeInterceptor 桥拦截器的流程

  1. 负责将用户的构建的一个Request请求转化为能够进行网络访问的请求
  2. 将这个符合网络访问请求的Request进行网络请求
  3. 将网络请求回来的响应Response转化为用户可用的Response

谢谢阅读,如有错误,欢迎指正。
OkHttp的CacheInterceptor缓存拦截器剖析传送门:https://www.jianshu.com/p/3c07a12dc8ed

上一篇 下一篇

猜你喜欢

热点阅读