okhttp是Square Open Source的一个高效的轻量级网络访问框架。
okhttp有哪些特点呢?
- 支持HTTP/2,允许同一主机的所有请求共用同一个连接
- 使用连接池技术,避免请求重复建立连接,从而减少请求延迟
- 默认使用GZIP,减小网络传输数据大小,节省带宽
- 友好的缓存技术,避免重复的网络请求
- 提供强大的拦截器机制(Application Interceptors 和 Network Interceptors),方便使用者对请求进行监控、重写、重试等操作
- 支持同步/异步请求
- ......
下面介绍一下框架的使用方法及一些配置的解析:
一、使用方法
1、依赖
// AS引用方式:在模块的build.gradle中添加对okhttp的依赖
dependencies {
......
implementation 'com.squareup.okhttp3:okhttp:+'
......
}
2、创建请求对象,发起网络请求
建议在同一个进程中只创建一个OkHttpClient 实例,因为每一个 OkHttpClient 实例都拥有自己的连接池和线程池,重用这些资源可以减少延时和节省资源。
OkHttpClient okhttpClient = new OkHttpClient.Builder()
/*Sets the dispatcher used to set policy and execute asynchronous requests. Must not be null.*/
.dispatcher(Dispatcher)
/*Sets the connection pool used to recycle HTTP and HTTPS connections.
*If unset, a new connection pool will be used.*/
.connectionPool(ConnectionPool)
/*Add the Application Interceptors.*/
.addInterceptor(Interceptor)
/*Add the Network Interceptors.*/
.addNetworkInterceptor(Interceptor)
/*Sets the response cache to be used to read and write cached responses.*/
.cache()
.build();
/*创建请求对象*/
Request request = new Request.Builder()
.url(url)
.get()//默认就是GET请求,可以不写
.build();
/*创建Call对象*/
Call call = okHttpClient.newCall(request);
/*发起异步请求*/
call.enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
// TODO:对请求失败进行处理
}
@Override
public void onResponse(Call call, Response response) throws IOException {
// TODO:对请求成功进行处理
Log.d(TAG, "Response body : " + response.body().string());
}
});
/*发起同步请求, 需要在线程中执行*/
// call.execute()
二、解析
1、Dispatcher(请求调度/分发器)
Dispatcher是一个请求调度器,它里面维护了三个Deque(双向队列),readyAsyncCalls(准备执行的异步请求队列)、runningAsyncCalls(正在运行的异步请求队列)、runningSyncCalls(正在运行的同步请求队列)。
此外Dispatcher中还创建了一个线程池,主要用来缓存线程,便于复用,对于请求的执行和并发限制则由调度器来控制的。下面看一下Dispatcher中的调度策略:maxRequests用来控制最大并发数量,默认值64;maxRequestsPerHost控制了单个主机的最大请求数量,默认值5.
2、ConnectionPool (连接池)
ConnectionPool连接池在OkhttpClient对象初始化时被创建,用来管理所有建立的连接,比如连接复用、无用连接清理等。
- get connection
@Nullable
RealConnection get(Address address, StreamAllocation streamAllocation, Route route) {
assert (Thread.holdsLock(this));
for (RealConnection connection : connections) {
// 判断连接是否可用
if (connection.isEligible(address, route)) {
// 标记Connection
streamAllocation.acquire(connection, true);
return connection;
}
}
return null;
}
-
put connection
该方法会在程序第一次调用时启动一个清理线程。清理线程会在当前ConnectionPool为空时销毁。
void put(RealConnection connection) {
assert (Thread.holdsLock(this));
if (!cleanupRunning) {
cleanupRunning = true;
// 执行连接池清理任务
executor.execute(cleanupRunnable);
}
connections.add(connection);
}
-
cleanup connection
ConnectionPool通过执行一个无限循环的Runnable来完成清理工作:
private final Runnable cleanupRunnable = new Runnable() {
@Override
public void run() {
while (true) {
long waitNanos = cleanup(System.nanoTime());
if (waitNanos == -1) return;
if (waitNanos > 0) {
long waitMillis = waitNanos / 1000000L;
waitNanos -= (waitMillis * 1000000L);
synchronized (ConnectionPool.this) {
try {
ConnectionPool.this.wait(waitMillis, (int) waitNanos);
} catch (InterruptedException ignored) { }
}
}
}
}
};
3、Interceptor (拦截器)
拦截器是okhttp中的一个重要的机制,所有拦截器顺序执行
(1)Application Interceptions:
- 一次请求中只能调用一次,不能对重定向及重试做操作
- 只能对原始的Request和最终的Response做操作
- 可用使用本地缓存直接返回Response而不调用chain.proceed()
(2)Network Interceptions:
- 能够对重定向和重试等中间响应进行操作
- 可以获取Connection中携带的请求信息,通过(chain.connection())
- 不能够使用缓存,必须调用chain.proceed(),通过请求服务器的方式获取Response
4、Catch(缓存)
(1)缓存的作用
- 减少不必要的服务器请求从而减轻服务器压力
- 更快的响应速度给用户带来更好的体验
- 离线展示
(2)okhttp中是如何使用缓存的呢?
okhttp通过CacheControl类指定缓存的规则,使用CacheStrategy缓存策略类来判断是否使用缓存;Cache和InternalCache类提供了对缓存的增删改查接口,使用DiskLruCache来对缓存文件进行管理。缓存使用策略:
- 缓存响应为空,则不使用Cache
- https缓存响应无握手信息,则不使用Cache
- 请求为nocache或者包含If-Modified-Since或If-None-Match,则不使用Cache
- cache是否在有效期内,判断是否使用缓存