雨露均沾的OkHttp—WebSocket長連接的使用&源碼解析
- 2020 年 10 月 22 日
- 筆記
前言
最近老闆又來新需求了，要做一個物聯網相關的app，其中有個需求是客戶端需要收發伺服器不定期發出的消息。
內心OS：
🤔 這咋整呢？通過介面輪詢？定時訪問介面，有數據就更新？
🤔 不行不行，這樣浪費資源了，還耗電，會導致很多請求都是無效的網路操作。
🤔 那就長連接唄？WebSocket協議好像不錯，通過握手建立長連接後，可以隨時收發伺服器的消息。那就它了！
🤔 怎麼集成呢？正好前段時間複習OkHttp源碼的時候發現了它是支援Websocket協議的，那就用它試試吧！（戲好多，演不下去了🤮）
開淦！
WebSocket介紹
先簡單介紹下WebSocket。
我們都知道Http是處於應用層的一個通訊協議，但是只支援單向主動通訊，做不到伺服器主動向客戶端推送消息。而且Http是無狀態的，即每次通訊都沒有關聯性，導致跟伺服器關係不緊密。
為了解決和伺服器長時間通訊的痛點呢，HTML5規範引出了WebSocket協議（知道這名字咋來的吧，人家HTML5規範引出的，隨爸姓），是一種建立在TCP協議基礎上的全雙工通訊的協議。他跟Http同屬於應用層協議，下層還是需要通過TCP建立連接。
但是，WebSocket在TCP連接建立後，還要通過Http進行一次握手，也就是通過Http發送一條GET請求消息給伺服器，告訴伺服器我要建立WebSocket連接了，你準備好哦，具體做法就是在頭部資訊中添加相關參數。然後伺服器響應我知道了，並且將連接協議改成WebSocket，開始建立長連接。
這裡貼上請求頭和響應頭資訊，從網上找了一張圖：
簡單說明下參數：
- URL一般是以
ws或者wss開頭，ws對應Websocket協議，wss對應在TLS之上的WebSocket。類似於Http和Https的關係。 - 請求方法為GET方法。
Connection:Upgrade，表示客戶端要連接升級，不用Http協議。Upgrade:websocket， 表示客戶端要升級建立Websocket連接。Sec-Websocket-Key:key， 這個key是隨機生成的，伺服器會通過這個參數驗證該請求是否有效。Sec-WebSocket-Version:13， websocket使用的協議，一般就是13。Sec-webSocket-Extension:permessage-deflate，客戶端指定的一些擴展協議，比如這裡permessage-deflate就是WebSocket的一種壓縮協議。響應碼101,表示響應協議升級，後續的數據交互都按照Upgradet指定的WebSocket協議來。
OkHttp實現
添加OkHttp依賴
implementation("com.squareup.okhttp3:okhttp:4.7.2")
實現程式碼
首先是初始化OkHttpClient和WebSocket實例：
/**
* 初始化WebSocket
*/
public void init() {
mWbSocketUrl = "ws://echo.websocket.org";
mClient = new OkHttpClient.Builder()
.pingInterval(10, TimeUnit.SECONDS)
.build();
Request request = new Request.Builder()
.url(mWbSocketUrl)
.build();
mWebSocket = mClient.newWebSocket(request, new WsListener());
}
這裡主要是配置了OkHttp的一些參數，以及WebSocket的連接地址。其中newWebSocket方法就是進行WebSocket的初始化和連接。
這裡要注意的點是pingInterval方法的配置，這個方法主要是用來設置WebSocket連接的保活。
相信做過長連接的同學都知道，一個長連接一般要隔幾秒發送一條消息告訴伺服器我在線，而伺服器也會回復一個消息表示收到了，這樣就確認了連接正常，客戶端和伺服器端都在線。
如果伺服器沒有按時收到這個消息那麼伺服器可能就會主動關閉這個連接，節約資源。
客戶端沒有正常收到這個返回的消息，也會做一些類似重連的操作，所以這個保活消息非常重要。
我們稱這個消息叫作心跳包，一般用PING，PONG表示，像乒乓球一樣，一來一回。
所以這裡的pingInterval就是設置心跳包發送的間隔時間，設置了這個方法之後，OkHttp就會自動幫我們發送心跳包事件，也就是ping包。當間隔時間到了，沒有收到pong包的話，監聽事件中的onFailure方法就會被調用，此時我們就可以進行重連。
但是由於實際業務需求不一樣，以及okhttp中心跳包事件給予我們許可權較少，所以我們也可以自己完成心跳包事件，即在WebSocket連接成功之後，開始定時發送ping包，在下一次發送ping包之前檢查上一個pong包是否收到，如果沒收到，就視為異常，開始重連。感興趣的同學可以看看文末的相關源碼。
建立連接後，我們就可以正常發送和讀取消息了，也就是在上文WsListener監聽事件中表現：
//監聽事件，用於收消息，監聽連接的狀態
class WsListener extends WebSocketListener {
@Override
public void onClosed(@NotNull WebSocket webSocket, int code, @NotNull String reason) {
super.onClosed(webSocket, code, reason);
}
@Override
public void onClosing(@NotNull WebSocket webSocket, int code, @NotNull String reason) {
super.onClosing(webSocket, code, reason);
}
@Override
public void onFailure(@NotNull WebSocket webSocket, @NotNull Throwable t, @Nullable Response response) {
super.onFailure(webSocket, t, response);
}
@Override
public void onMessage(@NotNull WebSocket webSocket, @NotNull String text) {
super.onMessage(webSocket, text);
Log.e(TAG, "客戶端收到消息:" + text);
onWSDataChanged(DATE_NORMAL, text);
//測試發消息
webSocket.send("我是客戶端，你好啊");
}
@Override
public void onMessage(@NotNull WebSocket webSocket, @NotNull ByteString bytes) {
super.onMessage(webSocket, bytes);
}
@Override
public void onOpen(@NotNull WebSocket webSocket, @NotNull Response response) {
super.onOpen(webSocket, response);
Log.e(TAG,"連接成功！");
}
}
//發送String消息
public void send(final String message) {
if (mWebSocket != null) {
mWebSocket.send(message);
}
}
/**
* 發送byte消息
* @param message
*/
public void send(final ByteString message) {
if (mWebSocket != null) {
mWebSocket.send(message);
}
}
//主動斷開連接
public void disconnect(int code, String reason) {
if (mWebSocket != null)
mWebSocket.close(code, reason);
}
這裡要注意，回調的方法都是在子執行緒回調的，如果需要更新UI，需要切換到主執行緒。
基本操作就這麼多，還是很簡單的吧，初始化Websocket——連接——連接成功——收發消息。
其中WebSocket類是一個操作介面，主要提供了以下幾個方法
send(text: String)發送一個String類型的消息send(bytes: ByteString)發送一個二進位類型的消息close(code: Int, reason: String?)關閉WebSocket連接
如果有同學想測試下WebSocket的功能但是又沒有實際的伺服器，怎麼辦呢？
其實OkHttp官方有一個MockWebSocket服務，可以用來模擬服務端，下面我們一起試一下：
模擬伺服器
首先集成MockWebSocket服務庫：
implementation 'com.squareup.okhttp3:mockwebserver:4.7.2'
然後就可以新建MockWebServer，並加入MockResponse作為接收消息的響應。
MockWebServer mMockWebServer = new MockWebServer();
MockResponse response = new MockResponse()
.withWebSocketUpgrade(new WebSocketListener() {
@Override
public void onOpen(@NotNull WebSocket webSocket, @NotNull Response response) {
super.onOpen(webSocket, response);
//有客戶端連接時回調
Log.e(TAG, "伺服器收到客戶端連接成功回調：");
mWebSocket = webSocket;
mWebSocket.send("我是伺服器，你好呀");
}
@Override
public void onMessage(@NotNull WebSocket webSocket, @NotNull String text) {
super.onMessage(webSocket, text);
Log.e(TAG, "伺服器收到消息：" + text);
}
@Override
public void onClosed(@NotNull WebSocket webSocket, int code, @NotNull String reason) {
super.onClosed(webSocket, code, reason);
Log.e(TAG, "onClosed：");
}
});
mMockWebServer.enqueue(response);
這裡伺服器端在收到客戶端連接成功消息後，給客戶端發送了一條消息。
要注意的是這段程式碼要在子執行緒執行，因為主執行緒不能進行網路操作。
然後就可以去初始化Websocket客戶端了：
//獲取連接url，初始化websocket客戶端
String websocketUrl = "ws://" + mMockWebServer.getHostName() + ":" + mMockWebServer.getPort() + "/";
WSManager.getInstance().init(websocketUrl);
ok，運行項目
//運行結果
E/jimu: mWbSocketUrl=ws://localhost:38355/
E/jimu: 伺服器收到客戶端連接成功回調：
E/jimu: 連接成功！
E/jimu: 客戶端收到消息:我是伺服器，你好呀
E/jimu: 伺服器收到消息：我是客戶端，你好啊
相關的WebSocket管理類和模擬伺服器類我也上傳到github了，有需要的同學可以文末自取。
源碼解析
WebSocket整個流程無非三個功能：連接，接收消息，發送消息。下面我們就從這三個方面分析下具體是怎麼實現的。
連接
通過上面的程式碼我們得知，WebSocket連接是通過newWebSocket方法。直接點進去看這個方法：
override fun newWebSocket(request: Request, listener: WebSocketListener): WebSocket {
val webSocket = RealWebSocket(
taskRunner = TaskRunner.INSTANCE,
originalRequest = request,
listener = listener,
random = Random(),
pingIntervalMillis = pingIntervalMillis.toLong(),
extensions = null, // Always null for clients.
minimumDeflateSize = minWebSocketMessageToCompress
)
webSocket.connect(this)
return webSocket
}
這裡做了兩件事：
- 初始化
RealWebSocket，主要是設置了一些參數（比如pingIntervalMillis心跳包時間間隔，還有監聽事件之類的） connect方法進行WebSocket連接
繼續查看connect方法：
connect(WebSocket連接握手)
fun connect(client: OkHttpClient) {
//***
val webSocketClient = client.newBuilder()
.eventListener(EventListener.NONE)
.protocols(ONLY_HTTP1)
.build()
val request = originalRequest.newBuilder()
.header("Upgrade", "websocket")
.header("Connection", "Upgrade")
.header("Sec-WebSocket-Key", key)
.header("Sec-WebSocket-Version", "13")
.header("Sec-WebSocket-Extensions", "permessage-deflate")
.build()
call = RealCall(webSocketClient, request, forWebSocket = true)
call!!.enqueue(object : Callback {
override fun onResponse(call: Call, response: Response) {
//得到數據流
val streams: Streams
try {
checkUpgradeSuccess(response, exchange)
streams = exchange!!.newWebSocketStreams()
}
//***
// Process all web socket messages.
try {
val name = "$okHttpName WebSocket ${request.url.redact()}"
initReaderAndWriter(name, streams)
listener.onOpen(this@RealWebSocket, response)
loopReader()
} catch (e: Exception) {
failWebSocket(e, null)
}
}
})
}
上一篇使用篇文章中說過，Websocket連接需要一次Http協議的握手，然後才能把協議升級成WebSocket。所以這段程式碼就體現出這個功能了。
首先就new了一個用來進行Http連接的request，其中Header的參數就表示我要進行WebSocket連接了，參數解析如下：
Connection:Upgrade，表示客戶端要連接升級Upgrade:websocket， 表示客戶端要升級建立Websocket連接Sec-Websocket-Key:key， 這個key是隨機生成的，伺服器會通過這個參數驗證該請求是否有效Sec-WebSocket-Version:13， websocket使用的版本，一般就是13Sec-webSocket-Extension:permessage-deflate，客戶端指定的一些擴展協議，比如這裡permessage-deflate就是WebSocket的一種壓縮協議。
Header設置好之後，就調用了call的enqueue方法，這個方法大家應該都很熟悉吧，OkHttp裡面對於Http請求的非同步請求就是這個方法。
至此，握手結束，伺服器返回響應碼101，表示協議升級。
然後我們繼續看看獲取伺服器響應之後又做了什麼？
在發送Http請求成功之後，onResponse響應方法裡面主要表現為四個處理邏輯：
- 將
Http流轉換成WebSocket流，得到Streams對象，這個流後面會轉化成輸入流和輸出流，也就是進行發送和讀取的操作流 listener.onOpen(this@RealWebSocket, response)，回調了介面WebSocketListener的onOpen方法，告訴用戶WebSocket已經連接initReaderAndWriter(name, streams)loopReader()
前兩個邏輯還是比較好理解，主要是後兩個方法，我們分別解析下。
首先看initReaderAndWriter方法。
initReaderAndWriter（初始化輸入流輸出流）
//RealWebSocket.kt
@Throws(IOException::class)
fun initReaderAndWriter(name: String, streams: Streams) {
val extensions = this.extensions!!
synchronized(this) {
//***
//寫數據，發送數據的工具類
this.writer = WebSocketWriter()
//設置心跳包事件
if (pingIntervalMillis != 0L) {
val pingIntervalNanos = MILLISECONDS.toNanos(pingIntervalMillis)
taskQueue.schedule("$name ping", pingIntervalNanos) {
writePingFrame()
return@schedule pingIntervalNanos
}
}
//***
}
//***
//讀取數據的工具類
reader = WebSocketReader(
***
frameCallback = this,
***
)
}
internal fun writePingFrame() {
//***
try {
writer.writePing(ByteString.EMPTY)
} catch (e: IOException) {
failWebSocket(e, null)
}
}
這個方法主要幹了兩件事：
- 實例化輸出流輸入流工具類，也就是
WebSocketWriter和WebSocketReader，用來處理數據的收發。 - 設置心跳包事件。如果
pingIntervalMillis參數不為0，就通過計時器，每隔pingIntervalNanos發送一個ping消息。其中writePingFrame方法就是發送了ping幀數據。
接收消息處理消息
loopReader
接著看看這個loopReader方法是幹什麼的，看這個名字我們大膽猜測下，難道這個方法就是用來循環讀取數據的？去程式碼里找找答案：
fun loopReader() {
while (receivedCloseCode == -1) {
// This method call results in one or more onRead* methods being called on this thread.
reader!!.processNextFrame()
}
}
程式碼很簡單，一個while循環，循環條件是receivedCloseCode == -1的時候，做的事情是reader!!.processNextFrame()方法。繼續：
//WebSocketWriter.kt
fun processNextFrame() {
//讀取頭部資訊
readHeader()
if (isControlFrame) {
//如果是控制幀，讀取控制幀內容
readControlFrame()
} else {
//讀取普通消息內容
readMessageFrame()
}
}
//讀取頭部資訊
@Throws(IOException::class, ProtocolException::class)
private fun readHeader() {
if (closed) throw IOException("closed")
try {
//讀取數據，獲取數據幀的前8位
b0 = source.readByte() and 0xff
} finally {
source.timeout().timeout(timeoutBefore, TimeUnit.NANOSECONDS)
}
//***
//獲取數據幀的opcode（數據格式）
opcode = b0 and B0_MASK_OPCODE
//是否為最終幀
isFinalFrame = b0 and B0_FLAG_FIN != 0
//是否為控制幀（指令）
isControlFrame = b0 and OPCODE_FLAG_CONTROL != 0
//判斷最終幀，獲取幀長度等等
}
//讀取控制幀（指令）
@Throws(IOException::class)
private fun readControlFrame() {
if (frameLength > 0L) {
source.readFully(controlFrameBuffer, frameLength)
}
when (opcode) {
OPCODE_CONTROL_PING -> {
//ping 幀
frameCallback.onReadPing(controlFrameBuffer.readByteString())
}
OPCODE_CONTROL_PONG -> {
//pong 幀
frameCallback.onReadPong(controlFrameBuffer.readByteString())
}
OPCODE_CONTROL_CLOSE -> {
//關閉 幀
var code = CLOSE_NO_STATUS_CODE
var reason = ""
val bufferSize = controlFrameBuffer.size
if (bufferSize == 1L) {
throw ProtocolException("Malformed close payload length of 1.")
} else if (bufferSize != 0L) {
code = controlFrameBuffer.readShort().toInt()
reason = controlFrameBuffer.readUtf8()
val codeExceptionMessage = WebSocketProtocol.closeCodeExceptionMessage(code)
if (codeExceptionMessage != null) throw ProtocolException(codeExceptionMessage)
}
//回調onReadClose方法
frameCallback.onReadClose(code, reason)
closed = true
}
}
}
//讀取普通消息
@Throws(IOException::class)
private fun readMessageFrame() {
readMessage()
if (readingCompressedMessage) {
val messageInflater = this.messageInflater
?: MessageInflater(noContextTakeover).also { this.messageInflater = it }
messageInflater.inflate(messageFrameBuffer)
}
if (opcode == OPCODE_TEXT) {
frameCallback.onReadMessage(messageFrameBuffer.readUtf8())
} else {
frameCallback.onReadMessage(messageFrameBuffer.readByteString())
}
}
程式碼還是比較直觀，這個processNextFrame其實就是讀取數據用的，首先讀取頭部資訊，獲取數據幀的類型，判斷是否為控制幀，再分別去讀取控制幀數據或者普通消息幀數據。
數據幀格式
問題來了，什麼是數據頭部資訊，什麼是控制幀？
這裡就要說下WebSocket的數據幀了，先附上一個數據幀格式：
0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
+-+-+-+-+-------+ +-+-------------+ +-----------------------------+
|F|R|R|R| OP | |M| LENGTH | Extended payload length
|I|S|S|S| CODE | |A| | （if LENGTH=126）
|N|V|V|V| | |S| |
| |1|2|3| | |K| |
+-+-+-+-+-------+ +-+-------------+
| Extended payload length（if LENGTH=127）
+ +-------------------------------
| Extended payload length | Masking-key，if Mask set to 1
+----------------------------------+-------------------------------
| Masking-key | Data
+----------------------------------+-------------------------------
| Data
+----------------------------------+-------------------------------
我承認，我懵逼了。
冷靜冷靜，一步一步分析下吧。
首先每一行代表4個位元組，一共也就是32位數，哦，那也就是幾個位元組而已嘛，每個位元組有他自己的代表意義唄，這樣想是不是就很簡單了，下面來具體看看每個位元組。
第1個位元組：
- 第一位是
FIN碼，其實就是一個標示位，因為數據可能多幀操作嘛，所以多幀情況下，只有最後一幀的FIN設置成1，標示結束幀，前面所有幀設置為0。 - 第二位到第四位是
RSV碼，一般通訊兩端沒有設置自定義協議，就默認為0。 - 後四位是
opcode，我們叫它操作碼。這個就是判斷這個數據幀的類型了，一般有以下幾個被定義好的類型：
1） 0x0 表示附加數據幀
2） 0x1 表示文本數據幀
3） 0x2 表示二進位數據幀
4） 0x3-7 保留用於未來的非控制幀
5） 0x8 表示連接關閉
6） 0x9 表示ping
7） 0xA 表示pong
8） 0xB-F 保留用於未來的非控制幀
是不是發現了些什麼，這不就對應了我們應用中的幾種格式嗎？2和3對應的是普通消息幀，包括了文本和二進位數據。567對應的就是控制幀格式，包括了close，ping，pong。
第2個位元組：
- 第一位是
Mask掩碼，其實就是標識數據是否加密混淆，1代表數據經過掩碼的，0是沒有經過掩碼的，如果是1的話，後續就會有4個位元組代表掩碼key，也就是數據幀中Masking-key所處的位置。 - 後7位是
LENGTH，用來標示數據長度。因為只有7位，所以最大只能儲存1111111對應的十進位數127長度的數據，如果需要更大的數據，這個儲存長度肯定就不夠了。
所以規定來了，1)小於126長度則數據用這七位表示實際長度。2) 如果長度設置為126，也就是二進位1111110，就代表取額外2個位元組表示數據長度，共是16位表示數據長度。3) 如果長度設置為127，也就是二進位1111111，就代表取額外8個位元組，共是64位表示數據長度。
需要注意的是LENGHT的三種情況在一個數據幀裡面只會出現一種情況，不共存，所以在圖中是用if表示。同樣的，Masking-key也是當Mask為1的時候才存在。
所以也就有了數據幀裡面的Extended payload length（LENGTH=126）所處的2個位元組，以及Extended payload length（LENGTH=127）所處的8個位元組。
最後的位元組部分自然就是掩碼key（Mask為1的時候才存在）和具體的傳輸數據了。
還是有點暈吧😷，來張圖總結下：
好了，了解了數據幀格式後，我們再來讀源碼就清晰多了。
先看看怎麼讀的頭部資訊並解析的：
//取數據幀前8位數據
b0 = source.readByte() and 0xff
//獲取數據幀的opcode（數據格式）
opcode = b0 and B0_MASK_OPCODE（15）
//是否為最終幀
isFinalFrame = b0 and B0_FLAG_FIN（128） != 0
//是否為控制幀（指令）
isControlFrame = b0 and OPCODE_FLAG_CONTROL（8） != 0
- 第一句獲取頭資訊，
and是按位與計算，and 0xff意思就是按位與11111111，所以頭部資訊其實就是取了數據幀的前8位數據，一個位元組。 - 第二句獲取
opcode，and 15也就是按位與00001111，其實也就是取了後四位數據，剛好對應上opcode的位置，第一個位元組的後四位。 - 第三句獲取是否為
最終幀，剛才數據幀格式中說過，第一位FIN標識了是否為最後一幀數據，1代表結束幀，所以這裡and 128也就是按位與10000000，也就是取的第一位數。 - 第四句獲取是否為控制幀，
and 8也就是按位與00001000，取得是第五位，也就是opcode的第一位，這是什麼意思呢？我們看看剛才的數據幀格式，發現從0x8開始就是所謂的控制幀了。0x8對應的二進位是1000，0x7對應的二進位是0111。發現了吧，如果為控制幀的時候，opcode第一位肯定是為1的，所以這裡就判斷的第五位。
後面還有讀取第二個位元組的程式碼，大家可以自己沿著這個思路自己看看，包括了讀取MASK，讀取數據長度的三種長度等。
所以這個processNextFrame方法主要做了三件事：
readHeader方法中，判斷了是否為控制幀，是否為結束幀，然後獲取了Mask標識，幀長度等參數readControlFrame方法中，主要處理了該幀數據為ping，pong，close三種情況，並且在收到close關閉幀的情況下，回調了onReadClose方法，這個待會要細看下。readMessageFrame方法中，主要是讀取了消息後，回調了onReadMessage方法。
至此可以發現，其實WebSocket傳輸數據並不是一個簡單的事，只是OkHttp都幫我們封裝好了，我們只需要直接傳輸數據即可，感謝這些三方庫為我們開發作出的貢獻，不知道什麼時候我也能做出點貢獻呢🤔。
對了，剛才說回調也很重要，接著看看。onReadClose和onReadMessage回調到哪了呢？還記得上文初始化WebSocketWriter的時候設置了回調介面嗎。所以就是回調給RealWebSocket了：
//RealWebSocket.kt
override fun onReadClose(code: Int, reason: String) {
require(code != -1)
var toClose: Streams? = null
var readerToClose: WebSocketReader? = null
var writerToClose: WebSocketWriter? = null
synchronized(this) {
check(receivedCloseCode == -1) { "already closed" }
receivedCloseCode = code
receivedCloseReason = reason
//...
}
try {
listener.onClosing(this, code, reason)
if (toClose != null) {
listener.onClosed(this, code, reason)
}
} finally {
toClose?.closeQuietly()
readerToClose?.closeQuietly()
writerToClose?.closeQuietly()
}
}
@Throws(IOException::class)
override fun onReadMessage(text: String) {
listener.onMessage(this, text)
}
@Throws(IOException::class)
override fun onReadMessage(bytes: ByteString) {
listener.onMessage(this, bytes)
}
onReadClose回調方法裡面有個關鍵的參數，receivedCloseCode。還記得這個參數嗎？上文中解析消息的循環條件就是receivedCloseCode == -1，所以當收到關閉幀的時候，receivedCloseCode就不再等於-1（規定大於1000），也就不再去讀取解析消息了。這樣整個流程就結束了。
其中還有一些WebSocketListener的回調，比如onClosing，onClosed，onMessage等，就直接回調給用戶使用了。至此，接收消息處理消息說完了。
發消息
好了。接著說發送，看看send方法：
@Synchronized private fun send(data: ByteString, formatOpcode: Int): Boolean {
// ***
// Enqueue the message frame.
queueSize += data.size.toLong()
messageAndCloseQueue.add(Message(formatOpcode, data))
runWriter()
return true
}
首先，把要發送的data封裝成Message對象，然後入隊列messageAndCloseQueue。最後執行runWriter方法。這都不用猜了，runWriter肯定就要開始發送消息了，繼續看：
//RealWebSocket.kt
private fun runWriter() {
this.assertThreadHoldsLock()
val writerTask = writerTask
if (writerTask != null) {
taskQueue.schedule(writerTask)
}
}
private inner class WriterTask : Task("$name writer") {
override fun runOnce(): Long {
try {
if (writeOneFrame()) return 0L
} catch (e: IOException) {
failWebSocket(e, null)
}
return -1L
}
}
//以下是schedule方法轉到WriterTask的runOnce方法過程
//TaskQueue.kt
fun schedule(task: Task, delayNanos: Long = 0L) {
synchronized(taskRunner) {
if (scheduleAndDecide(task, delayNanos, recurrence = false)) {
taskRunner.kickCoordinator(this)
}
}
}
internal fun scheduleAndDecide(task: Task, delayNanos: Long, recurrence: Boolean): Boolean {
//***
if (insertAt == -1) insertAt = futureTasks.size
futureTasks.add(insertAt, task)
// Impact the coordinator if we inserted at the front.
return insertAt == 0
}
//TaskRunner.kt
internal fun kickCoordinator(taskQueue: TaskQueue) {
this.assertThreadHoldsLock()
if (taskQueue.activeTask == null) {
if (taskQueue.futureTasks.isNotEmpty()) {
readyQueues.addIfAbsent(taskQueue)
} else {
readyQueues.remove(taskQueue)
}
}
if (coordinatorWaiting) {
backend.coordinatorNotify(this@TaskRunner)
} else {
backend.execute(runnable)
}
}
private val runnable: Runnable = object : Runnable {
override fun run() {
while (true) {
val task = synchronized(this@TaskRunner) {
awaitTaskToRun()
} ?: return
logElapsed(task, task.queue!!) {
var completedNormally = false
try {
runTask(task)
completedNormally = true
} finally {
// If the task is crashing start another thread to service the queues.
if (!completedNormally) {
backend.execute(this)
}
}
}
}
}
}
private fun runTask(task: Task) {
try {
delayNanos = task.runOnce()
}
}
程式碼有點長，這裡是從runWriter開始跟的幾個方法，拿到writerTask實例後，存到TaskQueue的futureTasks列表里，然後到runnable這裡可以看到是一個while死循環，不斷的從futureTasks中取出Task並執行runTask方法，直到Task為空，循環停止。
其中涉及到兩個新的類：
TaskQueue類主要就是管理消息任務列表，保證按順序執行TaskRunner類主要就是做一些任務的具體操作，比如執行緒池裡執行任務，記錄消息任務的狀態（準備發送的任務隊列readyQueues，正在執行的任務隊列busyQueues等等）
而每一個Task最後都是執行到了WriterTask的runOnce方法，也就是writeOneFrame方法：
internal fun writeOneFrame(): Boolean {
synchronized(this@RealWebSocket) {
if (failed) {
return false // Failed web socket.
}
writer = this.writer
pong = pongQueue.poll()
if (pong == null) {
messageOrClose = messageAndCloseQueue.poll()
if (messageOrClose is Close) {
} else if (messageOrClose == null) {
return false // The queue is exhausted.
}
}
}
//發送消息邏輯，包括`pong`消息，普通消息，關閉消息
try {
if (pong != null) {
writer!!.writePong(pong)
} else if (messageOrClose is Message) {
val message = messageOrClose as Message
writer!!.writeMessageFrame(message.formatOpcode, message.data)
synchronized(this) {
queueSize -= message.data.size.toLong()
}
} else if (messageOrClose is Close) {
val close = messageOrClose as Close
writer!!.writeClose(close.code, close.reason)
// We closed the writer: now both reader and writer are closed.
if (streamsToClose != null) {
listener.onClosed(this, receivedCloseCode, receivedCloseReason!!)
}
}
return true
} finally {
streamsToClose?.closeQuietly()
readerToClose?.closeQuietly()
writerToClose?.closeQuietly()
}
}
這裡就會執行發送消息的邏輯了，主要有三種消息情況處理：
pong消息，這個主要是為伺服器端準備的，發送給客戶端回應心跳包。普通消息，就會把數據類型Opcode和具體數據發送過去關閉消息，其實當用戶執行close方法關閉WebSocket的時候，也是發送了一條Close控制幀消息給伺服器告知這個關閉需求，並帶上code狀態碼和reason關閉原因，然後伺服器端就會關閉當前連接。
好了。最後一步了，就是把這些數據組裝成WebSocket數據幀並寫入流，分成控制幀數據和普通消息數據幀：
//寫入（發送）控制幀
private fun writeControlFrame(opcode: Int, payload: ByteString) {
if (writerClosed) throw IOException("closed")
val length = payload.size
require(length <= PAYLOAD_BYTE_MAX) {
"Payload size must be less than or equal to $PAYLOAD_BYTE_MAX"
}
val b0 = B0_FLAG_FIN or opcode
sinkBuffer.writeByte(b0)
var b1 = length
if (isClient) {
b1 = b1 or B1_FLAG_MASK
sinkBuffer.writeByte(b1)
random.nextBytes(maskKey!!)
sinkBuffer.write(maskKey)
if (length > 0) {
val payloadStart = sinkBuffer.size
sinkBuffer.write(payload)
sinkBuffer.readAndWriteUnsafe(maskCursor!!)
maskCursor.seek(payloadStart)
toggleMask(maskCursor, maskKey)
maskCursor.close()
}
} else {
sinkBuffer.writeByte(b1)
sinkBuffer.write(payload)
}
sink.flush()
}
//寫入（發送）普通消息數據幀
@Throws(IOException::class)
fun writeMessageFrame(formatOpcode: Int, data: ByteString) {
if (writerClosed) throw IOException("closed")
messageBuffer.write(data)
var b0 = formatOpcode or B0_FLAG_FIN
val dataSize = messageBuffer.size
sinkBuffer.writeByte(b0)
var b1 = 0
if (isClient) {
b1 = b1 or B1_FLAG_MASK
}
when {
dataSize <= PAYLOAD_BYTE_MAX -> {
b1 = b1 or dataSize.toInt()
sinkBuffer.writeByte(b1)
}
dataSize <= PAYLOAD_SHORT_MAX -> {
b1 = b1 or PAYLOAD_SHORT
sinkBuffer.writeByte(b1)
sinkBuffer.writeShort(dataSize.toInt())
}
else -> {
b1 = b1 or PAYLOAD_LONG
sinkBuffer.writeByte(b1)
sinkBuffer.writeLong(dataSize)
}
}
if (isClient) {
random.nextBytes(maskKey!!)
sinkBuffer.write(maskKey)
if (dataSize > 0L) {
messageBuffer.readAndWriteUnsafe(maskCursor!!)
maskCursor.seek(0L)
toggleMask(maskCursor, maskKey)
maskCursor.close()
}
}
sinkBuffer.write(messageBuffer, dataSize)
sink.emit()
}
大家應該都能看懂了吧，其實就是組裝數據幀，包括Opcode，mask，數據長度等等。兩個方法的不同就在於普通數據需要判斷數據長度的三種情況，再組裝數據幀。最後都會通過sinkBuffer寫入到輸出數據流。
終於，基本的流程說的差不多了。其中還有很多細節，同學們可以自己花時間看看琢磨琢磨，比如Okio部分。還是那句話，希望大家有空自己也讀一讀相關源碼，這樣理解才能深刻，而且你肯定會發現很多我沒說到的細節，歡迎大家討論。我也會繼續努力，最後大家給我加個油點個贊吧，感謝感謝。
總結
再來個圖總結下吧！🎉
參考
附件
我的公眾號：碼上積木，每天三問面試題，詳細剖析，助你成為offer收割機。
謝謝你的閱讀，如果你覺得寫的還行，就點個贊支援下吧！感謝！
你的一個👍，就是我分享的動力❤️。
