為什么需要心跳檢測(cè)？

正常的情況客戶端斷開連接會(huì)向服務(wù)端發(fā)送一個(gè)fin包，服務(wù)端收到fin包后得知客戶端連接斷開，則立刻觸發(fā)onClose事件回調(diào)。

心跳包格式：WebSocket協(xié)議RFC6455中有定義控制幀的格式Ping幀包含一個(gè)操作碼0x9，Pong幀包含一個(gè)操作碼0xA?？蛻舳税l(fā)送Ping幀，服務(wù)端收到Ping幀后回一個(gè)響應(yīng)Pong幀。

但是有些極端情況如客戶端掉電、網(wǎng)絡(luò)關(guān)閉、拔網(wǎng)線、路由故障等，這些極端情況客戶端無法發(fā)送fin包給服務(wù)端，服務(wù)端便無法知道連接已經(jīng)斷開。如果客戶端與服務(wù)端定時(shí)有心跳數(shù)據(jù)傳輸，則會(huì)比較及時(shí)的發(fā)現(xiàn)連接斷開，觸發(fā)onClose事件回調(diào)。

另外路由節(jié)點(diǎn)防火墻會(huì)關(guān)閉長(zhǎng)時(shí)間不通訊的socket連接，導(dǎo)致socket長(zhǎng)連接斷開。所以需要客戶端與服務(wù)端定時(shí)發(fā)送心跳數(shù)據(jù)保持連接不被斷開。

心跳原理

客戶端定時(shí)每X秒(推薦小于60秒)向服務(wù)端發(fā)送特定數(shù)據(jù)(任意數(shù)據(jù)都可)，服務(wù)端設(shè)定為X秒沒有收到客戶端心跳則認(rèn)為客戶端掉線，并關(guān)閉連接觸發(fā)onClose回調(diào)。這樣即通過心跳檢測(cè)請(qǐng)求維持了連接(避免連接因長(zhǎng)時(shí)間不活躍而被網(wǎng)關(guān)防火墻關(guān)閉)，也能讓服務(wù)端比較及時(shí)的知道客戶端是否異常掉線。

心跳包機(jī)制

WebSocket心跳包機(jī)制WebSocket心跳包是WebSocket協(xié)議的?；顧C(jī)制，用于維持長(zhǎng)連接。有效的心跳包可以防止長(zhǎng)時(shí)間不通訊時(shí)，WebSocket自動(dòng)斷開連接。

心跳包是指在一定時(shí)間間隔內(nèi)，WebSocket發(fā)送的空數(shù)據(jù)包。常見的WebSocket心跳包機(jī)制如下：

客戶端

客戶端定時(shí)向服務(wù)器發(fā)送心跳數(shù)據(jù)包，以保持長(zhǎng)連接。

this.heartbeatTimer = setInterval(() => {
    ws.send('{"event":"ping","content":"ping heartbeat"}');
}, originData.ping_interval)

服務(wù)端

服務(wù)器定時(shí)向客戶端發(fā)送心跳數(shù)據(jù)包，以檢測(cè)客戶端連接是否正常。

$gateway = new Gateway("websocket://0.0.0.0:8783");

$gateway->pingInterval = 55;

$gateway->pingNotResponseLimit = 0;

// 服務(wù)端定時(shí)向客戶端發(fā)送的數(shù)據(jù)
$gateway->pingData = '{"type":"ping"}';

以上服務(wù)端會(huì)定時(shí)55秒給客戶端發(fā)心跳數(shù)據(jù){"type":"ping"}，而客戶端不需要定時(shí)向服務(wù)端發(fā)送心跳數(shù)據(jù)。

• pingNotResponseLimit = 0代表服務(wù)端允許客戶端不發(fā)送心跳，服務(wù)端不會(huì)因?yàn)榭蛻舳碎L(zhǎng)時(shí)間沒發(fā)送數(shù)據(jù)而斷開連接。
• pingNotResponseLimit = 1，則代表客戶端必須定時(shí)發(fā)送數(shù)據(jù)給服務(wù)端，否則pingNotResponseLimit*pingInterval=55秒內(nèi)沒有任何數(shù)據(jù)發(fā)來則關(guān)閉對(duì)應(yīng)連接，并觸發(fā)onClose。

說明

• Gateway::$pingInterval心跳檢測(cè)時(shí)間間隔 單位：秒。如果設(shè)置為0代表不做任何心跳檢測(cè)。
• Gateway::$pingNotResponseLimit 客戶端連續(xù)$pingNotResponseLimit次$pingInterval時(shí)間內(nèi)不發(fā)送任何數(shù)據(jù)(包括但不限于心跳數(shù)據(jù))則斷開鏈接，并觸發(fā)onClose。如果設(shè)置為0代表客戶端不用發(fā)送心跳數(shù)據(jù)，即通過TCP層面檢測(cè)連接的連通性（極端情況至少10分鐘才能檢測(cè)到連接斷開，甚至可能永遠(yuǎn)檢測(cè)不到）
• Gateway::$pingData 當(dāng)需要服務(wù)端定時(shí)給客戶端發(fā)送心跳數(shù)據(jù)時(shí)， $gateway->pingData設(shè)置為服務(wù)端要發(fā)送的心跳請(qǐng)求數(shù)據(jù)，心跳數(shù)據(jù)是任意的，只要客戶端能識(shí)別即可?？蛻舳耸盏叫奶鴶?shù)據(jù)可以忽略不做任何處理。

注意

當(dāng)設(shè)置為服務(wù)端主動(dòng)發(fā)送心跳時(shí)，心跳間隔并不是100%精準(zhǔn)。當(dāng)客戶端連接成功后，服務(wù)端發(fā)來的第一個(gè)心跳的時(shí)間間隔可能要小于服務(wù)器設(shè)置的值。

當(dāng)設(shè)置為服務(wù)端主動(dòng)發(fā)送心跳時(shí)，如果客戶端最近有發(fā)來數(shù)據(jù)，那么證明客戶端存活，服務(wù)端會(huì)省略一個(gè)心跳，下個(gè)心跳大約1.5*$gateway->pingInterval秒后發(fā)送。

如果心跳是客戶端發(fā)送，$gateway->pingNotResponseLimit最好大于0，這樣可以及時(shí)檢測(cè)到一些死連接(連接已經(jīng)斷開，但是服務(wù)端不知道)

心跳機(jī)制原理

WebSocket心跳機(jī)制的原理是利用心跳包及時(shí)發(fā)送和接收數(shù)據(jù)，保證WebSocket長(zhǎng)連接不被斷開。

WebSocket心跳機(jī)制的原理可以用下面的流程來說明：

1. 客戶端建立WebSocket連接。
2. 客戶端向服務(wù)器發(fā)送心跳數(shù)據(jù)包，服務(wù)器接收并返回一個(gè)表示接收到心跳數(shù)據(jù)包的響應(yīng)。
3. 當(dāng)服務(wù)器沒有及時(shí)接收到客戶端發(fā)送的心跳數(shù)據(jù)包時(shí)，服務(wù)器會(huì)發(fā)送一個(gè)關(guān)閉連接的請(qǐng)求。
4. 服務(wù)器定時(shí)向客戶端發(fā)送心跳數(shù)據(jù)包，客戶端接收并返回一個(gè)表示接收到心跳數(shù)據(jù)包的響應(yīng)。
5. 當(dāng)客戶端沒有及時(shí)接收到服務(wù)器發(fā)送的心跳數(shù)據(jù)包時(shí)，客戶端會(huì)重新連接WebSocket

心跳機(jī)制作用

• 保持WebSocket連接不被斷開。
• 檢測(cè)WebSocket連接狀態(tài)，及時(shí)處理異常情況。
• 減少WebSocket連接及服務(wù)器資源的消耗。

完整代碼

服務(wù)端心跳（不推薦）

修改配置文件config\plugin\webman\gateway-worker\process.php進(jìn)程配置文件。

'pingInterval' => 30,
'pingNotResponseLimit' => 0,
'pingData' => '{"event":"ping","msg":"我是服務(wù)端主動(dòng)心跳檢測(cè)"}',

控制臺(tái)檢測(cè)記錄

圖片

客戶端心跳（推薦）

let $timeout = null;
let ws = new WebSocket("ws://127.0.0.1:8783");
ws.onopen = function(evt) {
    let $_content = {
        "event": "join",
        "mode": 1,
        "group_id": 0,
        "from_user_id": "10086",
        "from_username": "開源技術(shù)小棧",
        "to_user_id": "10000",
        "content": "加入會(huì)話",
    };
    ws.send(JSON.stringify($_content));
};

ws.onmessage = function(evt) {
    console.log( "【開源技術(shù)小?！拷邮芟? " + evt.data);
    let _obj = JSON.parse(evt.data);
    if (_obj.data.event === 'init') {
        sendHeartbeat();
    }
};

function sendHeartbeat() {
    console.log('客戶端定時(shí)發(fā)送心跳');
    ws.send('{"event":"ping","content":"開源技術(shù)小棧我在線呢!"}');
    $timeout = setTimeout(sendHeartbeat, 3000);
}

ws.onclose = function() {
    clearTimeout($timeout);
    console.log('沒有網(wǎng)了，睡覺去了');
};

控制臺(tái)檢測(cè)記錄

圖片

斷線重連

不管是客戶端發(fā)送心跳還是服務(wù)端發(fā)送心跳，連接都有斷開的可能。例如瀏覽器最小化js被暫停、瀏覽器切換到其它tab頁面js被暫停、電腦進(jìn)入睡眠等等、移動(dòng)端切換網(wǎng)絡(luò)、信號(hào)變?nèi)酢⑹謾C(jī)黑屏、手機(jī)應(yīng)用切換到后臺(tái)、路由故障、業(yè)務(wù)主動(dòng)斷開等。尤其是外網(wǎng)環(huán)境復(fù)雜，很多路由節(jié)點(diǎn)會(huì)清理1分鐘內(nèi)不活躍的連接，這也是為什么心跳間隔推薦小于1分鐘的原因。

連接在外網(wǎng)環(huán)境很容易被斷開，所以斷線重連是長(zhǎng)連接應(yīng)用必須具備的功能(斷線重連只能客戶端做，服務(wù)端無法實(shí)現(xiàn))。例如瀏覽器websocket需要監(jiān)聽onclose事件，當(dāng)發(fā)生onclose時(shí)建立新的連接(為避免需崩可延建立連接)。更嚴(yán)格一點(diǎn)，服務(wù)端也應(yīng)該定時(shí)發(fā)起心跳數(shù)據(jù)，并且客戶端需要定時(shí)監(jiān)測(cè)服務(wù)端的心跳數(shù)據(jù)是否超時(shí)，超過規(guī)定時(shí)間未收到服務(wù)端心跳數(shù)據(jù)應(yīng)該認(rèn)定連接已經(jīng)斷開，需要執(zhí)行close關(guān)閉連接，并重新建立新的連接。