OkHttp 3.7源碼分析(一)——整體架構
OkHttp3.7源碼分析文章列表如下:
OkHttp是一個處理網絡請求的開源項目,是Android端最火熱的輕量級框架,由移動支付Square公司貢獻用於替代HttpUrlConnection和Apache HttpClient。隨著OkHttp的不斷成熟,越來越多的Android開發者使用OkHttp作為網絡框架。
之所以可以贏得如此多開發者的喜愛,主要得益於如下特點:
- 支持HTTPS/HTTP2/WebSocket(在OkHttp3.7中已經剝離對Spdy的支持,轉而大力支持HTTP2)
- 內部維護任務隊列線程池,友好支持並發訪問
- 內部維護連接池,支持多路複用,減少連接創建開銷
- socket創建支持最佳路由
- 提供攔截器鏈(InterceptorChain),實現request與response的分層處理(如透明GZIP壓縮,logging等)
為了一探OkHttp是如何具備以下特點的,筆者反複研究OkHttp框架源碼,力求通過源碼分析向各位解釋一二。所以特意準備了幾篇博客跟大家一起探討下OkHttp的方方麵麵,今天首先從整體架構上分析下OkHttp。
簡單使用
首先來看下OkHttp的簡單使用,OkHttp提供了兩種調用方式:
- 同步調用
- 異步調用
同步調用
@Override public Response execute() throws IOException {
synchronized (this) {
if (executed) throw new IllegalStateException("Already Executed");
executed = true;
}
try {
client.dispatcher().executed(this);
Response result = getResponseWithInterceptorChain(false);
if (result == null) throw new IOException("Canceled");
return result;
} finally {
client.dispatcher().finished(this);
}
}
首先加鎖置標誌位,接著使用分配器的executed方法將call加入到同步隊列中,然後調用getResponseWithInterceptorChain方法(稍後分析)執行http請求,最後調用finishied方法將call從同步隊列中刪除
異步請求
void enqueue(Callback responseCallback, boolean forWebSocket) {
synchronized (this) {
if (executed) throw new IllegalStateException("Already Executed");
executed = true;
}
client.dispatcher().enqueue(new AsyncCall(responseCallback, forWebSocket));
}
同樣先置標誌位,然後將封裝的一個執行體放到異步執行隊列中。這裏麵引入了一個新的類AsyncCall,這個類繼承於NamedRunnable,實現了Runnable接口。NamedRunnable可以給當前的線程設置名字,並且用模板方法將線程的執行體放到了execute方法中
攔截器
除了同步調用和異步調用,OkHttp還提供了一個攔截器的概念。攔截器提供了攔截請求和攔截服務器應答的接口。OkHttp提供了一個攔截器鏈的概念,通過將一個個攔截器組合成一個攔截器鏈,可以達到在不同層麵做不同攔截操作的效果,有點AOP的意思。具體攔截器的使用可以參考:Okhttp-wiki 之 Interceptors 攔截器
總體架構
上圖是OkHttp的總體架構,大致可以分為以下幾層:
- Interface——接口層:接受網絡訪問請求
- Protocol——協議層:處理協議邏輯
- Connection——連接層:管理網絡連接,發送新的請求,接收服務器訪問
- Cache——緩存層:管理本地緩存
- I/O——I/O層:實際數據讀寫實現
- Inteceptor——攔截器層:攔截網絡訪問,插入攔截邏輯
Interface——接口層:
接口層接收用戶的網絡訪問請求(同步請求/異步請求),發起實際的網絡訪問。OkHttpClient
是OkHttp框架的客戶端,更確切的說是一個用戶麵板。用戶使用OkHttp進行各種設置,發起各種網絡請求都是通過OkHttpClient
完成的。每個OkHttpClient
內部都維護了屬於自己的任務隊列,連接池,Cache,攔截器等,所以在使用OkHttp作為網絡框架時應該全局共享一個OkHttpClient
實例。
Call
描述一個實際的訪問請求,用戶的每一個網絡請求都是一個Call
實例。Call
本身隻是一個接口,定義了Call
的接口方法,實際執行過程中,OkHttp會為每一個請求創建一個RealCall
,每一個RealCall
內部有一個AsyncCall
:
final class AsyncCall extends NamedRunnable {
private final Callback responseCallback;
AsyncCall(Callback responseCallback) {
super("OkHttp %s", redactedUrl());
this.responseCallback = responseCallback;
}
String host() {
return originalRequest.url().host();
}
Request request() {
return originalRequest;
}
RealCall get() {
return RealCall.this;
}
@Override protected void execute() {
...
}
...
}
AsyncCall
繼承的NamedRunnable
繼承自Runnable接口:
public abstract class NamedRunnable implements Runnable {
protected final String name;
public NamedRunnable(String format, Object... args) {
this.name = Util.format(format, args);
}
@Override public final void run() {
String oldName = Thread.currentThread().getName();
Thread.currentThread().setName(name);
try {
execute();
} finally {
Thread.currentThread().setName(oldName);
}
}
protected abstract void execute();
}
所以每一個Call就是一個線程,而執行Call的過程就是執行其execute
方法的過程。
Dispatcher
是OkHttp的任務隊列,其內部維護了一個線程池,當有接收到一個Call
時,Dispatcher
負責在線程池中找到空閑的線程並執行其execute
方法。這部分將會單獨拿一篇博客進行介紹,詳細內容可參考本係列接下來的文章。
Protocol——協議層:處理協議邏輯
Protocol層負責處理協議邏輯,OkHttp支持Http1/Http2/WebSocket協議,並在3.7版本中放棄了對Spdy協議,鼓勵開發者使用Http/2。
Connection——連接層:管理網絡連接,發送新的請求,接收服務器訪問
連接層顧名思義就是負責網絡連接。在連接層中有一個連接池,統一管理所有的Socket連接,當用戶新發起一個網絡請求時,OkHttp會首先從連接池中查找是否有符合要求的連接,如果有則直接通過該連接發送網絡請求;否則新創建一個網絡連接。
RealConnection
描述一個物理Socket連接,連接池中維護多個RealConnection實例。由於Http/2支持多路複用,一個RealConnection
可以支持多個網絡訪問請求,所以OkHttp又引入了StreamAllocation
來描述一個實際的網絡請求開銷(從邏輯上一個Stream
對應一個Call
,但在實際網絡請求過程中一個Call
常常涉及到多次請求。如重定向,Authenticate等場景。所以準確地說,一個Stream
對應一次請求,而一個Call
對應一組有邏輯關聯的Stream
),一個RealConnection
對應一個或多個StreamAllocation
,所以StreamAllocation
可以看做是RealConenction
的計數器,當RealConnection
的引用計數變為0,且長時間沒有被其他請求重新占用就將被釋放。
連接層是OkHttp的核心部分,這部分當然也會單獨拿一篇博客詳細講解,詳細內容可參考本專題相關文章。
Cache——緩存層:管理本地緩存
Cache層負責維護請求緩存,當用戶的網絡請求在本地已有符合要求的緩存時,OkHttp會直接從緩存中返回結果,從而節省網絡開銷。這部分內容也會單獨拿一篇博客進行介紹,詳細內容可參考本專題相關文章。
I/O——I/O層:實際數據讀寫實現
I/O層負責實際的數據讀寫。OkHttp的另一大有點就是其高效的I/O操作,這歸因於其高效的I/O庫okio
這部分內容筆者也打算另開一個專題進行介紹。詳細內容可以參考本博客相關內容。
Inteceptor——攔截器層:攔截網絡訪問,插入攔截邏輯
攔截器層提供了一個類AOP接口,方便用戶可以切入到各個層麵對網絡訪問進行攔截並執行相關邏輯。在下一篇博客中,筆者將通過介紹一個實際的網絡訪問請求實例來介紹攔截器的原理。
最後更新:2017-05-05 10:31:20