okhttp拦截器（网络拦截器与应用拦截器）

拦截器是一种强大的机制，可以监视、重写和重试调用。这是一个简单的拦截器，用于记录传出请求和传入响应。

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上面定义的来显示差异。

注册一个应用程序通过调用拦截器addInterceptor()上OkHttpClient.Builder：

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();

URLhttp://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。

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

网络请求还包含更多数据，例如Accept-Encoding: gzipOkHttp 添加的标头以宣传对响应压缩的支持。网络拦截器的Chain非空值Connection可用于查询用于连接到网络服务器的 IP 地址和 TLS 配置。

在应用程序和网络拦截器之间进行选择

每个拦截器链都有相对的优点。

应用拦截器

• 无需担心重定向和重试等中间响应。
• 始终调用一次，即使 HTTP 响应是从缓存中提供的。
• 遵守应用程序的原始意图。不关心 OkHttp 注入的标头，如If-None-Match.
• 允许短路而不是通话Chain.proceed()。
• 允许重试并多次调用Chain.proceed()。
• 可以使用 withConnectTimeout、withReadTimeout、withWriteTimeout 调整呼叫超时。

网络拦截器

• 能够对重定向和重试等中间响应进行操作。
• 不会为使网络短路的缓存响应而调用。
• 观察数据，就像它将通过网络传输一样。
• 访问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();
  }
};

通常，这种方法在补充网络服务器上的相应修复时效果最佳！