使用了好久的okhttp叛薯,都沒有對其源碼進行學(xué)習(xí)拆解浑吟,今天開始,有時間就寫一些學(xué)習(xí)筆記耗溜,對okhttp進行分析组力。
基本請求流程
源碼地址:https://github.com/square/okhttp
如何使用的?
以一個 Post同步 請求為例:
OkHttpClient client = new OkHttpClient();
RequestBody body = RequestBody.create(JSON, json);
Request request = new Request.Builder()
.url(url)
.post(body)
.build();
Response response = client.newCall(request).execute());
根據(jù)上面的代碼抖拴,使用okhttp燎字,基本就是四步:
第一步,建立一個OkHttpClient 類阿宅,這個類包含了一系列的協(xié)議路由候衍,攔截器等等,都是后面請求必不可少的變量家夺。(具體解析留在后面)
第二步,創(chuàng)建 RequestBody 伐弹,請求的實體拉馋,可以指定對應(yīng)的contentType ,還有具體是實體內(nèi)容惨好。
第三步煌茴,創(chuàng)建請求,指定url, 還有body日川。Request類使用的是Bulder模式蔓腐,在okhttp里面比較大面積的使用此模式。
第四步龄句,通過第一步的client 調(diào)用 newCall 創(chuàng)建一個Call 回论,然后execute()散罕,發(fā)起一個同步的請求。
如果我們只是使用傀蓉,拿到結(jié)果欧漱,請求就已經(jīng)可以結(jié)束了。但是我們需要了解它的內(nèi)部實現(xiàn)葬燎,現(xiàn)在才剛剛開始误甚。
具體流程:
接下來就是從這個OkHttpClient 的 newCall 還有 execute(),開始向下了剖析谱净。
@Override public Call newCall(Request request) {
return new RealCall(this, request, false /* for web socket */);
}
原來這個Call只是一個接口窑邦,這里真正是創(chuàng)建了一個實現(xiàn)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(this);
Response result = getResponseWithInterceptorChain();
if (result == null) throw new IOException("Canceled");
return result;
} finally {
client.dispatcher().finished(this);
}
}
這個RealCall 里面的執(zhí)行的方法,首先會把這個Call 加入到 dispatcher 這個調(diào)度器里面(Dispatcher這個類也需要好好研究一下浩蓉,主要是Call請求線程相關(guān)的控制)派继。
由于我們分析的是同步請求,這里的dispatcher作用是可以方便對這個Call進行統(tǒng)一控制捻艳,如取消等 驾窟。
接下來就是調(diào)用了 getResponseWithInterceptorChain();
那我們繼續(xù)向下這個方法進發(fā)了:
Response getResponseWithInterceptorChain() throws IOException {
// Build a full stack of interceptors.
List<Interceptor> 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);
}
哇,這里好多這個Interceptor 认轨,意為攔截器的意思绅络。其實就是對將要發(fā)出去的請求,或者接收到的結(jié)果的進行攔截嘁字,然后進行一些需要的修改恩急,然后在做下一步操作。例如在發(fā)出去前纪蜒,添加必要的信息衷恭,或者回來之后把結(jié)果進行統(tǒng)一的處理。
這里把自定義的攔截器纯续,還有內(nèi)置的必要的攔截器都添加到一個List里面了随珠,最后用List的攔截器創(chuàng)建一個攔截器的鏈—— RealInterceptorChain。而這個RealInterceptorChain 其實是實現(xiàn)了Interceptor 里面的一個Chain 接口猬错。
這里最后調(diào)用 chain.proceed(originalRequest); 這里就是返回一個Response 對象了窗看,但是這中間這么多的攔截器,都干了些什么了倦炒? 是如何攔截的显沈?如果連接起來的?帶著問題逢唤,我們繼續(xù)向這里面剖析拉讯。
我們先了解一下RealInterceptorChain 這個類是如何進行工作的涤浇。
首先RealInterceptorChain,是實現(xiàn)了Interceptor.Chain 接口的一個類遂唧,這個接口有是三個方法芙代,后面會介紹到,其中一個就是前面調(diào)用的proceed方法盖彭。
那么在它的 proceed中做了什么纹烹?
@Override
public Response proceed(Request request) throws IOException {
return proceed(request, streamAllocation, httpCodec, connection);
}
public Response proceed(Request request, StreamAllocation streamAllocation, HttpCodec httpCodec,
RealConnection connection) throws IOException {
//省略一些前置校驗的代碼
、召边、铺呵、
// Call the next interceptor in the chain.
RealInterceptorChain next = new RealInterceptorChain(
interceptors, streamAllocation, httpCodec, connection, index + 1, request);
Interceptor interceptor = interceptors.get(index);
Response response = interceptor.intercept(next);
//省略一些后續(xù)處理代碼
、隧熙、片挂、
return response;
}
省略了前后的一些代碼,發(fā)現(xiàn)贞盯,其實這里又新建一個 RealInterceptorChain音念,然后調(diào)用了這個攔截器的 intercept 的方法。那么在每個攔截器里面做了什么躏敢,這個攔截的方法又是做了什么呢闷愤?
首先看一下攔截器這個接口:
public interface Interceptor {
Response intercept(Chain chain) throws IOException;
interface Chain {
Request request();
Response proceed(Request request) throws IOException;
Connection connection();
}
}
很明顯,每個實現(xiàn)Interceptor的攔截器件余。都會實現(xiàn)了intercept讥脐,這樣一個攔截的方法。而傳入的就是一個Chain啼器。符合前面RealInterceptorChain的調(diào)用旬渠。
以一個攔截器的代碼為例:BridgeInterceptor,這個類實現(xiàn)的intercept方法端壳,而這個方法里面告丢,除了那些前置或后續(xù)的操作之外,在中間你會發(fā)現(xiàn) 下面一句代碼:
Response networkResponse = chain.proceed(requestBuilder.build());
又通過傳進來的Chain 损谦,重新調(diào)用了proceed的方法岖免。好吧,到這里應(yīng)該可以了解到這些攔截器成翩,是如何一個個調(diào)用被調(diào)用的了觅捆,原理都是通過了中間的一個RealInterceptorChain赦役,一個接一個的向下調(diào)用麻敌。然后得到的結(jié)果又一個一個向上傳。
總結(jié)一下掂摔,這些攔截器的調(diào)用:
剛開始getResponseWithInterceptorChain的最后開始調(diào)用了 chain.proceed术羔,然后在RealInterceptorChain的里面赢赊,又新建一個 RealInterceptorChain,并且調(diào)用當(dāng)前的攔截器的 intercept级历,并且把新建的Chain傳遞進去释移,然后攔截器的 intercept方法里面,除了一些自身的操作外寥殖,又調(diào)用Chain的proceed方法玩讳。就這樣一直調(diào)用新建Chian, 一直調(diào)用到最后一個攔截器。
這里的調(diào)用其實是一個迭代嚼贡,遞歸的結(jié)構(gòu)熏纯。請求做了前一步的處理才能到下一級,一級級下去粤策,到最后真正發(fā)出去請求樟澜,相對做了攔截。而得到結(jié)果叮盘,只有當(dāng)最后一個攔截器完全了請求秩贰,拿到結(jié)果之后,才會把結(jié)果往上一級柔吼,上一級拿到結(jié)果,做了相應(yīng)的處理之后嚷堡,再到上一級蝗罗,這就是對結(jié)果的攔截處理。
這么看來蝌戒,流程最后一個攔截器就是最終拿到結(jié)果的一個地方了桩匪。
而每個攔截器都有每個的作用,這里只做簡單的按順序進行介紹妆档,后面再對其深入的剖析须板。
- RetryAndFollowUpInterceptor
這攔截器主要是做重試习瑰,網(wǎng)絡(luò)錯誤绪颖,以及請求重定向的一些操作。 - BridgeInterceptor
這個攔截器甜奄,主要把用戶的請求轉(zhuǎn)換為網(wǎng)絡(luò)的請求柠横,添加一些頭部信息等。 - CacheInterceptor
緩存攔截器 - ConnectInterceptor
連接攔截器课兄,主要是處理連接服務(wù)器滓鸠,以及http , https的包裝 - CallServerInterceptor
服務(wù)攔截器,主要是發(fā)送(write第喳、input)糜俗、讀取(read曲饱、output)數(shù)據(jù)悠抹。也是攔截器的最后一個環(huán)節(jié),這里就真正拿到了網(wǎng)絡(luò)的結(jié)果了扩淀。
最后是一個圖示例來展示一下楔敌,發(fā)出請求到收到結(jié)果的整個流程,是如果進行的:
結(jié)束:
到這里為止驻谆,其實整個okhttp, 發(fā)出請求卵凑,到接收請求的流程已經(jīng)清晰了,但是這僅僅是最基本的流程胜臊,你會發(fā)現(xiàn)很多有疑問的地方勺卢,如:OkHttpClient整個類到底做了些什么?RequestBody象对,是一個怎么樣的類黑忱?每一個Request的結(jié)構(gòu)是如何的?每一個RealCall , 是怎么分配線程的勒魔?每一個攔截器都干了什么甫煞?等等。帶著問題冠绢,繼續(xù)剖析下去抚吠。
系列:
OKhttp源碼學(xué)習(xí)(二)—— OkHttpClient
OKhttp源碼學(xué)習(xí)(三)—— Request, RealCall
OKhttp源碼學(xué)習(xí)(四)——RetryAndFollowUpInterceptor攔截器分析
OKhttp源碼學(xué)習(xí)(五)—— BridgeInterceptor攔截器
OKhttp源碼學(xué)習(xí)(六)—— CacheInterceptor攔截器
OKhttp源碼學(xué)習(xí)(七)—— ConnectInterceptor攔截器
OKhttp源碼學(xué)習(xí)(八)——CallServerInterceptor攔截器
OKhttp源碼學(xué)習(xí)(九)—— 任務(wù)管理(Dispatcher)