小程序websocket心跳庫——websocket-heartbeat-miniprogram

前言

在16年的時候因為項目接觸到websocket，而后對心跳重連做了一次總結，寫了篇博客，而后18年對之前github上的demo代碼進行了再次開發和開源，最終封裝成庫。如下：

• 博客：https://www.cnblogs.com/1wen/p/5808276.html
• github: https://github.com/zimv/websocket-heartbeat-js
• npm: https://www.npmjs.com/package/websocket-heartbeat-js

在2020年也就是今年初，同事建議說可以考慮兼容一下小程序，心想也挺好的。便有了今天的 websocket-heartbeat-miniprogram，這次基於以前的代碼新建了一個項目，只做小程序的版本，因為涉及到各種小程序以及相關框架的兼容，覺得還是單獨出一個包，更專注一點。

介紹

websocket-heartbeat-miniprogram基於小程序的websocket相關API進行封裝，主要目的是保障客戶端websocket與服務端連接狀態。該程序有心跳檢測及自動重連機制，當網絡斷開或者后端服務問題造成客戶端websocket斷開，程序會自動嘗試重新連接直到再次連接成功。兼容市面上大部分小程序微信，百度，支付寶等，只要都是統一的小程序weboscket-API規范。也支持小程序框架比如Taro等。無論如何，業務是需要一層心跳機制的，否則一些情況下會丟失連接導致功能無法使用。

用法

安裝

npm install --save websocket-heartbeat-miniprogram

　　

引入使用

import WebsocketHeartbeat from 'websocket-heartbeat-miniprogram';
WebsocketHeartbeat({
    miniprogram: wx,
    connectSocketParams: {
        url: 'ws://xxx'
    }
})
    .then(task => {
        task.onOpen = () => {//鈎子函數
            console.log('open');
        };
        task.onClose = （） => {//鈎子函數
            console.log('close');
        };
        task.onError = e => {//鈎子函數
            console.log('onError：', e);
        };
        task.onMessage = data => {//鈎子函數
            console.log('onMessage', data);
        };
        task.onReconnect = () => {//鈎子函數
            console.log('reconnect...');
        };
        task.socketTask.onOpen(data => {//原生實例注冊函數，重連后丟失
            console.log('socketTask open');
        });
        task.socketTask.onMessage(data => {//原生實例注冊函數，重連后丟失
            console.log('socketTask data');
        });
    })

　　

本程序內部總是使用小程序connectSocket方法進行socket連接，如果socket斷開，本程序內部會再次執行小程序的connectSocket方法，以此來重新建立連接，重連都會建立新的小程序socket實例。

WebsocketHeartbeat方法返回一個promise，返回的task對象是本程序的一個實例,提供了onOpen,onClose,onError,onMessage,onReconnect等鈎子函數。也暴露了小程序本身的實例（socketTask），task.socketTask就是小程序connectSocket返回的實例，而task.socketTask是小程序的原生實例，它們通過onXXX方法傳遞函數進行監聽注冊，在socket重連以后，內部重新通過connectSocket新建實例，將會返回新的小程序原生實例，因此之前通過socketTask.onXXX注冊的這些函數將會丟失。而本程序內部提供的鈎子函數重連上以后依然有效。大部分情況下推薦就使用本程序的鈎子函數。

支付寶小程序差異

支付寶小程序只允許同時存在一個socket連接，原生的API也和其他小程序有一點小差異，本程序已經做了兼容，但是還是要注意支付寶只允許建立一個socket，如果建立多個socket，前面的socket都會被系統關閉，一定要通過本程序實例的task.close關閉舊的socket，否則程序會一直重連，導致所有socket相互沖突無法使用。

約定

1.只能通過前端主動關閉socket連接

如果需要斷開socket，應該執行task.close()方法。如果后端想要關閉socket，應該下發一個消息，前端判斷此消息，前端再調用task.close()方法關閉。因為無論是后端調用close還是因為其他原因造成的socket關閉，前端的socket都會觸發onClose事件，程序無法判斷是什么原因導致的關閉。因此本程序會默認嘗試重連。

import WebsocketHeartbeat from 'websocket-heartbeat-miniprogram';
WebsocketHeartbeat({
    miniprogram: wx,
    connectSocketParams: {
        url: 'ws://xxxx'
    }
})
    .then(task => {
        task.onMessage = data => {
            if(data.data == 'close') task.close();//關閉socket並且，不再重連
        };
    })

　　

2.后端對前端心跳的反饋

前端發送心跳消息，后端收到后，需要立刻返回響應消息，后端響應的消息可以是任何值，因為本程序並不處理和判斷響應的心跳消息，而只是在收到任何消息后，重置心跳，因為收到任何消息就說明連接是正常的。因此本程序收到任何后端返回的消息都會重置心跳倒計時，以此來減少不必要的請求，減少服務器壓力。

---

API

詳情參考： https://github.com/zimv/websocket-heartbeat-miniprogram

結語

程序已經經過單元測試，也在百度，支付寶，微信等小程序之中實際測試和基於Taro測試。程序長期維護，發現兼容問題或者程序問題，希望得到issue反饋！