okhttp拦截器（interceptor）

2019-05-04 本文已影响1人 BigDevil_S

拦截器在okhttp的请求流程中用于处理request和response，下面贴一段官方给的示例代码：

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;
  }
}

okhttp的interceptor采用的是责任链模式，在这条责任链中其中，前面的interceptor根据自己的需求处理request对象，处理完之后将其交给下一个interceptor，也就是上面代码中的chain.proceed(request)方法，然后等待下一个拦截器返回一个response，再对返回的结果进行处理，最终给请求的发起者返回一个响应结果。

下面是官方wiki给的一张关于拦截器的图：

来源：官方wiki
图中可以清楚的看出interceptor的作用就是用来处理请求和响应。在图中我们可以看到他标注出了两种拦截器：application interceptor和network interceptor这两者的作用是不同的，下面从源码中分析一下这两者的区别。

  Response getResponseWithInterceptorChain() throws IOException {
    // Build a full stack of interceptors.
    List<Interceptor> interceptors = new ArrayList<>();
    interceptors.addAll(client.interceptors());
    interceptors.add(new RetryAndFollowUpInterceptor(client));
    interceptors.add(new BridgeInterceptor(client.cookieJar()));
    interceptors.add(new CacheInterceptor(client.internalCache()));
    interceptors.add(new ConnectInterceptor(client));
    if (!forWebSocket) {
      interceptors.addAll(client.networkInterceptors());
    }
    interceptors.add(new CallServerInterceptor(forWebSocket));

    Interceptor.Chain chain = new RealInterceptorChain(interceptors, transmitter, null, 0,
        originalRequest, this, client.connectTimeoutMillis(),
        client.readTimeoutMillis(), client.writeTimeoutMillis());

    boolean calledNoMoreExchanges = false;
    try {
      Response response = chain.proceed(originalRequest);
      if (transmitter.isCanceled()) {
        closeQuietly(response);
        throw new IOException("Canceled");
      }
      return response;
    } catch (IOException e) {
      calledNoMoreExchanges = true;
      throw transmitter.noMoreExchanges(e);
    } finally {
      if (!calledNoMoreExchanges) {
        transmitter.noMoreExchanges(null);
      }
    }
  }

上面的函数是在okhttp的请求中都会调用，其中就有拦截器的添加，client.interceptors()和client.networkInterceptors()就分别对应了上面图中的两种拦截器，可以看到network interceptor的添加还会受到forWebSocket的影响，这个我们暂时先不管，只要知道这两种拦截器分别被添加到了不同的位置就可以了。那么要知道这两种拦截器有什么区别，只要看下okhttp自带的5个interceptor各自的作用是什么就行了：

RetryAndFollowUpInterceptor：用于重定向和发生错误时重试
BridgeInterceptor：应用层与网络层的桥梁，从代码中看主要是为request添加请求头，为response去除响应头
CacheInterceptor：处理请求与响应缓存
ConnectInterceptor：与服务器建立连接
CallServerInterceptor：责任链中最后一个拦截器，用最终得到的request发送请求，将获取到response返回给前面的拦截器处理

这样application interceptor和network interceptor的区别就很明显了，应用拦截器不会关注重定向和错误重试等操作，并且获取到的 request和response并不是网络层的。而网络拦截器则与之相反，如果发生了重定向和重试，那么会被调用多次，获取的request和response是完整的。
在官方wiki中有最上面的拦截器实例代码作为应用拦截器和网络拦截器分别的打印情况，同时也给出了它们的区别：

Application interceptors

不用关注重定向、重试等中间响应
只会调用一次
只需关注应用发起请求的意图，不用关心okhttp为其添加的头部信息，比如 If-None-Match
可以不调用Chain.proceed()不发送请求
可以多次调用Chain.proceed()来重试请求

Network Interceptors

可以操作重定向、重试等中间响应
当返回缓存的响应时不会被调用
可以获取到网络传输中真实的请求与响应
可以访问带有请求的连接

上面还提到了网络拦截器的添加还会受到forWebSocket的影响，这个字段表示的是否使用WebSocket协议。
维基百科-WebSocket
这是一种全双工通信的协议，客户端和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。
个人理解这个建立连接的请求和响应不应该被网络层的拦截器修改所以当forWebSocket为true时网络拦截器就不会被添加。

okhttp拦截器（interceptor）

猜你喜欢

热点阅读