OkHttp深入分析——基礎認知部分

仰簡發表於2018-12-15

一、前言

OkHttp 在 Android 網路框架這一塊的地位已經不言而喻了,尤其從 Android 4.4 之後,系統已經拋棄了原生的 HttpUrlConnection 的內部實現,轉而是封裝了 OkHttp 的實現,HttpUrlConnection 對外只是一層介面供開發者來呼叫。所以現在不管你是使用 HttpUrlConnection 還是 Volley,其實都是在間接使用 OkHttp,說它的出現基本上統一了 Android 的 Http 網路框架真的一點也不為過。

二、官文解讀

1.概覽

用官網的話來說,OkHttp 是一個用於進行 Http / Http2 通訊的客戶端,並且同時適用於 Android 和 Java。

當然,其還是一個非常強大而高效的網路框架,其主要特點在於:

  • 對於同一個主機的所有請求,允許其在 Http / Http 2 上共享同一個套接字,這就避免了重複的 TCP 連線帶來的 3 步握手的時間。
  • 對於 Http 協議,其支援連線池用於減少請求延遲。
  • 資料都使用了 gzip 壓縮傳輸,從而減小網路傳輸 size 的大小。
  • 對響應進行快取,避免快取有效期內重複的網路請求。
  • 弱網情況下,在連線失敗後,OkHttp 會自動進行重試,特別是有備用地址時還會通過備用地址進行連線。而安全上,其支援新一代的 TLS 功能,SNI 和 ALPN,如果伺服器不支援的話則會主動降級到 TLS 1.0。

OkHttp的使用是很簡單的,它在 request/reponse API 上採用了鏈式 Builder 的設計模式,使得它具備一旦構建便不可修改性。

最後,還提到它支援同步和非同步請求。其實網路請求的實現原理上也是一次 I/O 通訊,並且大多還是同步的 I/O。早前我們直接用 HttpUrlConnection 進行通訊時根本不區分什麼同步和非同步,只是迫於 Android 的強制管理機制,要求網路通訊不能放在 "main thread" 中進行,否則就報 crash,我們不得已才把網路請求這一段程式碼放到了子執行緒執行,最後再通過 Handler 把結果返回到主執行緒。所以這裡說的同步和非同步主要也是說實現了同步和非同步的封裝。當然,我們進行同步呼叫時,也還是不能在 "main thread" 中進行。

2.例程

Get 請求

// 構建 OkHttpClient 例項
OkHttpClient client = new OkHttpClient();

String run(String url) throws IOException {
  // 通過鏈式 Builder 設計提供的 Builder 構建 Request
  Request request = new Request.Builder()
      .url(url)
      .build();
  // 以下是發起一個同步請求,Response 為接收的響應結果
  Response response = client.newCall(request).execute();
  return response.body().string();
}
複製程式碼

Post 請求

// 指定 Body 的 cotent-type 為 application/json,一般情況下都是這個
public static final MediaType JSON
    = MediaType.parse("application/json; charset=utf-8");
// 構建 OkHttpClient 例項
OkHttpClient client = new OkHttpClient();

String post(String url, String json) throws IOException {
  // 構建 Body
  RequestBody body = RequestBody.create(JSON, json);
 // 構建 Request,對於 post 請求,除了設定 url 還需要設定 body
  Request request = new Request.Builder()
      .url(url)
      .post(body)
      .build();
 // 執行一個同步的請求,響應結果在 Response 中
  Response response = client.newCall(request).execute();
  return response.body().string();
}
複製程式碼

sample 中的請求都是同步的,其對應的非同步請求為 client.newCall(request).enqueue(callback)。

3. 使用 gradle 中整合

這個就 so easy 了

compile 'com.squareup.okhttp3:okhttp:3.12.0'
複製程式碼

三、工程概述

當我們 clone 下 OkHttp 的 github 倉庫下來,會發現其裡面含有非常多的小工程,這其實是一個大的 maven 工程。如果要工程化的管理以及除錯,建議用 IntelliJ IDEA 或者 Eclipse 開啟工程,而不要用 Android Studio 開啟,最後得到的效果如下圖。如果開啟的下圖這個樣子,你就可以進行愉快的程式碼調式了。當然手頭最好還是準備一個襯手的抓包工具,如 charles,fiddler 或者 更牛逼的 Wireshark。

image.png

從上圖看 OKHttp 的核心實現庫就是 okhttp 工程。作為一個優秀的框架,一定不是孤立地存在的,還有它身邊的輔助工程,demo 工程等等。如下是整個工程模組的分類及簡要說明。

工程模組分類圖

模組名 說明
1 benchmark 主要用於效能測試。
2 mockwebserver mock 一個 web 伺服器,方便測試。包括了 HTTP 和 HTTPS 全棧測試。
3 okhttp-dnsoverhttps 使用OkHttp在HTTPS上進行DNS實驗
4 okhttp-hpacktests hpack 測試,hapck 即頭部壓縮演算法,主要應用在 http2 上
5 okhttp-testing-support 測試支援模組
6 sampls 例程
7 okcurl okhttp 版本的 curl,可以測試整個 okhttp 庫,包括了 http2 協議
8 okhttp-andorid-support 增強 Android 的支援
9 okhttp-apache 封裝了 OkHttp 版本的 apache HttpClient 實現,未來版本中會被移除
10 okhttp-tests 單元測試
11 okhttp-urlconnection 封裝了 OkHttp 版本的 HttpUrlConnection,未來版本中會被移除
12 okhttp-tls 簡化 tls 使用的 API,尤其自簽名證照
13 okhttp-see 實驗性的用於支援伺服器傳送的事件。API不穩定,可能隨時更改。
14 okhttp-logging-interceptor 典型的 interceptor 用例
15 bom 目前還只是一個空模組
16 websites okhttp 站點頁面
17 okhttp okhttp 核心庫的實現

四、總結

基礎認知部分主要是熟悉了 OkHttp 的官網以及 OkHttp 原始碼的整個工程。通過對整個工程的瞭解,其主要目的是建立一起一個全域性觀。所謂站的高看的遠,有了全域性觀之後使得我們深入到某個細節之後不致於感到迷惘。

最後,感謝你能讀到並讀完此文章。受限於作者水平有限,如果分析的過程中存在錯誤或者疑問都歡迎留言討論。如果我的分享能夠幫助到你,還請記得幫忙點個贊吧,謝謝。