OkHttp3源码分析

OkHttp3的使用

1、创建OkHttpClient;
2、创建Request请求对象;
3、OkHttpClient对象调用newCall()并传入Request请求对象,得到Call对象;
4、通过Call对象发起同步请求execute(),或者异步请求enqueue();

OkHttp3的使用


源码分析


完整流程图

大致流程

1、使用Call对象对请求进行封装;
2、dispatch对请求进行分发;
3、getResponseWithInterceptorChain()通过拦截器进行网络请求;

如何创建Call对象?
通过newCall()方法来创建Call对象,而newCall()方法又会调用RealCall()构造方法,所以同步请求execute()和异步请求enqueue()的具体实现都是在RealCall实现类中。

RealCall的execute()和enqueue()方法:
通过源码可以看到,execute()具体调用了client.dispatcher().executed()方法,而enqueue()具体调用了client.dispatcher().enqueue()方法,所以最终是由Dispatcher类来实际执行同步和异步请求操作的。  

RealCall的execute()
RealCall的enqueue()

Dispatcher

Dispatcher作为一个任务的中转站,封装了同步请求和异步请求的任务调度。

Dispatcher维护了几个重要的变量:
/** 最大并发请求数 */
private int maxRequests = 64;
/** 每个主机的最大请求数 */
private int maxRequestsPerHost = 5;
/** 异步请求的线程池 */
private ExecutorService executorService;
/** 将要运行的异步请求队列 */
private final Deque<AsyncCall> readyAsyncCalls = new ArrayDeque<>();
/** 正在运行的异步请求队列 */
private final Deque<AsyncCall> runningAsyncCalls = new ArrayDeque<>();
/** 正在运行的同步请求队列 */
private final Deque<RealCall> runningSyncCalls = new ArrayDeque<>();

Dispatcher中的变量
异步请求的线程池

Dispatcher中的executed()方法和enqueue()方法:

在executed()方法中直接把RealCall对象添加到正在运行的同步请求队列runningSyncCalls中;
在enqueue()方法中先判断正在运行的异步请求队列中的数量是否小于64且请求主机数小于5,如果都满足了则把AsyncCall对象添加到正在运行的异步请求队列runningAsyncCalls中,AsyncCall本质上是一个Runnable对象;如果两个条件有一个不满足,则把AsyncCall对象添加到将要运行的异步请求队列readyAsyncCalls中。

注意:同步请求传入的是RealCall对象,而异步请求传入的是AsyncCall对象。

Dispatcher的executed()
Dispatcher的enqueue()

Dispatcher中的finished()方法:

无论是在同步请求方法还是异步请求方法中,最终都会在finally代码块中调用client.dispatcher().finished()方法,该方法有两个对外重载方法,根据传入的Call对象执行不同的finished()方法,同步请求传入的是RealCall对象, 异步请求传入的是AsyncCall对象,而且异步请求的finished()还会调用promoteCalls()方法。

finished()的具体逻辑:通过队列的remove()方法,把当前的Call对象从正在运行的队列中移除;如果是异步请求,则会调用promoteCalls()方法,该方法的主要逻辑是从将要运行的异步请求队列readyAsyncCalls中取出下一个请求,加入正在运行的异步请求队列runningAsyncCalls中,并交给线程池执行。

清除队列
Dispatcher的finished()
Dispatcher的promoteCalls()

getResponseWithInterceptorChain()

OkHttp中真正执行网络请求的是getResponseWithInterceptorChain()方法,该方法有一系列拦截器构成,返回Response对象。该方法主要创建一系列的拦截器,并将其放入一个list中,包括应用程序拦截器(用户自定义拦截器)、内置五种拦截器和网络拦截器,通过list创建一个拦截器链RealInterceptorChain,并执行链中的proceed()方法依次去调用每一个拦截器的intercept()方法(拦截器的所有逻辑都在intercept()方法中)。

OkHttp内置的五种拦截器:
(1)RetryAndFollowUpInterceptor
(2)BridgeInterceptor
(3)CacheInterceptor
(4)ConnectInterceptor
(5)CallServerInterceptor

getResponseWithInterceptorChain()

RetryAndFollowUpInterceptor

重定向拦截器:当网络请求失败时,会尝试重新进行网络连接,但是尝试次数不超过20次。其中还会创建一个非常重要的StreamAllocation对象,该对象是用来建立Http请求所需要的所有网络组件,StreamAllocation对象最终会传递到ConnectInterceptor拦截器中起作用。重定向拦截器主要的操作:
(1)创建StreamAllocation对象;
(2)调用RealInterceptorChain.proceed()方法进行网络请求;
(3)根绝异常结果或者响应结果判断是否要重新进行网络请求;
(4)调用下一个拦截器,对response进行处理,并把处理结果返回给上一个拦截器;

BridgeInterceptor

桥接拦截器:会对Request请求对象添加必要的请求头部信息,其中Connection默认为Keep-Alive。同时还支持Gzip透明压缩,Accept-Encoding默认为gzip,表明客户端接受gzip的数据,此时如果服务端返回的响应头的Content-Encoding为gzip,表明响应的数据是经过gzip压缩过的数据,那么OkHttp会通过GzipSource对象自动对响应数据进行解码操作。桥接拦截器主要的操作:
(1)负责将用户构建的Request请求对象转化为能够进行网络请求的对象(添加必要的头部信息);
(2)调用RealInterceptorChain.proceed()方法进行网络请求;
(3)将网络请求响应Response转化为用户可用的Response对象(涉及Gzip的解码);

CacheInterceptor

缓存拦截器:实现请求数据和响应数据的缓存;CacheInterceptor主要有CacheStrategy缓存策略,该类主要用于判断是从网络请求数据还是从缓存中获取数据。

Cache类主要实现缓存数据读取与写入:
主要缓存逻辑在Cache类中定义,Cache类提供put()方法把响应数据(响应头部信息)缓存到磁盘中,默认使用DiskLruCache文件缓存,而且只缓存GET响应的数据,缓存数据被封装成Entry对象,Entry对象主要包含Response的头部信息,并提供writeTo()方法把缓存数据通过DiskLruCache写入磁盘中;Cache类提供get()方法获取缓存的响应数据。

ConnectInterceptor  

网络连接拦截器:开启OkHttp的网络请求;主要使用了RetryAndFollowUpInterceptor传递过来的StreamAllocation对象,通过StreamAllocation对象获取HttpCodec对象和RealConnection对象,HttpCodec主要用于编码Request请求对象和解码Response响应对象,RealConnection主要用来进行实际的网络IO数据传输。网络连接拦截器主要的操作: 
(1)获取重定向拦截器传递过来的StreamAllocation对象,并获取HttpCodec对象和RealConnection对象;
(2)把HttpCodec对象和RealConnection对象传递给下一个拦截器;

连接池的复用主要发生在StreamAllocation类中的findConnection()方法:
(1)首先会尝试获取已经分配好的Connection,如果可以复用就直接复用;
(2)如果不能复用则从连接池ConnectionPool中获取新的Connection,并把新的Connection加入连接池中;
(3)调用Connection的connect()方法执行网络连接(TCP + TLS握手连接);

CallServerInterceptor

请求服务拦截器主要有两个作用,发起真正的网络连接请求以及接受服务器返回的响应数据;将Http请求写到网络的IO流中,也可以从网络IO流中读取服务端返回给客户端的响应数据。主要调用了上一个拦截器传递的HttpCodec对象的writeRequestHeaders()方法把Request请求写入到Socket中,再通过HttpCodec对象的readResponseHeaders()方法读取Response响应头信息,最后读取响应数据的body信息并构建一个Response对象。

OkHttp的连接池

ConnectionPool是OkHttp中的连接池,维护了一个Connection连接,RealConnection是Connection的具体实现类。主要对外提供get()和put()方法来对RealConnection队列集合进行操作,从而获取连接和设置连接。连接池的清理工作主要使用标记——清除算法。


参考

《Android进阶之光》 第5章 网络编程与网络框架

推荐阅读

拆轮子系列:拆 OkHttp
okhttp源码解析
聊聊HTTP gzip压缩与常见的Android网络框架

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

推荐阅读更多精彩内容

  • 在OkHttp3中,其灵活性很大程度上体现在可以 intercept 其任意一个环节,而这个优势便是okhttp3...
    Jdqm阅读 40,528评论 7 71
  • 看了有一段时间的OkHttp3的源码了。今天动笔开始写一写,本篇文章只是简单的写一下OkHttp3的一个过程。(以...
    lonamessi阅读 599评论 0 1
  • “小小情怀 丰思掩埋……” 罢了罢了 丢失的诺言 原本不存在 让清风依旧 去掉双眼 去掉泪光 无处寻找 消失的光年...
    那时花开MRR阅读 240评论 1 0
  • 1他是一个很干净明朗的男生,衣服鞋子不多但很精致,穿着都很帅气。 2他的头发怎么理都帅,光头也帅,真的很神奇,大概...
    火星小喵阅读 434评论 0 0
  • 扔下一枚影子, 一些故事就在, 陈年旧酿里 回旋。 打捞起来的那只布谷鸟, 竟已失声很多年。 还有什么是你留下的?...
    月与书阅读 404评论 2 9