使用Netty實(shí)現(xiàn)一個(gè)IM即時(shí)通訊系統(tǒng)的設(shè)計(jì)

實(shí)戰(zhàn)篇一的代碼結(jié)構(gòu)：

代碼的層級(jí)結(jié)構(gòu)如上所示，接下來(lái)，我們將會(huì)一個(gè)個(gè)模塊對(duì)邏輯進(jìn)行講解。

1、登錄

1）實(shí)現(xiàn)邏輯

不管是長(zhǎng)連接還是短連接，鑒權(quán)這個(gè)動(dòng)作都是要有的，我相信這個(gè)功能模塊，大家是很好理解的。我這里就不在過(guò)多的贅述了，具體實(shí)現(xiàn)步驟如下所示：

1、前后端建立 ws 連接

2、前端發(fā)送登錄類(lèi)型的報(bào)文，如下所示：

{
"token":"2",
"type":"10"
}

token：這里的 token，就是用戶(hù)登錄標(biāo)識(shí)，大家可以根據(jù)自己所依賴(lài)的業(yè)務(wù)系統(tǒng)，進(jìn)行修改。

type：這里表示消息報(bào)文的類(lèi)型，本文所有類(lèi)型定義如下所示：

USER_LOGIN (10, "用戶(hù)上線")

USER_LOGIN_RESP (11, "用戶(hù)上線響應(yīng)")

HEARTBEAT_TIMEOUT (30, "心跳超時(shí)")

PING (40, "心跳")

PONG (41, "心跳響應(yīng)")

CHAT (80, "聊天"),

CHAT_RESP (81, "聊天響應(yīng)")

ACK (90, "確認(rèn)")

ACK_RESP (91, "確認(rèn)響應(yīng)")

UNKNOWN (0, "未知類(lèi)型")

示例代碼如下圖所示，WsMsgDispatcher.dispatch

消息類(lèi)型

3、后端對(duì) token 進(jìn)行校驗(yàn)，校驗(yàn)成功就記錄用戶(hù)登錄信息。

示例代碼如下圖所示，UserLoginProcessor.login

登錄業(yè)務(wù)邏輯

2）具體效果

主要的業(yè)務(wù)代碼我們已經(jīng)講解完畢了，接下來(lái)我們來(lái)看看效果：

用戶(hù)登錄

從上圖，我們可以看到，我們登錄的兩個(gè)用戶(hù)都成功了，并且返回了對(duì)應(yīng)的用戶(hù)信息。

2、維持連接、心跳檢測(cè)

這個(gè)模塊的功能，其實(shí)我們在原理篇二的時(shí)候已經(jīng)講過(guò)了具體的實(shí)現(xiàn)方案 了，這里也不再過(guò)多的贅述了，我們直接來(lái)看具體實(shí)現(xiàn)方法吧。

1）維持連接

1、前端每10秒發(fā)送一次心跳消息，報(bào)文如下所示：

{
"type":"40",
"fromId":"2"
}

注：前端發(fā)送的每個(gè)消息，理論上都是需要帶上用戶(hù)表示的，后端都是需要進(jìn)行鑒權(quán)操作的。我們這里為了方便講解（偷懶，bushi）將這部分邏輯進(jìn)行了簡(jiǎn)化，大家在具體實(shí)現(xiàn)的時(shí)候，記得一定要加上 鑒權(quán)邏輯 。

2、后端檢測(cè)，用戶(hù)是否還在線，如果在線，則刷新用戶(hù)的最新在線時(shí)間，并回復(fù) PONG 消息。

示例代碼如下圖所示，HeartBeatProcessor.process

維持連接1



維持連接2

2）心跳檢測(cè)

這里主要是基于 IdleStateEvent 事件實(shí)現(xiàn)的。

TextWebSocketFrameHandler 繼承 SimpleChannelInboundHandler 類(lèi)，并實(shí)現(xiàn) userEventTriggered 方法，具體代碼如下所示：

心跳檢測(cè)

這里詳細(xì)說(shuō)一下，三種事件的區(qū)別：

readerIdleTimeSeconds： 讀超時(shí)。即當(dāng)在指定的時(shí)間間隔內(nèi)沒(méi)有從 Channel 讀取到數(shù)據(jù)時(shí)，會(huì)觸發(fā)一個(gè) READER_IDLE 的 IdleStateEvent 事件。

writerIdleTimeSeconds: 寫(xiě)超時(shí)。即當(dāng)在指定的時(shí)間間隔內(nèi)沒(méi)有數(shù)據(jù)寫(xiě)入到 Channel 時(shí)，會(huì)觸發(fā)一個(gè) WRITER_IDLE 的 IdleStateEvent 事件。

allIdleTimeSeconds: 讀/寫(xiě)超時(shí)。即當(dāng)在指定的時(shí)間間隔內(nèi)沒(méi)有讀且沒(méi)有寫(xiě)操作時(shí)，會(huì)觸發(fā)一個(gè) ALL_IDLE 的 IdleStateEvent 事件。

所以，我們這里檢測(cè) ALL_IDLE 事件即可。

3）具體效果

維持連接效果如下所示：

維持連接效果

心跳檢測(cè)效果如下所示：

心跳超時(shí)效果1

心跳超時(shí)效果2

3、聊天消息

聊天消息模塊主要分為兩部分：

消息接收：客戶(hù)端推送消息到服務(wù)端

消息推送：服務(wù)端將消息推送到指定的客戶(hù)端

這邊主要的難點(diǎn)在于，服務(wù)端將消息推送到指定的客戶(hù)端，具體場(chǎng)景有2種情況：

消息的發(fā)送者和消息的接受者，在同一臺(tái)服務(wù)器上建立的 ws 連接，這種情況，就很好處理，直接在服務(wù)器上找到建立的 ws 連接，然后將消息推送給對(duì)應(yīng)的客戶(hù)端。

消息的發(fā)送者和消息的接受者，在不同的服務(wù)器上建立的 ws 連接，這種情況就比較復(fù)雜，實(shí)現(xiàn)方案也很多，比較簡(jiǎn)單的實(shí)現(xiàn)方式就是，發(fā)送一條廣播消息，讓對(duì)應(yīng)的服務(wù)器，將消息推送到指定的客戶(hù)端。

本文由于是 單機(jī)版 的 im，所以只會(huì)有第一種情況發(fā)生，第二種情況就留給大家自由發(fā)揮了。

1）消息接收

具體步驟如下所示：

1、客戶(hù)端發(fā)送類(lèi)型為80的報(bào)文，如下所示：

{
"type":"80",
"fromId":"1",
"toId":"2",
"content":{
"contentType":1,
"body":"測(cè)試消息"
}
}

2、服務(wù)端(ChatProcessor)對(duì)消息進(jìn)行處理，具體代碼如下所示：

消息接收

2）消息推送

具體步驟如下所示：

1、獲取消息接受者所連接的服務(wù)器 ip 地址 2、判斷當(dāng)前服務(wù)器 ip 地址是否和上面的 ip 地址相同，如果相同則推送消息，否則轉(zhuǎn)發(fā)給目標(biāo)服務(wù)器

具體代碼如下所示:

消息推送

3）具體效果

1、我們先登錄兩個(gè)用戶(hù)，分別是張三、李四，如下圖所示：

聊天登錄

2、張三發(fā)送消息給李四，如下圖所示：

張三發(fā)送消息給李四

3、李四發(fā)送消息給張三，如下圖所示：

李四發(fā)送消息給張三

4、消息 ack

因?yàn)?a target="_blank">網(wǎng)絡(luò)環(huán)境異常或者其他異常狀況的發(fā)送，可能會(huì)出現(xiàn)消息推送失敗的情況，這時(shí)候就需要 消息 ack 機(jī)制和重試，來(lái)保證我們的消息可以推送成功。

1）消息 ack 機(jī)制

具體步驟如下：

1、客戶(hù)端收到 80 類(lèi)型的消息，解析并發(fā)送 ack 報(bào)文，如下所示：

{
"type":"90",
"msgId":"2bfea133-72a8-4315-82aa-80049fe4fb7b"
}

2、服務(wù)端收到 ack 消息，變更消息狀態(tài)(AckProcessor)，具體代碼如下圖所示：

消息ack

2）消息重試

這里因?yàn)槭菃螜C(jī)版 im，所以直接采用 SpringBoot-Job 實(shí)現(xiàn)，Job 代碼如下所示：

消息重試

審核編輯：劉清