OKHTTP异步和同步请求简单分析
OKHTTP拦截器缓存策略CacheInterceptor的简单分析
OKHTTP拦截器ConnectInterceptor的简单分析
OKHTTP拦截器CallServerInterceptor的简单分析
OKHTTP拦截器BridgeInterceptor的简单分析
OKHTTP拦截器RetryAndFollowUpInterceptor的简单分析
OKHTTP结合官网示例分析两种自定义拦截器的区别
BridgeInterceptor
/**
* 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.
*/
public final class BridgeInterceptor implements Interceptor {
private final CookieJar cookieJar;
public BridgeInterceptor(CookieJar cookieJar) {
this.cookieJar = cookieJar;
}
@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));
}
//默认是保持连接的 Keep-Alive
if (userRequest.header("Connection") == null) {
requestBuilder.header("Connection", "Keep-Alive");
}
//默认是 GZIP 压缩的
//Accept-Encoding ： 就是告诉服务器客户端能够接受的数据编码类型，OKHTTP 默认就是 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) {
//标记请求支持 GZIP 压缩
transparentGzip = true;
requestBuilder.header("Accept-Encoding", "gzip");
}
//cookie 头的添加
List<Cookie> cookies = cookieJar.loadForRequest(userRequest.url());
if (!cookies.isEmpty()) {
requestBuilder.header("Cookie", cookieHeader(cookies));
}
//user-egent "okhttp/3.4.1"
if (userRequest.header("User-Agent") == null) {
requestBuilder.header("User-Agent", Version.userAgent());
}
//发送网络请求
Response networkResponse = chain.proceed(requestBuilder.build());
//接受服务器返回的 Cookie
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);
responseBuilder.body(new RealResponseBody(strippedHeaders, Okio.buffer(responseBody)));
}
//构建一个Response
return responseBuilder.build();
}
/** Returns a 'Cookie' HTTP request header with all cookies, like {@code a=b; c=d}. */
private String cookieHeader(List<Cookie> cookies) {
StringBuilder cookieHeader = new StringBuilder();
for (int i = 0, size = cookies.size(); i < size; i++) {
if (i > 0) {
cookieHeader.append("; ");
}
Cookie cookie = cookies.get(i);
cookieHeader.append(cookie.name()).append('=').append(cookie.value());
}
return cookieHeader.toString();
}
}
BridgeInterceptor 拦截器的功能主要有以下 3 点：
是负责将用户构建的一个 Request 请求转化为能够进行网络访问的请求。
将这个符合网络请求的 Request 进行网络请求。
将网络请求回来的响应 Response 转化为用户可用的 Response。
下面会通过源码的角度来分析这三点是如何实现的？
1、用户 Request 到 网络 Request 的转换
因为用户在构建一个 Request 对象的时侯往往只会简单设置 url,RequestBody 等几个属性，其实这样就已经可以发送一个网络请求了，但是真正要发送一个请求实际上没这么简单，在 OKHTTP 这么优秀的框架的光环下，使调用者使用这个框架去发送一个网络请求是非常简单的，因为很多功能它内部都进行了高度的封装。
如何对用户 Request 到 网络 Request 的转换呢？从上面的代码中可以看出它在原来 request
的基础上添加了很多请求头，下面列举的是添加的头信息。
Content-Type 定义网络文件的类型和网页的编码，如果未指定 ContentType，默认为[TEXT]/[HTML]，具体的类型，参考这个文档 HTTP Content-type
Content-Length 表示的是请求体内容的长度。它和 Transfer-Encoding 是互斥的，主要根据 Content-Length 是否为 -1 进行判读使用哪一个请求头。
Transfer-Encoding 值为 chunked 表示请求体的内容大小是未知的。
Host 请求的 url 的主机
Connection 默认就是 “Keep-Alive”，就是一个 TCP 连接之后不会关闭，保持连接状态。
Accept-Encoding 默认是 “gzip” 告诉服务器客户端支持 gzip 编码的响应。
Cookie 当请求设置了 Cookie 那么就是添加 Cookie 这个请求头。
User-Agent “okhttp/3.4.1” 这个值根据 OKHTTP 的版本不一样而不一样，它表示客户端 的信息。
上面就是将一个普通的 Request 添加很多头信息，让其成为可以发送网络请求的 Request 。
2、将这个 Request 进行网络请求得到响应 Response
这个过程涉及到其他几个拦截器的操作，具体是怎么进行网络请求，我们暂时不要管，具体查阅我先前写几篇 BLOG 。我们只管这一步操作是一个向服务发送请求的操作，并且这个请求之后服务端会给客户端返回一个 Response 响应就行了。
Response networkResponse = chain.proceed(requestBuilder.build());
3、将网络请求回来的响应 Response 转化为用户可用的 Response。
这句话怎么理解呢？例如 OKHTTP 默认就是支持 GZIP 压缩的，若服务器返回的响应体是经过 GZIP 压缩的，那么 BridgeInterceptor 就有责任将其进行解压，那么调用者无需关系这个过程了，只要得到最终的 Response 即可。
3.1、获取服务器返回的 Cookie
HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers());
3.2、将网络请求返回的响应进行转化
当 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)));
}
4、总结
BidgeInterceptor 这个拦截器的功能相对简单一些，主要就是上面提及到 3 点内容。这里设计的一个 Cookie 的操作，本文并没有详细分析实现，以后再看看吧。
