OkHttp的拦截器(Interceptor)

本文使用OkHttp 3.14.1版本

OkHttp每次发送请求,最终追溯到RealCall#getResponseWithInterceptorChain()方法:

Response getResponseWithInterceptorChain() throws IOException {
    // 拦截器的集合
    // Build a full stack of interceptors.
    List<Interceptor> interceptors = new ArrayList<>();
    interceptors.addAll(client.interceptors());    // 1. 自定义App拦截器
    interceptors.add(new RetryAndFollowUpInterceptor(client));    // 2. 重试和转发拦截器
    interceptors.add(new BridgeInterceptor(client.cookieJar()));    // 3. 桥接用户请求/响应和网络请求/响应
    interceptors.add(new CacheInterceptor(client.internalCache()));    // 4. 缓存拦截器
    interceptors.add(new ConnectInterceptor(client));    // 5. 网络连接拦截器
    if (!forWebSocket) {
        interceptors.addAll(client.networkInterceptors());    // 6. 自定义network拦截器
    }
    interceptors.add(new CallServerInterceptor(forWebSocket));    // 7. 网络请求和响应

    // 创建拦截器链
    Interceptor.Chain chain = new RealInterceptorChain(interceptors, transmitter, null, 0,
        originalRequest, this, client.connectTimeoutMillis(),
        client.readTimeoutMillis(), client.writeTimeoutMillis());

    /**
     * 省略部分代码
     */

    // 交给拦截器链条处理请求
    try {
        Response response = chain.proceed(originalRequest);
        /**
         * 省略部分代码
         */
    } finally {
        /* 省略 */
    }
}

网上找了个图,感谢Piasy Xu

https://blog.piasy.com/2016/07/11/Understand-OkHttp

OkHttp自带的拦截器

2. RetryAndFollowUpInterceptor

处理重定向(HTTP 3xx)和一部分失败重试(HTTP 401407408503);

3. BridgeInterceptor

起到桥接作用,将user request转换为network request交给下游(添加一些请求头),再将下游返回的network response转换为user response(保存Cookie、处理压缩);

4. CacheInterceptor

处理缓存。包括将HTTP response写入缓存,以及可以从缓存读取响应时拦截网络请求(链条后续的Interceptor将不会被调用);

5. ConnectInterceptor

与目标服务器建立连接(open a connection),然后交给后续Interceptor处理;

7. CallServerInterceptor

最终环节。与服务器进行网络交互。

用户自定义的拦截器

包括1.App拦截器5.Network拦截器官方图示:

两者区别,摘自官方文档

Application interceptors

    Don't need to worry about intermediate responses like redirects and retries.
    Are always invoked once, even if the HTTP response is served from the cache.
    Observe the application's original intent. Unconcerned with OkHttp-injected headers like If-None-Match.
    Permitted to short-circuit and not call Chain.proceed().
    Permitted to retry and make multiple calls to Chain.proceed().

Network Interceptors

    Able to operate on intermediate responses like redirects and retries.
    Not invoked for cached responses that short-circuit the network.
    Observe the data just as it will be transmitted over the network.
    Access to the Connection that carries the request.

翻译过来,加上我自己的理解:

应用拦截器(Application interceptors)

  • 忽略中间状态的响应,比如重定向和失败重试
  • 即使是从缓存获取响应,也总会调用一次
  • 着重于应用本身的企图,不关心If-None-Match这种会被OkHttp内部处理掉的Header
    【这条我认为是最重要的设计思路,App拦截器被设计成用户意图的处理者,并不关心网络请求的细节】
  • 可以不调用Chain.proceed()
  • 可以重发网络请求和多次调用Chain.proceed()
    【这两条连起来说。没看源码之前感觉云里雾里,看完就明白文档想表达什么意思了。拦截器链条需要每一个拦截器都调用Chain.proceed()方法交给下一个拦截器处理,即从上一个环节交给下一个环节,N个拦截器才能成为拦截器链条。RetryAndFollowUpInterceptorBridgeInterceptorApp等等都是如此,除了最尾端的CallServerInterceptor(因为没有下一环节了)。App拦截器是拦截器链条的第一环,它的实现取决于用户意图,如果用户不需要发送请求,就可以不调用Chain.proceed()让拦截器链失效(文档中的用词是“短路(short-circuit)”);如果用户想要多次发送请求,同理也可以多次调用Chain.proceed()达到目的。】

网络拦截器(Network Interceptors)

  • 可以对中间状态的网络响应进行处理
    【Network拦截器位于ConnectInterceptorCallServerInterceptor之间,因此可以对CallServerInterceptor发回来的网络响应做一些操作】
  • 如果是从缓存获取的Response情况,Network拦截器不被调用
    CacheInterceptorConnectInterceptor之前就被调用了,如果从缓存获取到响应,CacheInterceptor之后的拦截器都不会被调用,自然也包括了Network拦截器】
  • 将数据视作通过网络传输
    【“Observe the data just as it will be transmitted over the network”,这句话我认为更多在表述设计思想,Network拦截器被设计为处理网络请求的场景(这里是狭义的网络请求,即真正需要通过网络获取数据的场景,有别于从缓存获取响应),开发者在实现Network拦截器时应该考虑到这一点。】
  • 能拿到请求使用的Connection对象
    【应该是指okhttp3.Connection接口的实现,即RealConnection的实例。链条前一个环节ConnectInterceptor已经创建了网络连接,可供Network拦截器使用了】

参考

拆轮子系列:拆 OkHttp
https://github.com/square/okhttp/blob/master/INTERCEPTORS.md

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,588评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,456评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,146评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,387评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,481评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,510评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,522评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,296评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,745评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,039评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,202评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,901评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,538评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,165评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,415评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,081评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,085评论 2 352