OkHttp解析从入门到精通-从使用到原理

一、基本介绍

OkHttp是当下Android使用最频繁的网络请求框架，由Square公司开源。Google在Android4.4以后开始将源码中的HttpURLConnection底层实现替换为OKHttp，同时现在流行的Retrofit框架底层同样是使用OKHttp的。

优点:

• 支持HTTP/2并允许对同一主机的所有请求共享一个套接字
• 通过连接池减少请求延迟
• 默认通过GZip压缩数据
• 响应缓存，避免了重复请求的网络
• 请求失败自动重试主机的其他ip，自动重定向

带中文注释的OkHttp源码

二、基本使用

1. 创建okhttp客户端，即OkhttpClient；
2. 构建请求对象，即Request；
3. 使用okhttp客户端将请求对象放到请求队列中；

String url = "http://wwww.baidu.com";
OkHttpClient okHttpClient = new OkHttpClient();
final Request request = new Request.Builder()
        .url(url)
        .get()//默认就是GET请求，可以不写
        .build();
Call call = okHttpClient.newCall(request);
call.enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        Log.d(TAG, "onFailure: ");
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        Log.d(TAG, "onResponse: " + response.body().string());
    }
});

三、工作流程

工作流程如下图所示

1. 创建okhttp客户端/OkhttpClient；
2. 构建请求/Request；
3. 将请求加入队列中并执行；
4. 分发器/Dispatcher 进行任务调配和分发；
5. 五大拦截器对请求进行一步步处理；
6. 返回Response结果；

i.分发器

分发器：负责请求调配和分发，内部包含一个线程池和三个队列，也可以传入自己的线程池。

1. 线程池和队列的数据结构

//异步请求同时存在的最大请求
private int maxRequests = 64;
//异步请求同一域名同时存在的最大请求
private int maxRequestsPerHost = 5;
//闲置任务(没有请求时可执行一些任务，由使用者设置)
private @Nullable Runnable idleCallback;
// 异步请求的 准备队列
 private final Deque readyAsyncCalls = new ArrayDeque<>();
// 异步请求的 运行队列
private final Deque runningAsyncCalls = new ArrayDeque<>();
// 同步请求的队列
private final Deque runningSyncCalls = new ArrayDeque<>();

2. 默认线程池的定义：创建0个核心线程，最大数量不限的线程池，线程缓存60s，此种方式是为了满足最大并发

public synchronized ExecutorService executorService() {
    if (executorService == null) {
      // 0 个核心线程，最大线程数 为 21 亿即不限量，缓存 60s
      // SynchronousQueue 为不限制大小的阻塞队列
      executorService = new ThreadPoolExecutor(0, Integer.MAX_VALUE, 60, TimeUnit.SECONDS,
          new SynchronousQueue(), Util.threadFactory("OkHttp Dispatcher", false));
    }
    return executorService;
  }

• 线程池的目的是复用线程
• 此处选择0个核心线程的原因是 核心线程会一直运行，而我们的请求有时候可能会没有，如果我们在一段时间内没有请求，此时如果有线程在运行，是一种资源的浪费，所以此处核心线程数为0
• 此处不限制最大线程池，满足最大需要
• SynchronousQueue的选择：SynchronousQueue是一种没有容量的阻塞队列，阻塞队列的另外两种ArrayBlockingQueue和LinkedBlockingQueue会有容量，如果队列有容量，那么新来的任务会先放到队列中，等上一个任务执行完再执行队列中的任务。队列没有容量，则任务放不进去后，便会直接创建线程去执行。

3. 异步请求的入队及执行

• 先进行条件判断，如果正在请求的数量少于64个 并且 对同一台服务器的请求少于5个时，直接执行任务并将任务加入异步运行队列，否则加入异步准备队列中

synchronized void enqueue(AsyncCall call) {
    // todo 1. 正在请求的数量是有限制的 默认64
    // 2. 同一主机同一域名正在请求的个数也是有限制的，与同一台服务器进行的请求最多为5个
    if (runningAsyncCalls.size() < maxRequests && runningCallsForHost(call) < maxRequestsPerHost) {
      runningAsyncCalls.add(call);
      executorService().execute(call);
    } else {
      readyAsyncCalls.add(call);
    }
  }

ii.拦截器

拦截器的控制工作在RealCall的getResponseWithInterceptorChain方法中，五大拦截器均实现了Interceptor方法。

1. 五大拦截器

• 重试拦截器：在交出（交给下一个）之前，负责判断用户是否取消了请求，在获得了结果之后，会根据响应码判断是否需要重定向，如果满足条件那么就会重启执行所有拦截器
• 桥接拦截器：在交出之前，负责将HTTP协议必备的请求头加入其中（如：Host）并添加一些默认的行为（如：GZIP压缩）；在获得了结果后，调用保存cookie接口并解析GZIP数据
• 缓存拦截器：顾名思义，交出之前读取并判断是否使用缓存；获得结果后判断缓存；
• 连接拦截器：在交出之前，负责找到或者新建一个连接，并获得对应的socket流，在获得结果后不进行额外的处理
• 请求拦截器：请求服务器拦截器进行真正的与服务器的通信，向服务器发送数据，解析读取的响应数据

2. 拦截器类图和流程图

• 类图：Interceptor是一个抽象接口，五大拦截器均实现了Interceptor接口
  
• 五大拦截器的实现采用了责任链模式，处理顺序依次是重试和重定向拦截器、桥接拦截器、缓存拦截器、连接拦截器和请求服务拦截器
  
• 责任链模式：为请求创建了一个接收者对象的链，在处理请求的时候执行过滤（各司其职）。责任链上的处理者负责处理请求，客户只需要将请求发送到责任链即可，无须关心请求的处理细节和请求的传递，所以职责链将请求的发送者和请求的处理者解偶了

重试和重定向拦截器

1. 重试的判定

• 可重试的情况：路由异常、IO异常、超时异常
• 不可重试的情况：协议异常、证书格式错误、证书校验失败

3. 重定向的判定

响应码	说明	重定向条件
407	代理需要授权，如付费代理，需要验证身份	通过proxyAuthenticator获 得到了Request。 例: 添加 Proxy-Authorization 请求头
401	服务器需要授权，如某些接口需要登陆才能使用 (不安全，基本上没用了)	通过authenticator获得到了Request。 例: 添加 Authorization 请求头
300、301、302、303、307、308	重定向响应	307与308必须为GET/HEAD请求再继续判断 1、用户允许自动重定向(默认允许) 2、能够获得 Location 响应头，并且值为有效url 3、如果重定向需要由HTTP到https间切换，需要允许(默认允许)
408	请求超时。服务器觉得你太慢了	1、用户允许自动重试(默认允许) 2、本次请求的结果不是 响应408的重试结果 3、服务器未响应Retry-After(稍后重试),或者响应Retry-After: 0。
503	服务不可用	1、本次请求的结果不是 响应503的重试结果 2、服务器明确响应 Retry-After: 0，立即重试

桥接拦截器

1. 补全请求

请求头	说明
Content-Type	请求体类型，如：application/x-www-form-urlencoded
Content-Length/Transfer-Encoding	请求体解析方式
Host	请求的主机站点
Connection: Keep-Alive	默认保持长连接
Accept-Encoding: gzip	接收响应体使用gzip压缩
Cookie	Cookie身份识别
User-Agent	用户信息，如：操作系统、浏览器等

3. 处理响应

• 读取Set-Cookie响应头并调用接口告知用户，在下次请求则会读取对应的数据设置进入请求头，默认CookieJar无实现；
• 响应头Content-Encoding为gzip，使用GzipSource包装便于解析。

缓存拦截器(重)

1. 缓存命中判定

• 缓存策略：拦截器通过CacheStrategy判断使用缓存或发起网络请求。此对象中的networkRequest与cacheResponse分别代表需要发起请求或者直接使用缓存

networkRequest	cacheResponse	说明
Null	Not Null	直接使用缓存
Not Null	Null	向服务器发起请求
Null	Null	okhttp直接返回504
Not Null	Not Null	发起请求，若得到响应为304(无修改)，则更新缓存响应并返回

即：networkRequest存在则优先发起网络请求，否则使用cacheResponse缓存，若都不存在则请求失败！
2. 是否缓存判定

3. 面试描述：缓存拦截器，就是判断是否使用缓存，首先缓存要存在，同时要满足http缓存规则和机制，要在有效期内，不在有效期内，和服务器做对比，如果服务器缓存仍然不变，则更新本地缓存有效期，这就是缓存拦截器。

连接拦截器(重)

1. 连接流程
   
2. 连接池
   
3. 正常连接
4. 代理连接

• socks代理：创建socket时，直接将代理传入
• http普通代理：将请求的域名+路径放到请求头中，无代理时只有路径没有域名
• https隧道代理：先向目标服务器发送一个 connect，然后再正常发送
  

请求服务拦截器

1. HTTP报文格式：先把请求头包装成报文格式/流写出去
2. Expect: 100-continue：如果请求头中包含"100-continue"，则立即读取服务器的响应头，如果请求头不包含"100-continue"，则继续发送请求体

高级使用

1. 传入自己的线程池
2. 配置代理、定义代理权限
3. 自定义连接池