android okhttp Interceptors 简析

前言

网络上到处都是okhttp拦截器介绍，不管是重复转载，还是翻译。当然这也是喜闻乐见的。总之都是为了学习，记忆。

入口-24种设计模式拦截器设计模式

什么是拦截器：

Interceptors are a powerful mechanism that can monitor, rewrite, and retry calls. Here’s a simple interceptor that logs the outgoing request and the incoming response.

拦截器是一种设计模式，被前人总结出来的编程方式，那么在okhttp中拦截器有什么作用：

拦截器是一种具有监控网络请求（通过日志），重写（请求头，请求体，请求参数等等），重试（异常断网）调用的强大能力。

下面来自翻译官网

 通过loger打印，请求内容日志和响应内容日志

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采用列表的形式追踪拦截器，拦截器会被有序调用。

拦截器分类

1.应用拦截器
2.网络拦截器

应用拦截器

拦截器被注册成为应用拦截器或者网络拦截器。下面通过上述定义的LoggingInterceptor来展示他们之间的不同。注册一个应用拦截器通过调用OkHttpClient.interceptors()返回的List的add()方法完成。

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。

网络拦截器

注册网络拦截器和注册应用拦截器很类似。只是通过networkInterceptors()方法取代了interceptore()方法。

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中有一个非空的连接可以用于询问连接到web服务器时使用的IP地址和TLS配置。

如何选择使用应用拦截器或者网络拦截器

应用拦截器

    *不必要担心响应和重定向之间的中间响应。

    *通常只调用一次，即使HTTP响应是通过缓存提供的。

    *遵从应用层的最初目的。与OkHttp的注入头部无关，如If-None-Match。

    *允许短路而且不调用Chain.proceed()。

    *允许重试和多次调用Chain.proceed()。

网络拦截器

    *允许像重定向和重试一样操作中间响应。

    *网络发生短路时不调用缓存响应。

    *在数据被传递到网络时观察数据。

    *有权获得装载请求的连接。

重写请求

通过拦截器可以添加，移除，替换请求头。也可以改变请求的请求体。例如，在知道连接的web服务器是否支持压缩格式的情况下，可以使用应用拦截器添加请求体压缩类型。

/** 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();
      }
    };
  }
}

重写响应体

相对应地，拦截器可以重写响应头和改变响应体。这一点比重写写请求头要危险，因为可能违反web服务器的期望。

如果你处于一种比较纠结的状态，并且准备处理结果，那么重写响应头是解决问题的有效方法。例如，可以修复服务器配置错误的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的拦截器需要OkHttp 2.2或更好。不幸的是，拦截器不能与OkUrlFactory或其上构建的库一起使用，包括Retrofit≤1.8和Picasso≤2.4。

引用

okhttp 官网 https://github.com/square/okhttp/wiki/Interceptors
拦截器翻译 http://blog.csdn.net/oyangyujun/article/details/50039403