WebSocket斷開緣由、心跳機制防止自動斷開鏈接

一、斷開緣由

WebSocket斷開的緣由有不少,最好在WebSocket斷開時,將錯誤打印出來。nginx

ws.onclose = function (e) { console.log('websocket 斷開: ' + e.code + ' ' + e.reason + ' ' + e.wasClean) console.log(e) }

錯誤狀態碼:web

WebSocket斷開時,會觸發CloseEvent, CloseEvent會在鏈接關閉時發送給使用 WebSockets 的客戶端. 它在 WebSocket 對象的 onclose 事件監聽器中使用。CloseEvent的code字段表示了WebSocket斷開的緣由。能夠從該字段中分析斷開的緣由。後端

CloseEvent有三個字段須要注意, 經過分析這三個字段,通常就能夠找到斷開緣由瀏覽器

  • CloseEvent.code: code是錯誤碼,是整數類型
  • CloseEvent.reason: reason是斷開緣由,是字符串
  • CloseEvent.wasClean: wasClean表示是否正常斷開,是布爾值。通常異常斷開時,該值爲false
狀態碼 名稱 描述
0–999   保留段, 未使用.
1000 CLOSE_NORMAL 正常關閉; 不管爲什麼目的而建立, 該連接都已成功完成任務.
1001 CLOSE_GOING_AWAY 終端離開, 可能由於服務端錯誤, 也可能由於瀏覽器正從打開鏈接的頁面跳轉離開.
1002 CLOSE_PROTOCOL_ERROR 因爲協議錯誤而中斷鏈接.
1003 CLOSE_UNSUPPORTED 因爲接收到不容許的數據類型而斷開鏈接 (如僅接收文本數據的終端接收到了二進制數據).
1004   保留. 其意義可能會在將來定義.
1005 CLOSE_NO_STATUS 保留. 表示沒有收到預期的狀態碼.
1006 CLOSE_ABNORMAL 保留. 用於指望收到狀態碼時鏈接非正常關閉 (也就是說, 沒有發送關閉幀).
1007 Unsupported Data 因爲收到了格式不符的數據而斷開鏈接 (如文本消息中包含了非 UTF-8 數據).
1008 Policy Violation 因爲收到不符合約定的數據而斷開鏈接. 這是一個通用狀態碼, 用於不適合使用 1003 和 1009 狀態碼的場景.
1009 CLOSE_TOO_LARGE 因爲收到過大的數據幀而斷開鏈接.
1010 Missing Extension 客戶端指望服務器商定一個或多個拓展, 但服務器沒有處理, 所以客戶端斷開鏈接.
1011 Internal Error 客戶端因爲遇到沒有預料的狀況阻止其完成請求, 所以服務端斷開鏈接.
1012 Service Restart 服務器因爲重啓而斷開鏈接.
1013 Try Again Later 服務器因爲臨時緣由斷開鏈接, 如服務器過載所以斷開一部分客戶端鏈接.
1014   由 WebSocket標準保留以便將來使用.
1015 TLS Handshake 保留. 表示鏈接因爲沒法完成 TLS 握手而關閉 (例如沒法驗證服務器證書).
1016–1999   由 WebSocket標準保留以便將來使用.
2000–2999   由 WebSocket拓展保留使用.
3000–3999   能夠由庫或框架使用.? 不該由應用使用. 能夠在 IANA 註冊, 先到先得.
4000–4999   能夠由應用使用.

 

二、加入心跳

var lockReconnect = false;  //避免ws重複鏈接
var ws = null;          // 判斷當前瀏覽器是否支持WebSocket
var wsUrl = serverConfig.socketUrl; createWebSocket(wsUrl); //鏈接ws

function createWebSocket(url) { try{ if('WebSocket' in window){ ws = new WebSocket(url); } initEventHandle(); }catch(e){ reconnect(url); console.log(e); } } function initEventHandle() { ws.onclose = function () { reconnect(wsUrl); console.log("llws鏈接關閉!"+new Date().toLocaleString()); }; ws.onerror = function () { reconnect(wsUrl); console.log("llws鏈接錯誤!"); }; ws.onopen = function () { heartCheck.reset().start(); //心跳檢測重置
        console.log("llws鏈接成功!"+new Date().toLocaleString()); }; ws.onmessage = function (event) {    //若是獲取到消息,心跳檢測重置
        heartCheck.reset().start();      //拿到任何消息都說明當前鏈接是正常的
        console.log("llws收到消息啦:" +event.data); if(event.data!='pong'){ let data = JSON.parse(event.data); } }; } // 監聽窗口關閉事件,當窗口關閉時,主動去關閉websocket鏈接,防止鏈接還沒斷開就關閉窗口,server端會拋異常。
window.onbeforeunload = function() { ws.close(); } function reconnect(url) { if(lockReconnect) return; lockReconnect = true; setTimeout(function () {     //沒鏈接上會一直重連,設置延遲避免請求過多
 createWebSocket(url); lockReconnect = false; }, 2000); } //心跳檢測
var heartCheck = { timeout: 1000,        //1分鐘發一次心跳
    timeoutObj: null, serverTimeoutObj: null, reset: function(){ clearTimeout(this.timeoutObj); clearTimeout(this.serverTimeoutObj); return this; }, start: function(){ var self = this; this.timeoutObj = setTimeout(function(){ //這裏發送一個心跳,後端收到後,返回一個心跳消息,
            //onmessage拿到返回的心跳就說明鏈接正常
            ws.send("ping"); console.log("ping!") self.serverTimeoutObj = setTimeout(function(){//若是超過必定時間還沒重置,說明後端主動斷開了
                ws.close();     //若是onclose會執行reconnect,咱們執行ws.close()就好了.若是直接執行reconnect 會觸發onclose致使重連兩次
 }, self.timeout) }, this.timeout) } } 
// 收到客戶端消息後調用的方法 
 @OnMessage public void onMessage(String message, Session session) { if(message.equals("ping")){ }else{ 。。。。 } }

系統發現websocket每隔1分鐘自動斷開鏈接,搜了不少博客都說設置一下nginx的
proxy_read_timeout
可是這個時間過長會影響服務器性能,採起心跳包的方式每隔1分鐘客戶端自動發送ping消息給服務端,服務端須要返回pong。便可解決問題。服務器

相關文章
相關標籤/搜索