一、基本介紹

MobileIMSDK - 微信小程序端是一套基于微信原生 WebSocket 的即時(shí)通訊庫(kù)：

• 1）超輕量級(jí)、無(wú)任何第 3 方庫(kù)依賴（開(kāi)箱即用）；

• 2）純 JS 編寫、ES6 語(yǔ)法、高度提煉，簡(jiǎn)單易用；

• 3）基于微信原生 WebSocket API，簡(jiǎn)潔優(yōu)雅；

• 4）支持運(yùn)行于任何支持微信小程序的手機(jī)端；

• 5）能與?MobileIMSDK?的各種客戶端完美互通；

• 6）可應(yīng)用于微信小程序中的消息推送、客服聊天、企業(yè) OA、IM 等場(chǎng)景。

二、與 MobileIMSDK 的關(guān)系

MobileIMSDK - 微信小程序端是基于微信原生 WebSocket 協(xié)議的?MobileIMSDK?配套客戶端庫(kù)。

MobileIMSDK?是一套專為移動(dòng)端開(kāi)發(fā)的開(kāi)源原創(chuàng) IM 通信層框架：

• 歷經(jīng) 8 年、久經(jīng)考驗(yàn)；

• 超輕量級(jí)、高度提煉，lib 包 50KB 以內(nèi)；

• 精心封裝，一套 API 同時(shí)支持?UDP、TCP、WebSocket?三種協(xié)議（可能是全網(wǎng)唯一開(kāi)源的）；

• 客戶端支持?iOS、Android、標(biāo)準(zhǔn) Java、H5、小程序、Uniapp(開(kāi)發(fā)中..)；

• 服務(wù)端基于 Netty，性能卓越、易于擴(kuò)展；??

• 可與姊妹工程?MobileIMSDK-Web?無(wú)縫互通實(shí)現(xiàn)網(wǎng)頁(yè)端聊天或推送等；??

• 可應(yīng)用于跨設(shè)備、跨網(wǎng)絡(luò)的聊天 APP、企業(yè) OA、消息推送等各種場(chǎng)景。

以下是?MobileIMSDK?的最新通信架構(gòu)圖：

PS：MobileIMSDK?的客戶端庫(kù)一直在持續(xù)開(kāi)發(fā)和升級(jí)中，目前?基于 Uniapp 的 MobileIMSDK 客戶端正在開(kāi)發(fā)中?。

三、設(shè)計(jì)目標(biāo)

直接使用原生的微信小程序 WebSocket 有以下問(wèn)題和劣勢(shì)：

• 1）功能有限：沒(méi)有心跳?；睢嗑€重連、消息送達(dá)保證（重傳和去重）等即時(shí)通訊關(guān)鍵算法和邏輯；

• 2）API 簡(jiǎn)陋：在如此有限的原生 API?下，能邏輯清晰地實(shí)現(xiàn)并組合心跳保活、斷線重連、消息送達(dá)保證等算法，需要相當(dāng)高的技術(shù)掌控力；

• 3）邏輯耦合：經(jīng)驗(yàn)欠缺的開(kāi)發(fā)人員，會(huì)將 WebSocket 通信與前端 UI 界面代碼混在一起，使得 UI 界面的重構(gòu)、維護(hù)、改版都非常困難。

針對(duì)以上問(wèn)題，而?MobileIMSDK - 微信小程序端庫(kù)將讓開(kāi)發(fā)者專注于 UI 應(yīng)用層的開(kāi)發(fā)，網(wǎng)絡(luò)通信層的專業(yè)代碼交由 SDK 開(kāi)發(fā)人員，從而解偶 UI 前端和通信層的邏輯耦合性，大大降低技術(shù)復(fù)雜性。

MobileIMSDK - 微信小程序端庫(kù)的設(shè)計(jì)目標(biāo)是為您的開(kāi)發(fā)帶來(lái)以下便利：

• 1）界面與通信解偶：UI 界面與網(wǎng)絡(luò)通信代碼解耦，UI 界面的重構(gòu)、維護(hù)、改版都非常容易和優(yōu)雅；

• 2）輕量級(jí)和兼容性：受益于堅(jiān)持原生微信小程序 WebSocket API，簡(jiǎn)潔輕量，無(wú)需任何額外依賴；

• 3）核心內(nèi)聚和收斂：得益于長(zhǎng)期的提煉和經(jīng)驗(yàn)積累，SDK 核心層高度封裝，開(kāi)發(fā)者無(wú)需理解復(fù)雜算法即可簡(jiǎn)單上手。

• 4）純 JS 輕量級(jí)實(shí)現(xiàn)：SDK 為純 JS 編寫、ES6 語(yǔ)法，無(wú)重量級(jí)框架和庫(kù)依賴，可干凈利落地對(duì)接各種既有系統(tǒng)。

四、技術(shù)亮點(diǎn)

• 輕量易使用：超輕量級(jí) —— 純 JS 編寫且無(wú)任何第 3 方庫(kù)依賴，高度提煉 —— 簡(jiǎn)單易用；

• 代碼現(xiàn)代感：盡可能優(yōu)先使用 ES6 語(yǔ)法，摒棄舊式 JS 語(yǔ)法的年代感；

• 兼容性很好：基于微信原生 WebSocket API，可很好地運(yùn)行于支持微信小程序的手機(jī)端；

• 斷網(wǎng)恢復(fù)能力：擁有網(wǎng)絡(luò)狀況自動(dòng)檢測(cè)、斷網(wǎng)自動(dòng)治愈的能力；

• 送達(dá)保證機(jī)制：完善的 QoS 消息送達(dá)保證機(jī)制（多重保障），不漏過(guò)每一條消息；

• 通信協(xié)議封裝：實(shí)現(xiàn)了一個(gè)對(duì)上層透明的即時(shí)通訊通信協(xié)議模型；

• 身份認(rèn)證機(jī)制：實(shí)現(xiàn)了簡(jiǎn)單合理的身份認(rèn)證機(jī)制；

• 完善的 log 信息：在開(kāi)發(fā)調(diào)試階段，確保每一個(gè)算法關(guān)鍵步驟都有日志輸出，讓您的運(yùn)行調(diào)試更為便利；

• 界面代碼解耦：實(shí)現(xiàn)了 UI 界面代碼與 SDK 網(wǎng)絡(luò)通信代碼解偶，防止界面代碼跟 IM 核心代碼混在一起，不利于持續(xù)升級(jí)、重用和維護(hù)；

• 聊天協(xié)議兼容：實(shí)現(xiàn)了與?MobileIMSDK 各種客戶端完全兼容的協(xié)議模型。

五、文件組成

SDK代碼文件概覽：

SDK代碼文件用途說(shuō)明：

六、技術(shù)交流?

學(xué)習(xí)和資料：點(diǎn)擊進(jìn)入、bug和建議：點(diǎn)擊進(jìn)入

七、Demo運(yùn)行截圖

1）Demo的真機(jī)運(yùn)行效果和功能說(shuō)明圖：

2）Demo在模擬器下的運(yùn)行效果：

3）Demo真機(jī)運(yùn)行實(shí)拍圖：

八、詳盡開(kāi)發(fā)者手冊(cè)

① 開(kāi)發(fā)者手冊(cè)（網(wǎng)頁(yè)版）：MobileIMSDK的微信小程序端開(kāi)發(fā)快速入門??

② 開(kāi)發(fā)者手冊(cè)（PDF精編版）：

?

九、引用資料

[1]?微信小程序開(kāi)發(fā)者手冊(cè)
[2]?MobileIMSDK開(kāi)源框架的API文檔
[3]?MobileIMSDK開(kāi)源IM框架源碼（Github地址點(diǎn)此）
[4]?開(kāi)源輕量級(jí) IM 框架 MobileIMSDK 的微信小程序端已發(fā)布
[5]?開(kāi)源即時(shí)通訊框架MobileIMSDK的微信小程序端開(kāi)發(fā)者手冊(cè)