OkHttpClient源码分析(二) —— RetryAndFollowUpInterceptor和BridgeInterceptor

OkHttp拦截器

  拦截器是OkHttp中提供的一种强大机制,它可以实现网络监听、请求以及响应重写、请求失败重试等功能。

image

如上图所示,这就OkHttp内部提供给我们的拦截器,就是当我们发起一个http请求的时候,OkHttp就会通过这个拦截器链来执行http请求。其中包括:

  • RetryAndFollowUpInterceptor 重试和重定向拦截器
  • BridgeInterceptor :桥接和适配拦截器
  • CacheInterceptor :缓存拦截器
  • ConnectInterceptor :链接拦截器
  • CallServerInterceptor :请求和处理响应拦截器

BridgeInterceptorCacheInterceptor 主要是用来补充用户请求创建当中缺少的一些必需的http请求头和处理缓存的功能。

ConnectInterceptor 主要是负责建立可用的链接,CallServerInterceptor 主要是负责将http请求写进网络的IO流当中,并且从网络IO流当中读取服务端返回给客户端的数据。

源码分析

getResponseWithInterceptorChain()

上篇文章 OkHttpClient源码分析(一)——同步、异步请求的执行流程和源码分析 有提及到一个很重要的方法getResponseWithInterceptorChain(),同步请求的话,是在RealCall类中的excute()方法中调用到该方法,而异步请求是在RealCall的内部类AsyncCal中的excute()方法中调用,查看该方法的源码:

Response getResponseWithInterceptorChain() throws IOException {
    // Build a full stack of interceptors.
    List<Interceptor> interceptors = new ArrayList<>();
    interceptors.addAll(client.interceptors());
    interceptors.add(retryAndFollowUpInterceptor);
    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, null, null, null, 0,
        originalRequest, this, eventListener, client.connectTimeoutMillis(),
        client.readTimeoutMillis(), client.writeTimeoutMillis());

    return chain.proceed(originalRequest);
}

一、方法里初始化了一个Interceptor的集合,添加了OkHttpClient中配置的拦截器集合,然后依次添加了上述提及到的那五个拦截器;

二、创建一个拦截器链RealInterceptorChain,并执行拦截器链的proceed()方法;

查看RealInterceptorChain类的proceed()方法:

 public Response proceed(Request request, StreamAllocation streamAllocation, HttpStream httpStream,
      Connection connection) throws IOException {
      
      ...
      
      // Call the next interceptor in the chain.
    RealInterceptorChain next = new RealInterceptorChain(
        interceptors, streamAllocation, httpStream, connection, index + 1, request);
    Interceptor interceptor = interceptors.get(index);
    Response response = interceptor.intercept(next);
    
    ...
 }

其中,核心的代码就在这里,这里再次创建了RealInterceptorChain对象,此时创建的是下一个拦截器链,传入的是index + 1,并通过调用当前Interceptor的intercept()方法,将下一个拦截器链传入,得到Response对象,至于拦截器的intercept()方法,下面将会分析。

RetryAndFollowUpInterceptor

主要作用是负责网络请求失败重连,需要注意的是,并不是所有的网络请求失败以后都可以进行重连,它是有一定的限制范围的,OkHttp内部会帮我们检测网络异常和响应码的判断,如果都在它的限制范围内的话,就会进行网络重连。

源码主要看intercept()方法:

@Override public Response intercept(Chain chain) throws IOException {
    Request request = chain.request();

    streamAllocation = new StreamAllocation(
        client.connectionPool(), createAddress(request.url()));

    int followUpCount = 0;
    Response priorResponse = null;
    ...
}

这里创建了一个StreamAllocation对象,StreamAllocation对象是用来建立执行Http请求所需要的网络组件的,从它名字可以看出,它是用来分配stream的,主要是用于获取连接服务端的connection和用于与服务端进行数据传输的输入输出流 。

详细的逻辑都在intercept()方法中的while循环中,这里不做详细介绍,主要是介绍其中的这个:

 while (true) {
    ...
    
    try {
        response = ((RealInterceptorChain) chain).proceed(request, streamAllocation, null, null);
        releaseConnection = false;
      }
      
      ...
    
    if (++followUpCount > MAX_FOLLOW_UPS) {
        streamAllocation.release();
        throw new ProtocolException("Too many follow-up requests: " + followUpCount);
    }
    
    ...
 }

这里我们可以发现,RealInterceptorChain调用proceed()方法,方法里又创建了一个RealInterceptorChain对象(下一个拦截器链 index + 1),然后通过index获取到当前执行到的拦截器,调用拦截器的intercept()方法,这里intercept()方法中,再次调用了RealInterceptorChain的proceed()方法,形成了递归。

以上代码是对重试的次数进行判断,由此可知,并不是无限次的进行网络重试,而是有一定的重试次数的,MAX_FOLLOW_UPS 是一个常量,值为20,也就是说最多进行20次重试,如果还不成功的话,就会释放StreamAllocation对象和抛出ProtocolException异常。

总结:

  1. 创建StreamAllocation对象
  2. 调用RealInterceptorChain.proceed()进行网络请求
  3. 根据异常结果或响应结果判断是否要进行重新请求
  4. 调用下一个拦截器,对response进行处理,返回给上一个拦截器

BridgeInterceptor

同样也是看核心方法intercept():

@Override public Response intercept(Chain chain) throws IOException {
    Request userRequest = chain.request();
    Request.Builder requestBuilder = userRequest.newBuilder();

    ...

    if (userRequest.header("Host") == null) {
      requestBuilder.header("Host", hostHeader(userRequest.url(), false));
    }

    if (userRequest.header("Connection") == null) {
      requestBuilder.header("Connection", "Keep-Alive");
    }

    ...
  
    Response networkResponse = chain.proceed(requestBuilder.build());

    ...

    if (transparentGzip
        && "gzip".equalsIgnoreCase(networkResponse.header("Content-Encoding"))
        && HttpHeaders.hasBody(networkResponse)) {
      GzipSource responseBody = new GzipSource(networkResponse.body().source());
      Headers strippedHeaders = networkResponse.headers().newBuilder()
          .removeAll("Content-Encoding")
          .removeAll("Content-Length")
          .build();
      responseBuilder.headers(strippedHeaders);
      String contentType = networkResponse.header("Content-Type");
      responseBuilder.body(new RealResponseBody(contentType, -1L, Okio.buffer(responseBody)));
    }

    return responseBuilder.build();
  }

这里并没有贴上整个方法的代码,省略了部分,主要的操作就是为发起的Request请求添加请求头信息,其中同样也调用了proceed()方法递归调用下个拦截器,最后面是针对经过gzip压缩过的Response进行解压处理,这里通过判断是否支持gzip压缩且请求头里面的"Content-Encoding"的value是否是"gzip"来判断是否需要进行gzip解压。

总结:

  1. 负责将用户构建的Request请求转化为能够进行网络访问的请求;
  2. 将这个符合网络请求的Request进行网络请求;
  3. 将网络请求回来的的相应Response转化为用户可用的Response

下一篇将为大家介绍OkHttp的缓存机制,感兴趣的朋友可以继续阅读:

OkHttpClient源码分析(三)—— 缓存机制介绍

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

推荐阅读更多精彩内容