OkHttp之拦截器

最新推荐文章于 2025-06-19 21:44:38 发布
程序邦
最新推荐文章于 2025-06-19 21:44:38 发布
阅读量450
点赞数
CC 4.0 BY-SA版权
分类专栏： Android 源码研究
本文链接：https://blog.youkuaiyun.com/jiankeufo/article/details/78605229
Android 源码研究专栏收录该内容
45 篇文章
订阅专栏
 
  拦截器是一个非常强大的机制，可以监视，重写和重试call。这里是一个简单的拦截器，用来打印出去的请求和收到的响应。

  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工作发生，产出满足请求的响应之处，
  拦截器可以链接。假如有一个压缩拦截器和一个检验和拦截器：你需要决定是先数据进行压缩然后检验和，还是先检验和然后进行压缩。OkHttp使用列表来跟踪拦截器，并且拦截器按顺序被调用。
  
   
   

   
    Interceptor
   
  
  应用拦截器
  拦截器可以注册为应用拦截器和网络拦截器。我们使用上面定义的LoggingInterceptor来展示它们的不同。
  通过在OkHttpCleint.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();
  http://www.publicobject.com/helloworld.txt这个URL重定向到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
  我看可以看到我们已经重定向了，引文reponse.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。
  INFO: Sending request http://www.publicobject.com/helloworld.txt on Connection{www.publicobject.com:80, proxy=DIRECT hostAddress=54.187.32.157 cipherSuite=none protocol=http/1.1}
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头来通知支持响应压缩。网络拦截器的Chain有一个非空Connection，可以用来访问IP地址和用来连接网络服务器的TLS配置。
  选择应用拦截器还是网络拦截器？
  每种拦截器chain有相对的优势。
  应用拦截器
    不需要关心像重定向和重试这样的中间响应。
总是调用一次，即使HTTP响应从缓存中获取服务。
监视应用原始意图。不关心OkHttp注入的像If-None-Match头。
允许短路并不调用Chain.proceed()。
允许重试并执行多个Chain.proceed()调用。
网络拦截器
    可以操作像重定向和重试这样的中间响应。
对于短路网络的缓存响应不会调用。
监视即将要通过网络传输的数据。
访问运输请求的Connection。
  重写请求
  拦截器可以添加，移除或替换请求头。如果有请求主体，它们也可以改变。例如，如果你连接一个已知支持请求主体压缩的网络服务器，你可以使用一个应用拦截器来添加请求主体压缩。
  /** 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();
  }
};
  通常当在网络服务器上完成相应的修复时，这种方式会更好的工作。
  可用性
  OkHttp的拦截器需要OkHttp2.2或更高。不幸地，拦截器无法与OkUrlFactory一起工作，或者基于它构建的库，包括等于低于1.0版本的Retrofit以及等于低于2.4版本的Picasso。