OkHttp3的使用
1、创建OkHttpClient;
2、创建Request请求对象;
3、OkHttpClient对象调用newCall()并传入Request请求对象,得到Call对象;
4、通过Call对象发起同步请求execute(),或者异步请求enqueue();
源码分析
大致流程
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类来实际执行同步和异步请求操作的。
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中的executed()方法和enqueue()方法:
在executed()方法中直接把RealCall对象添加到正在运行的同步请求队列runningSyncCalls中;
在enqueue()方法中先判断正在运行的异步请求队列中的数量是否小于64且请求主机数小于5,如果都满足了则把AsyncCall对象添加到正在运行的异步请求队列runningAsyncCalls中,AsyncCall本质上是一个Runnable对象;如果两个条件有一个不满足,则把AsyncCall对象添加到将要运行的异步请求队列readyAsyncCalls中。注意:同步请求传入的是RealCall对象,而异步请求传入的是AsyncCall对象。
Dispatcher中的finished()方法:
无论是在同步请求方法还是异步请求方法中,最终都会在finally代码块中调用client.dispatcher().finished()方法,该方法有两个对外重载方法,根据传入的Call对象执行不同的finished()方法,同步请求传入的是RealCall对象, 异步请求传入的是AsyncCall对象,而且异步请求的finished()还会调用promoteCalls()方法。
finished()的具体逻辑:通过队列的remove()方法,把当前的Call对象从正在运行的队列中移除;如果是异步请求,则会调用promoteCalls()方法,该方法的主要逻辑是从将要运行的异步请求队列readyAsyncCalls中取出下一个请求,加入正在运行的异步请求队列runningAsyncCalls中,并交给线程池执行。
getResponseWithInterceptorChain()
OkHttp中真正执行网络请求的是getResponseWithInterceptorChain()方法,该方法有一系列拦截器构成,返回Response对象。该方法主要创建一系列的拦截器,并将其放入一个list中,包括应用程序拦截器(用户自定义拦截器)、内置五种拦截器和网络拦截器,通过list创建一个拦截器链RealInterceptorChain,并执行链中的proceed()方法依次去调用每一个拦截器的intercept()方法(拦截器的所有逻辑都在intercept()方法中)。
OkHttp内置的五种拦截器:
(1)RetryAndFollowUpInterceptor
(2)BridgeInterceptor
(3)CacheInterceptor
(4)ConnectInterceptor
(5)CallServerInterceptor
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章 网络编程与网络框架