OkHttp 精讲:RetryAndFollowUpInterceptor

  • 本文章所使用的 OkHttp 源码版本:3.12.10

上一篇:OkHttp 精讲:拦截器执行原理

源码解析

  • 那么问题来了,一个拦截器的源码那么多,我们该从何入手呢?
  • 我们可以看到拦截器所实现的一个 Interceptor 接口,里面只有一个 intercept 方法,那么我们就从这个方法开始入手
  • 一眼望去,最吸引我们眼球的,莫属这个 while 循环,因为我们之前讲过,拦截器执行原理就是使用了递归,现在怎么还在递归里面使用循环了呢?到底是在做什么骚操作?
  • 在这里我们可以看到,当前拦截器将请求通过拦截链传递给下一个拦截器
  • 有意思的地方是,在这个传递过程中,有两个 catch 块,这两个 catch 块的结果都是要么抛出异常,要么继续循环
  • 那么什么情况下会抛异常呢?我们可以通过源码看出,它是通过调用 recover 方法来决定是否抛出异常,接下来让我们看看这个方法是干什么用的
  • 看完这个方法,我相信大多数人的反应跟我第一次看的时候一样,还是没看懂这个方法有什么用

  • 看不懂源码不要紧,可以看源码上面的注释,但注释是英文的也是看不懂该怎么办?可以翻译成中文再看。有一句老话说得好,只要思想不滑坡,方法总比困难多。阻挡我们前进的不是困难本身,而是我们内心的恐惧,而唯一的方法就是战胜它

  • 通过这些注释,我们可以得出,这个方法用于判断请求是否还能被恢复,如果可以的话就进行重新请求,如果不行就直接抛出异常给上层

  • 这个便是 OkHttp 重试机制,如果错误不是致命的,就对请求进行重试,正如这个拦截器的名字一样, RetryAndFollowUpInterceptor,Retry 是重试的意思,And 是和的意思,那么 FollowUp 是什么意思?

  • 光靠这个单词的意思我们并不能得出答案,接下来我们将通过剩余的源码来揭晓答案
  • 这个方法看着很可疑,看名字跟我们想知道的 followUp 作用有很大关系,让我们先进去这个方法里面看看
  • 看完的第一个感觉还是懵,不过还是用老方法来解决这个问题
  • 处理客户端超时大家都懂,这里不再做过多解释,但是重定向,这个专业术语可能对于做 App 开发的人来说还是很陌生,在这里我给大家举个栗子,大家可以打开这个链接:http://www.baidu.com,然后再仔细瞅瞅网址变了没?

  • 没错,我们明明输入的是 http://www.baidu.com,但是却跳转到 https://www.baidu.com 上了

  • 如果你听不懂我想表达什么,那么说明这个栗子还是不够生动形象,我再举一个栗子

  • 大家可以打开这个链接:https://www.xiaomi.com,是不是就变成了 https://www.mi.com ?

  • 这种功能就叫做请求重定向,属于 Http 协议的内容

  • 如果你看完了整个 OkHttp 的源码,其实不难发现,如果对 Http 协议不够了解,很多源码基本没办法看懂

  • 那么我们又该如何了解 Http 协议呢?

  • 让我们回顾一下 Http 的组成部分,Http 报文大致分为两种:请求报文和响应报文,分别对应着 OkHttp 中的 Request 和 Response 类,其中请求报文内容大致分为请求头、Body(文件流),响应报文内容大致分为响应头、响应码、Body(文件流)

  • 请求的 Body 就是我们传入的表单参数或者文件流,而响应的 Body 就是后台返回给我们的文本或者文件流,这块属于业务,和 Http 协议并无太大关系,在这里我们先简单了解一下请求头、响应头、响应码,在这里我们可以参考以下这两个对照表

    • HTTP响应头和请求头信息对照表

    • HTTP状态码对照表

  • 关于请求重定向这块的源码,必须要对响应码的有一定的了解,所以我们先简单回顾一下响应码的区间和类型

    • 100-199:请求处理中

    • 200-299:请求被接受(例如:200 请求成功)

    • 300-399:请求被重定向(例如:307 地址重定向)

    • 400-499:客户端请求参数错误(例如:403 请求被拒绝,404 请求地址不存在)

    • 500-599:服务器解析请求发生错误(例如:500 服务器出错,503 接口出错)

  • 我们可以得出,请求重定向的响应码区间在 300-399,那么我们只看这个区间响应码的源码

  • 这段代码是什么意思,我相信大部分人都不能理解,这块的响应码是 307 和 308,那么让我们回顾一下刚刚看过的响应码表,看看这个 307 到底是什么意思?
状态码 含义
307 请求的资源现在临时从不同的 URI 响应请求。由于这样的重定向是临时的,客户端应当继续向原有地址发送以后的请求。只有在 Cache-Control 或 Expires 中进行了指定的情况下,这个响应才是可缓存的。新的临时性的URI 应当在响应的 Location 域中返回。除非这是一个 HEAD 请求,否则响应的实体中应当包含指向新的URI 的超链接及简短说明。因为部分浏览器不能识别307响应,因此需要添加上述必要信息以便用户能够理解并向新的 URI 发出访问请求。如果这不是一个 GET 或者 HEAD 请求,那么浏览器禁止自动进行重定向,除非得到用户的确认,因为请求的条件可能因此发生变化。
  • 敲黑板,划重点:如果这不是一个 GET 或者 HEAD 请求,那么浏览器禁止自动进行重定向

  • 意思很明显了,如果服务器返回 307 或 308,那么如果当前的请求方式不是 GET 或 HEAD,那么本次的重定向请求就会被客户端拒绝

  • 在这里我们默认它就是符合要求的,然后我们接着往下面看

  • 这里解释一下 switch 语法,如果 case 块中没有 break 或 return,那么它就会往下一个 case 块执行,直到下一个 case 块中有 break 或 return 才会跳出整个 switch。
  • 会先判断我们在 OkHttpClient 有没有禁止重定向,有的话也会直接拒绝本次的重定向请求
  • 这个是啥?我相信大多数人看完都愣了一下,那么这个 Location 的响应头到底是什么呢?接下来让我们回顾一下刚刚看过的请求头和响应头对照表
名称 说明 示例
Location 用来重定向接收方到非请求URL的位置来完成请求或标识新的资源 Location: https://www.jianshu.com/u/f7bb67d86765
  • 如果说你还是不能理解,那只能建议你打开:http://www.baidu.com

  • 目的不是让你百度一下,而是先在一个空网页上打开浏览器的开发者选项,然后再打开这个网址

  • 看到这里,我相信大家都应该明白了,既然是重定向,唯一不能少的就是重定向的地址
  • 重新对请求头进行封装,然后返回给拦截器

源码总结

  • RetryAndFollowUpInterceptor 主要作用有两个:重试和重定向

  • 重试则是 OkHttp 自身的机制,如果请求失败了,那么会在这上面会判断这个错误是不是致命,如果不是的话就会对请求进行重试,否则就会抛出异常给上层。

  • 重定向则是 Http 协议的一部分内容,OkHttp 选择将这一部分的逻辑放置到这个拦截器中,当服务器返回 3 开头的响应码时,会先判断当前是否禁用了请求重定向,有的话就不进行重定向,如果没有的话就会从响应头中取 Location 字段的值作为重定向地址,然后将这个地址重新封装到 Request 对象中,最后将新的 Request 对象返回给上层进行重新请求。

  • 无论是重试还是重定向,它们都有一个共同的特点,都可以进行重新请求,所以它们才会被放在同一个拦截器中。

下一篇:OkHttp 精讲:BridgeInterceptor

Android 技术讨论 Q 群:10047167

你可能感兴趣的:(OkHttp 精讲:RetryAndFollowUpInterceptor)