一步步带你读懂 Okhttp 源码(1)


okHttp, square 公司开源的网络请求神器,截止到 2019-09-02,在 Github 上面已经超过 34K 的 star,足见他的受欢迎程度。

到目前为止,他的最新版本是 4.1.0, 使用 kotlin 语言写的,由于本人对 kotlin 语言不是很熟悉,这篇文章已 3.5.0 的版本为基础进行分析。

简介


Rxjava+Okhttp+Refrofit 如今已经成为项目网络请求的首选,在讲解原理之前,我们先来看一下 Okhttp 的基本使用。

使用 OkHttp 基本是以下四步:

  1. 创建 OkHttpClient 对象

  2. 创建Request请求对象

  3. 创建Call对象

  4. 同步请求调用call.execute();异步请求调用call.enqueue(callback)

同步执行

//创建OkHttpClient对象

OkHttpClient client = new OkHttpClient();

String run(String url) throws IOException {

//创建Request请求对象

Request request = new Request.Builder()

.url(url)

.build();

//创建Call对象,并执行同步获取网络数据

Response response = client.newCall(request).execute();

return response.body().string();

}

异步执行

void runAsync(String url, Callback callback) {

OkHttpClient client = new OkHttpClient.Builder().addInterceptor(new Interceptor() {

@Override

public Response intercept(Chain chain) throws IOException {

Request request = chain.request();

Request.Builder builder = request.newBuilder().addHeader(“name”, “test”);

return chain.proceed(builder.build());

}

}).build();

//创建Request请求对象

Request request = new Request.Builder()

.url(url)

.build();

client.newCall(request).enqueue(callback);

}

接下来我会从这四步,分析 Okhttp 的基本原理。

OkHttpClient


创建 OkHttpClient 一般有两种方法,一种是直接 new OkHttpClient(),另外一种是通过 OkHttpClient.Builder()

OkhttpClient client = new OkHttpClient

.Builder()

.connectTimeout(5, TimeUnit.SECONDS)

.writeTimeout(10,TimeUnit.SECONDS)

.readTimeout(10, TimeUnit.SECONDS)

.build();

第二种创建方式主要是通过建造者模式,来配置一些参数,比如连接超时时间,读写超时时间,超时重试次数等。这样有一个好处,可以对外屏蔽掉构建 client 的细节。关于建造者模式的,有兴趣的可以读我的这一篇文章建造者模式(Builder)及其应用

Request


public final class Request {

final HttpUrl url;

final String method;

final Headers headers;

final RequestBody body;

final Object tag;

private volatile CacheControl cacheControl; // Lazily initialized.

}

Request 对象主要封装的是一些网络请求的信息,比如请求 url,请求方法,请求头,请求 body 等,也比较简单,这里不再展开阐述。

Call 对象


@Override public Call newCall(Request request) {

return new RealCall(this, request, false /* for web socket */);

}

可以看到 call 对象实际是 RealCall 的实例化对象

RealCall#execute()

@Override public Response execute() throws IOException {

synchronized (this) {

if (executed) throw new IllegalStateException(“Already Executed”);

executed = true;

}

captureCallStackTrace();

try {

// 执行 client.dispatcher() 的 executed 方法

client.dispatcher().executed(this);

Response result = getResponseWithInterceptorChain();

if (result == null) throw new IOException(“Canceled”);

return result;

} finally {

// 最后再执行 dispatcher 的 finish 方法

client.dispatcher().finished(this);

}

}

在 execute 方法中,首先会调用 client.dispatcher().executed(this) 加入到 runningAsyncCalls 队列当中,接着执行 getResponseWithInterceptorChain() 获取请求结果,最终再执行 client.dispatcher().finished(this) 将 realCall 从 runningAsyncCalls 队列中移除 。

我们先来看一下 getResponseWithInterceptorChain 方法

Response getResponseWithInterceptorChain() throws IOException {

// Build a full stack of interceptors.

List interceptors = new ArrayList<>();

interceptors.addAll(client.interceptors());

interceptors.add(retryAndFollowUpInterceptor);

interceptors.add(new BridgeInterceptor(client.cookieJar()));

interceptors.add(new CacheInterceptor(client.internalCache()));

interceptors.add(new ConnectInterceptor(client));

if (!forWebSocket) {

interceptors.addAll(client.networkInterceptors());

}

interceptors.add(new CallServerInterceptor(forWebSocket));

Interceptor.Chain chain = new RealInterceptorChain(

interceptors, null, null, null, 0, originalRequest);

return chain.proceed(originalRequest);

}

可以看到,首先,他会将客户端的 interceptors 添加到 list 当中,接着,再添加 okhhttp 里面的 interceptor,然后构建了一个 RealInterceptorChain 对象,并将我们的 List<Interceptor> 作为成员变量,最后调用 RealInterceptorChain 的 proced 方法。

  • client.interceptors() -> 我们自己添加的请求拦截器,通常是做一些添加统一的token之类操作

  • retryAndFollowUpInterceptor -> 主要负责错误重试和请求重定向

  • BridgeInterceptor -> 负责添加网络请求相关的必要的一些请求头,比如Content-Type、Content-Length、Transfer-Encoding、User-Agent等等

  • CacheInterceptor -> 负责处理缓存相关操作

  • ConnectInterceptor -> 负责与服务器进行连接的操作

  • networkInterceptors -> 同样是我们可以添加的拦截器的一种,它与client.interceptors() 不同的是二者拦截的位置不一样。

  • CallServerInterceptor -> 在这个拦截器中才会进行真实的网络请求

Interceptor 里面是怎样实现的,这里我们暂不讨论,接下来,我们来看一下 proceed 方法

proceed 方法

public Response proceed(Request request, StreamAllocation streamAllocation, HttpCodec httpCodec,

Connection connection) throws IOException {

// 省略无关代码

// 生成 list 当中下一个 interceptot 的 chain 对象

RealInterceptorChain next = new RealInterceptorChain(

interceptors, streamAllocation, httpCodec, connection, index + 1, request);

// 当前的 interceptor

Interceptor interceptor = interceptors.get(index);

// 当前的 intercept 处理下一个 intercept 包装的 chain 对象

Response response = interceptor.intercept(next);

// ----

return response;

}

proceed 方法也很简单,proceed方法每次从拦截器列表中取出拦截器,并调用 interceptor.intercept(next)。

熟悉 Okhttp 的应该都在回到,我们在 addInterceptor 创建 Interceptor 实例,最终都会调用 chain.proceed(Request request),从而形成一种链式调用。关于责任链模式的可以看我的这一篇文章 责任链模式以及在 Android 中的应用

OkHttpClient client = new OkHttpClient.Builder().addInterceptor(new Interceptor() {

@Override

public Response intercept(Chain chain) throws IOException {

Request request = chain.request();

Request.Builder builder = request.newBuilder().addHeader(“name”,“test”);

return chain.proceed(builder.build());

}

}).build();

而 OkHttp 是怎样结束循环调用的,这是因为最后一个拦截器 CallServerInterceptor 并没有调用chain.proceed(request),所以能够结束循环调用。

dispatcher


public final class Dispatcher {

private int maxRequests = 64;

private int maxRequestsPerHost = 5;

private Runnable idleCallback;

/** Executes calls. Created lazily. */

private ExecutorService executorService;

// 异步的请求等待队列

private final Deque readyAsyncCalls = new ArrayDeque<>();

// 异步的正在请求的队列

private final Deque runningAsyncCalls = new ArrayDeque<>();

// 绒布的正在请求的队列

private final Deque runningSyncCalls = new ArrayDeque<>();

}

异步请求 enqueue(Callback responseCallback)


@Override public void enqueue(Callback responseCallback) {

synchronized (this) {

if (executed) throw new IllegalStateException(“Already Executed”);

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数初中级Android工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则近万的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

img

img

img

img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Android)

最后

给大家送上我成功跳槽复习中所整理的资料,由于文章篇幅有限,所以只是把题目列出来了

image

image

image

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!

经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!**

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Android)

最后

给大家送上我成功跳槽复习中所整理的资料,由于文章篇幅有限,所以只是把题目列出来了

[外链图片转存中…(img-8cGVp1VQ-1712691129498)]

[外链图片转存中…(img-CHnsRH53-1712691129499)]

[外链图片转存中…(img-GqGWdup9-1712691129499)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值