サーバーがWebSocketで再起動したときのクライアントの再接続


93

PHP5とChromeブラウザをクライアントとして使用して、Webソケットを使用しています。サイトhttp://code.google.com/p/phpwebsocket/からコードを取得しました。

サーバーを実行すると、クライアントも接続されます。チャットもできます。これで、サーバーを再起動すると(サーバーを強制終了して再起動すると)、クライアントは切断された情報を取得しますが、メッセージを送信してもサーバーに自動的に再接続しません。

これを達成する方法は?切断された情報を取得したときのように、それをチェックしてJavaScriptに送信してページを更新するか、再接続する必要がありますか?

回答:


143

サーバーが再起動すると、Webソケット接続が閉じられるため、JavaScript oncloseイベントがトリガーされます。5秒ごとに再接続を試みる例を次に示します。

function start(websocketServerLocation){
    ws = new WebSocket(websocketServerLocation);
    ws.onmessage = function(evt) { alert('message received'); };
    ws.onclose = function(){
        // Try to reconnect in 5 seconds
        setTimeout(function(){start(websocketServerLocation)}, 5000);
    };
}

3
新しいオブジェクトを作成してイベントアクションを定義せずに、よりエレガントな方法があることを願っています...
ciembor

3
5分後、ブラウザーはフリーズします。私だけですか?
マルク

16
「ws = null;」を追加する必要があります wsオブジェクトとeventHandligsの乗算を回避するためのsetTimeout()の前
最大

8
私が間違っている場合は修正してください。ただし、このコードは、ある程度の切断によりスタックオーバーフローが発生するため、危険です。これは、start戻ることなく、再帰的に呼び出すためです。
Forivin

10
@Forivinここではスタックオーバーフローの問題はありません。特定の時点でコードを実行するJavascriptにはシングルスレッドが1つしかないため、setTimeout()は、渡された関数が将来そのシングルスレッドが再び解放されたときに実行されるようにスケジュールします。ここでsetTimeout()が呼び出された後、スレッドは関数から戻り(スタックをクリア)、キュー内の次のイベントを処理します。最終的に、startを呼び出す匿名関数に到達し、スタックの最上位フレームとして呼び出されます。
臭い

39

Andrewによって提供されたソリューションは、接続が失われた場合にサーバーがいくつかのcloseイベントを送信する可能性があるため、完全には機能していません。

その場合、いくつかのsetTimoutを設定します。アンドリューによって与えられた解決策は、サーバーが5秒前に準備ができている場合にのみ機能します。

次に、Andrewソリューションに基づいて、私はsetIntervalを使用してIDをウィンドウオブジェクトにアタッチしました(このようにして、「どこでも」使用できます)。

var timerID=0;

var socket;

/* Initiate what has to be done */

socket.onopen=function(event){
 /* As what was before */
 if(window.timerID){ /* a setInterval has been fired */
   window.clearInterval(window.timerID);
   window.timerID=0;
 }
 /* ... */
}

socket.onclose=function(event){
  /* ... */
 if(!window.timerID){ /* Avoid firing a new setInterval, after one has been done */
  window.timerID=setInterval(function(){start(websocketServerLocation)}, 5000);
 }
 /* That way, setInterval will be fired only once after losing connection */
 /* ... */
}

setTimeoutそれらに「グローバルタイマーID」のアイデアを適用すれば、引き続き使用できます;)
RozzA

3
「アンドリューによって与えられた解決策は、サーバーが5秒前に準備ができている場合にのみ機能する可能性があります。」-このステートメントは真実ではありません。5秒経過してもサーバーが使用できない場合、クライアントはWebSocket接続を開くことができず、oncloseイベントが再度発生します。
Sourav Ghosh

36

ReconnectingWebSocket

GitHubは、WebSocket APIを装飾する小さなJavaScriptライブラリをホストし、接続が切断された場合に自動的に再接続するWebSocket接続を提供します。

gzip圧縮された縮小ライブラリは600バイト未満です。

公式リポジトリはここにあります:

https://github.com/joewalnes/reconnecting-websocket

サーバーフラッド

再起動時に多数のクライアントがサーバーに接続されている場合。指数バックオフアルゴリズムを使用して、クライアントの再接続タイミングを管理することは価値があります。

アルゴリズムは次のように機能します。

  1. k回の試行の場合、0と2 ^ k-1の間のランダムな時間間隔を生成します
  2. 再接続できる場合は、kを1にリセットします
  3. 再接続に失敗した場合、kは1増加し、プロセスはステップ1で再開します。
  4. 最大間隔を切り捨てるために、特定の試行回数kに達した場合、kは試行ごとに増加を停止します。

参照:

http://blog.johnryding.com/post/78544969349/how-to-reconnect-web-sockets-in-a-realtime-web-app

ReconnectingWebSocketは、このアルゴリズムを使用して再接続を処理しません。


特にサーバーがWebソケット接続を閉じ、すべてのクライアント(数百または数千にも及ぶ可能性があります)が同時に再接続を試みると、サーバーの負荷が高くなるリスクについて言及しているため、すばらしい回答です。指数バックオフの代わりに、遅延を0〜10秒のようにランダム化することもできます。これにより、サーバーの負荷も分散されます。
Jochem Schulenklopper 2017年

30

私はしばらくの間、純粋なバニラJavaScriptにこのパターンを使用しており、他の回答よりもいくつかのケースをサポートしています。

document.addEventListener("DOMContentLoaded", function() {

  'use strict';

  var ws = null;

  function start(){

    ws = new WebSocket("ws://localhost/");
    ws.onopen = function(){
      console.log('connected!');
    };
    ws.onmessage = function(e){
      console.log(e.data);
    };
    ws.onclose = function(){
      console.log('closed!');
      //reconnect now
      check();
    };

  }

  function check(){
    if(!ws || ws.readyState == 3) start();
  }

  start();

  setInterval(check, 5000);


});

これは、サーバーが接続を閉じるとすぐに再試行し、接続もチェックして、5秒ごとに接続が確立されていることを確認します。

そのため、これが実行されたとき、またはoncloseイベントの時点でサーバーが起動していない場合でも、オンラインに戻ると、接続はまだ戻ってきます。

注:このスクリプトを使用しても、接続を開こうとするのを止めることはできません...しかし、それがあなたの望みだと思いますか?


7
私は変更するだけです:function check(){if(!ws || ws.readyState === WebSocket.CLOSED)start(); }
dieresys

1
このアプローチと、ここで説明するキープアライブテクニックは、私にはうまく機能しているようです。
Peter

@ Peter、ws状態が開いているかどうかは不明ですが、pingを実行する必要があります(または実行する必要があります)。正しい場合は、すでにwebsocketプロトコルに含まれています。このやり過ぎは、サーバーに負荷をかけただけです...
2018

@comte一部のwsサーバーは、クライアントからメッセージが送信されていない「アイドル期間」の後で接続を切断します。したがって、接続を開いたままにするために、pingは邪魔なものです。
RozzA 2018年

2

以下は100%機能する私のプロジェクトで使用したコードです。

  1. すべてのWebSocketコードをinit関数内に配置します。
  2. oncloseコールバック内で、もう一度initを呼び出します。
  3. 最後に、ドキュメントレディ関数内のinit関数を呼び出します。

var name = sessionStorage.getItem( 'name');

wsUri =  "ws://localhost:8080";   
var websocket;
$(function() {  
    init();  
    $("#chat_text_box").on("keypress", function(e) {         
        if (e.keyCode == 13) {   //For Enter Button    
            e.preventDefault();
            var mymessage = $('#chat_text_box').val();               
            if(mymessage){
                var msg = {  type: 'chat_text',  data : {  name:name,  msg:mymessage }  };                
                console.log(msg);
                websocket.send(JSON.stringify(msg));
                $('#chat_text_box').val('');
            }               
            return false;                       
        }        
    });      
});     
function init() { 
    websocket = new WebSocket(wsUri);      
    websocket.onopen = function(ev) { /*connection is open */    } 
    websocket.onmessage = function(ev) {        
        var data = JSON.parse(ev.data); //PHP sends Json data        
        var type = data.type;//alert(JSON.stringify(data));
        switch(type) {
            case "chat_text":
                var text = "<div><span class='user'>"+data.data.sender_name+" : </span><span class='msg'>"+data.data.msg+"</span></div>";
                $('#chat-messages').append(text);
                break;            
            default:
                break;

        }        

    };     
    websocket.onerror   = function(ev){}; 
    websocket.onclose = function(ev) {   init();   };  
}

2

コメントできませんが、次のとおりです。

var socket;

const socketMessageListener = (event) => {
  console.log(event.data);
};

const socketOpenListener = (event) => {
  console.log('Connected');
  socket.send('hello');
};

const socketCloseListener = (event) => {
  if (socket) {
    console.error('Disconnected.');
  }
  socket = new WebSocket('ws://localhost:8080');
  socket.addEventListener('open', socketOpenListener);
  socket.addEventListener('message', socketMessageListener);
  socket.addEventListener('close', socketCloseListener);
};

socketCloseListener();

// for testing
setTimeout(()=>{
  socket.close();
},5000);

プラスhttps://www.npmjs.com/package/backはすでに十分です:)


1

function wsConnection(url){
    var ws = new WebSocket(url);
    var s = (l)=>console.log(l);
	ws.onopen = m=>s(" CONNECTED")
    ws.onmessage = m=>s(" RECEIVED: "+JSON.parse(m.data))
    ws.onerror = e=>s(" ERROR")
    ws.onclose = e=>{
        s(" CONNECTION CLOSED");
        setTimeout((function() {
            var ws2 = new WebSocket(ws.url);
			ws2.onopen=ws.onopen;
            ws2.onmessage = ws.onmessage;
            ws2.onclose = ws.onclose;
            ws2.onerror = ws.onerror;
            ws = ws2
        }
        ).bind(this), 5000)
    }
    var f = m=>ws.send(JSON.stringify(m)) || "Sent: "+m;
    f.ping = ()=>ws.send(JSON.stringify("ping"));
    f.close = ()=>ws.close();
    return f
}

c=new wsConnection('wss://echo.websocket.org');
setTimeout(()=>c("Hello world...orld...orld..orld...d"),5000);
setTimeout(()=>c.close(),10000);
setTimeout(()=>c("I am still alive!"),20000);
<pre>
This code will create a websocket which will 
reconnect automatically after 5 seconds from disconnection.

An automatic disconnection is simulated after 10 seconds.


0

最後に、次のように、vue + tsでwsを自動再接続します。

private async mounted() {
    // Connect to WebSocket
    const sn = "sb1234567890";
    const host =
        window.location.protocol == "https:"
            ? "wss://www.xxx.net"
            : process.env.DEV_TYPE === "fullstack"
            ? "ws://10.0.0.14:8528"
            : "ws://www.xxx.net:8528";
    const wsUri = host + "/feed-home/" + sn;
    await this.startWs(wsUri, sn);
    // !!!Deprecated: failed to reconnect
    // let ws = new WebSocket();
    // console.log(ws);
    // ws.onopen = async function(event) {
    //     console.log(event, "openEvent");
    //     clearInterval(that.timer);
    // };
    // ws.onclose = async function(event) {
    //     console.log(event, "close");
    //     that.timer = setInterval(() => {
    //         console.log("Heart Beat");
    //         ws.send("HeartBeat");
    //         // ws = new WebSocket("ws://10.0.0.14:8528/feed-home/" + sn);
    //         console.log(ws);
    //     }, 60000);
    // };
    // ws.onmessage = async function(event) {
    //     console.log(event, "ws");
    //     alert("get it!");
    //     await alert("please update!");
    //     await that.getHome(sn);
    // };
}
private wsReconnected: boolean = false; // check whether WebSocket is reconnected
private async startWs(uri: string, sn: string) {
    let that = this;
    let ws = new WebSocket(uri);
    ws.onopen = async () => {
        if (that.wsReconnected) {
            await that.getHome(sn); // Refresh api data after reconnected
        }
        ws.send("Current client version: " + window.version);
    };
    ws.onmessage = async evt => {
        await that.getHome(sn);
        that.$message({
            type: "success",
            message: evt.data,
            showClose: true,
            center: true,
            duration: 20 * 1000
        });
    };
    ws.onclose = async () => {
        that.wsReconnected = true;
        await that.startWs(uri, sn);
        const sleep = (seconds: number) => {
            return new Promise(resolve =>
                setTimeout(resolve, seconds * 1000)
            );
        };
        await sleep(10); // Try to reconnect in 10 seconds
        // !!!Deprecated: Use timer will cause multiply ws connections
        // if (!that.wsTimer) {
        //     // Try to reconnect in 10 seconds
        //     that.wsTimer = setInterval(async () => {
        //         console.log("reconnecting websocket...");
        //         await that.startWs(uri, sn);
        //     }, 10 * 1000);
        // }
    };
}

0

WebSocketのクライアント側のクローズイベントにはwasCleanプロパティがあり、これは私にとって便利でした。クライアントコンピューターがスリープモードになった場合など、サーバーが予期せず停止した場合などにtrueに設定されているようです。ソケットを手動で閉じた場合はfalseに設定されます。ソケットは再び自動的に。Angular 7プロジェクトのコードの下。このコードはサービス内にあるので、どのコンポーネントからでも使用できます。

    notifySocketClose(event) { 

        if (!event.wasClean) { 
            setTimeout(() => {
                this.setupSocket()
            }, 1000);       
        }
    }

    setupSocket() { // my function to handle opening of socket, event binding etc.
    .....
    .....

            this.websocketConnection = this.websocketConnection ? this.websocketConnection : new WebSocket(socketUrl);
            this.websocketConnection.onclose = this.notifySocketClose.bind(this);   
        } 
    }
    .....
    .....
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.