Android OkHttp拦截器源码分析二--两种自定义拦截器的区别

上面一篇文章简单介绍了拦截器,源码中拦截器的种类及作用,以及自定义拦截器和注册自定义拦截器

上篇已经讲了源码中拦截器的执行顺序
这篇主要从源码角度分析

okhttp GitHub关于拦截器的介绍
链接:https://github.com/square/okhttp/wiki/Interceptors
如果你有看这个链接,或看其他人的文章肯定很疑惑为啥
会说NetworkInterceptor走两次
因为他们都没说详细的原因,来别急,看了下面的例子就会清楚了

Interceptor 实例看结果

可以先忽略小标题看代码就好
下面分别是自定义的两种拦截器,应用拦截器和网络拦截器,来测试一下看结果

public class AppInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Log.e("Interceptor", "app intercept:begin ");
        Request request = chain.request();
        Response response = chain.proceed(request);//请求
        Log.e("Interceptor", "app intercept:end; " + request.url()+", response ," +
                response.request().url()+" code: " + response.code());
        return response;
    }
}
public class NetworkInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Log.e("Interceptor","network interceptor:begin");
        Request request = chain.request();
        Response  response = chain.proceed(request);//请求
        Log.e("Interceptor","network interceptor:end;" + request.url()+", response ," +
                response.request().url()+" code: " + response.code());
        return response;
    }
}

发起网络请求

OkHttpClient okHttpClient = new OkHttpClient
                .Builder()
                .addInterceptor(new AppInterceptor())
                .addNetworkInterceptor(new NetworkInterceptor())
                .build();

 Request request = new Request.Builder().url("http://www.baidu.com/").build();
        okHttpClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(okhttp3.Call call, IOException e) {
                LogUtils.d("Interceptor", "--" + e.getMessage());
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                LogUtils.d("Interceptor", "--" + response.toString());
            }
        });

没有发生重定向结果

10-08 01:04:24.435 20080-20301/com.qgg.practice E/Interceptor: app intercept:begin 
10-08 01:04:24.477 20080-20301/com.qgg.practice E/Interceptor: network interceptor:begin
10-08 01:04:24.494 20080-20301/com.qgg.practice E/Interceptor: network interceptor:end;http://www.baidu.com/, response ,http://www.baidu.com/ code: 200
10-08 01:04:24.496 20080-20301/com.qgg.practice E/Interceptor: app intercept:end; http://www.baidu.com/, response ,http://www.baidu.com/ code: 200
10-08 01:04:24.497 20080-20301/com.qgg.practice D/Interceptor: --Response{protocol=http/1.1, code=200, message=OK, url=http://www.baidu.com/}

发生重定向结果

如果你把上面的地址改为 http://www.baidu.cn

 Request request = new Request.Builder().url("http://www.baidu.cn").build();
10-08 00:56:59.149 19078-19142/com.qgg.practice E/Interceptor: app intercept:begin 
10-08 00:56:59.181 19078-19142/com.qgg.practice E/Interceptor: network interceptor:begin
10-08 00:56:59.198 19078-19142/com.qgg.practice E/Interceptor: network interceptor:end;http://www.baidu.cn/, response ,http://www.baidu.cn/ code: 302
10-08 00:56:59.212 19078-19142/com.qgg.practice E/Interceptor: network interceptor:begin
10-08 00:56:59.222 19078-19142/com.qgg.practice E/Interceptor: network interceptor:end;http://www.baidu.com/, response ,http://www.baidu.com/ code: 200
10-08 00:56:59.225 19078-19142/com.qgg.practice E/Interceptor: app intercept:end; http://www.baidu.cn/, response ,http://www.baidu.com/ code: 200
10-08 00:56:59.225 19078-19142/com.qgg.practice D/Interceptor: --Response{protocol=http/1.1, code=200, message=OK, url=http://www.baidu.com/}

咦,确实,网络拦截器竟然走了两次
其实标题已经说明了原因,对,就是因为发生了重定向,可以看到之前有返回httpcode 302
这时第一类拦截器就起了作用 RetryAndFollowUpInterceptor 帮我们访问了http://www.baidu.com/

RetryAndFollowUpInterceptor 详细分析的时候再来说明

现在就可以把官网的两种拦截器的详细对比贴出来了
Application and Network interceptors 该如何选择

两个interceptor都有他们各自的优缺点:

Application Interceptors
  • 不需要关心由重定向、重试请求等造成的中间response产物。
  • 总会被调用一次,即使HTTP response是从缓存(cache)中获取到的。
  • 关注原始的request,而不关心注入的headers,比如If-None-Match。
  • interceptor可以被取消调用,不调用Chain.proceed()。
  • interceptor可以重试和多次调用Chain.proceed()。

Network Interceptors

  • 可以操作由重定向、重试请求等造成的中间response产物。
  • 如果是从缓存中获取cached responses ,导致中断了network,是不会调用这个interceptor的。
  • 数据在整个network过程中都可以通过Network Interceptors监听。
  • 可以获取携带了request的Connection。


    拦截器调用路径图

结合图和例子,再看上面的两种区别分析应该理解的比较清楚了

Interceptor 源码分析

可以看到源码设计的很巧妙 Interceptor 是接口
所以,可以肯定的是之前介绍的源码中的五种拦截器都是实现了Interceptor 接口
Interceptor 中只有一个方法intercept 参数为Chain,返回值为Response
而Chain又是一个接口

/**
 * Observes, modifies, and potentially short-circuits requests going out and the corresponding
 * responses coming back in. Typically interceptors add, remove, or transform headers on the request
 * or response.
 */
public interface Interceptor {
  Response intercept(Chain chain) throws IOException;

  interface Chain {
    Request request();

    Response proceed(Request request) throws IOException;

    /**
     * Returns the connection the request will be executed on. This is only available in the chains
     * of network interceptors; for application interceptors this is always null.
     */
    @Nullable Connection connection();

    Call call();

    int connectTimeoutMillis();

    Chain withConnectTimeout(int timeout, TimeUnit unit);

    int readTimeoutMillis();

    Chain withReadTimeout(int timeout, TimeUnit unit);

    int writeTimeoutMillis();

    Chain withWriteTimeout(int timeout, TimeUnit unit);
  }
}

未完待续...

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