本文为翻译文章,原文地址,点击查阅
拦截器是一种强大的机制,可以监视,重写和重试呼叫。 这是一个简单的拦截器,用于记录传出的请求和传入的响应。
class LoggingInterceptor implements Interceptor {
@Override public Response intercept(Interceptor.Chain chain) throws IOException {
Request request = chain.request();
long t1 = System.nanoTime();
logger.info(String.format("Sending request %s on %s%n%s",
request.url(), chain.connection(), request.headers()));
Response response = chain.proceed(request);
long t2 = System.nanoTime();
logger.info(String.format("Received response for %s in %.1fms%n%s",
response.request().url(), (t2 - t1) / 1e6d, response.headers()));
return response;
}
}
对chain.proceed(request)
的调用是每个拦截器实现的关键部分。 这种简单的方法是所有HTTP
工作发生的地方,它会产生一个响应来满足请求。 如果chain.proceed(request)
被多次调用,则必须关闭先前的响应主体。
拦截器可以链接。 假设您同时具有压缩拦截器和校验和拦截器:您需要确定数据是先压缩后再校验和,还是先校验后再压缩。 OkHttp
使用列表来跟踪拦截器,并按顺序调用拦截器。
应用拦截
拦截器已注册为应用程序或网络拦截器。 我们将使用上面定义的LoggingInterceptor
来显示差异。
可以通过在OkHttpClient.Builder
上调用addInterceptor()
注册应用程序拦截器:
OkHttpClient client = new OkHttpClient.Builder()
.addInterceptor(new LoggingInterceptor())
.build();
Request request = new Request.Builder()
.url("http://www.publicobject.com/helloworld.txt")
.header("User-Agent", "OkHttp Example")
.build();
Response response = client.newCall(request).execute();
response.body().close();
URL http://www.publicobject.com/helloworld.txt
重定向到https://publicobject.com/helloworld.txt
,OkHttp
自动遵循此重定向。 我们的应用程序拦截器被调用一次,从chain.proceed(
)返回的响应具有重定向的响应:
INFO: Sending request http://www.publicobject.com/helloworld.txt on null
User-Agent: OkHttp Example
INFO: Received response for https://publicobject.com/helloworld.txt in 1179.7ms
Server: nginx/1.4.6 (Ubuntu)
Content-Type: text/plain
Content-Length: 1759
Connection: keep-alive
我们可以看到我们被重定向了,因为response.request()
。url()
与request.url()
不同。 这两个日志语句记录两个不同的URL
。
网络拦截器
网络拦截器非常相似。 调用addNetworkInterceptor()
而不是addInterceptor()
:
OkHttpClient client = new OkHttpClient.Builder()
.addNetworkInterceptor(new LoggingInterceptor())
.build();
Request request = new Request.Builder()
.url("http://www.publicobject.com/helloworld.txt")
.header("User-Agent", "OkHttp Example")
.build();
Response response = client.newCall(request).execute();
response.body().close();
当我们运行此代码时,拦截器将运行两次。 一次是对http://www.publicobject.com/helloworld.txt
的初始请求,另一个是对https://publicobject.com/helloworld.txt
的重定向。
User-Agent: OkHttp Example
Host: www.publicobject.com
Connection: Keep-Alive
Accept-Encoding: gzip
INFO: Received response for http://www.publicobject.com/helloworld.txt in 115.6ms
Server: nginx/1.4.6 (Ubuntu)
Content-Type: text/html
Content-Length: 193
Connection: keep-alive
Location: https://publicobject.com/helloworld.txt
INFO: Sending request https://publicobject.com/helloworld.txt on Connection{publicobject.com:443, proxy=DIRECT hostAddress=54.187.32.157 cipherSuite=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA protocol=http/1.1}
User-Agent: OkHttp Example
Host: publicobject.com
Connection: Keep-Alive
Accept-Encoding: gzip
INFO: Received response for https://publicobject.com/helloworld.txt in 80.9ms
Server: nginx/1.4.6 (Ubuntu)
Content-Type: text/plain
Content-Length: 1759
Connection: keep-alive
网络请求还包含更多数据,例如OkHttp
添加的Accept-Encoding:gzip
标头,以宣传对响应压缩的支持。 网络拦截器的链具有非空连接,可用于询问用于连接到网络服务器的IP
地址和TLS
配置。
在应用程序拦截器和网络拦截器之间进行选择
每种拦截器的优缺点:
应用拦截器(Application interceptors
)
- 无需担心中间响应,例如重定向和重试
- 即使从缓存提供
HTTP
响应,也总是被调用一次 - 遵守应用程序的原始意图。 不关心
OkHttp
注入的标头,如If-None-Match
- 允许短路并且不调用
Chain.proceed()
- 允许重试并多次调用
Chain.proceed()
网络拦截器
- 能够对诸如重定向和重试之类的中间响应进行操作
- 不会为使网络短路的缓存响应调用
- 观察数据,就像通过网络传输数据一样
- 访问承载请求的连接
重写请求
拦截器可以添加,删除或替换请求标头。 他们还可以转换那些具有一个请求的主体。 例如,如果您要连接到已知支持请求的网络服务器,则可以使用应用程序拦截器添加请求正文压缩。
/** This interceptor compresses the HTTP request body. Many webservers can't handle this! */
final class GzipRequestInterceptor implements Interceptor {
@Override public Response intercept(Interceptor.Chain chain) throws IOException {
Request originalRequest = chain.request();
if (originalRequest.body() == null || originalRequest.header("Content-Encoding") != null) {
return chain.proceed(originalRequest);
}
Request compressedRequest = originalRequest.newBuilder()
.header("Content-Encoding", "gzip")
.method(originalRequest.method(), gzip(originalRequest.body()))
.build();
return chain.proceed(compressedRequest);
}
private RequestBody gzip(final RequestBody body) {
return new RequestBody() {
@Override public MediaType contentType() {
return body.contentType();
}
@Override public long contentLength() {
return -1; // We don't know the compressed length in advance!
}
@Override public void writeTo(BufferedSink sink) throws IOException {
BufferedSink gzipSink = Okio.buffer(new GzipSink(sink));
body.writeTo(gzipSink);
gzipSink.close();
}
};
}
}
重写响应
对称地,拦截器可以重写响应头并转换响应主体。 通常,这比重写请求标头更危险,因为它可能违反网络服务器的期望!
如果您处在棘手的情况下并且准备好应对后果,则重写响应标头是解决问题的有效方法。 例如,您可以修复服务器的错误配置的Cache-Control
响应标头,以实现更好的响应缓存:
/** Dangerous interceptor that rewrites the server's cache-control header. */
private static final Interceptor REWRITE_CACHE_CONTROL_INTERCEPTOR = new Interceptor() {
@Override public Response intercept(Interceptor.Chain chain) throws IOException {
Response originalResponse = chain.proceed(chain.request());
return originalResponse.newBuilder()
.header("Cache-Control", "max-age=60")
.build();
}
};
通常,这种方法在补充对webserver
!e标头
的相应修复以实现更好的响应缓存时,效果最好。