這是本文件的舊版!
Wicket - Websocket disconnection handling
Problem
造成websocket突然斷線的原因很多,像是網路不穩定或是閒置過久遭server或是browser中斷連線等,都有可能導致接下來的工作不正常。因此我們需要方法去處理連線中斷的情況。
How to?
我們Web框架使用Apache Wicket(6.22),而Server是Jetty(9.3.9)。(Wicket本身不支援ping&pong操作,因此ping&pong操作不在我的考慮範圍內)
Handle On Server Side
我們最早版本是在Server Side根據user request做處理,假如user request對應的websocket連線已中斷,那我們就會透過AjaxRequestTarget送一個reload給client:
public class WebSocketCheckListener extends AbstractRequestCycleListener { @Override public void onRequestHandlerScheduled(RequestCycle cycle, IRequestHandler handler) { if (!(handler instanceof AjaxRequestTarget)) return; AjaxRequestTarget target = (AjaxRequestTarget) handler; Page page = target.getPage(); Application application = Application.get(); IWebSocketSettings webSocketSettings = IWebSocketSettings.Holder.get(application); IWebSocketConnectionRegistry webSocketConnectionRegistry = webSocketSettings.getConnectionRegistry(); IKey key = new PageIdKey(page.getPageId()); IWebSocketConnection conn = webSocketConnectionRegistry.getConnection(application, page.getSession().getId(), key); if (conn == null || !conn.isOpen()) { target.appendJavaScript("location.reload()"); } } }這做法不是不好,只是有點繞。假如連線問題是client可以得知的,是不是交由client去處理就好了呢?
Handle On Client Side
Wicket Websocket client的api可以參考link。在callback的event中,我們會希望發生網路問題或者是websocket中斷時,closed與error的event會被呼叫,而我們也只需要處理這兩種訊息;然而經過我實際在chrome、firefox、ie11上,分別對client、server做網路連線中斷相關測試後,發現事與願違。
舉例來說,在我將server網路線拔除再插回去時,不會有任何事件發生,直到client發送訊息給server後,才會發生closed event。面對這樣問題,我就需要透過send message來偵測Websocket是否斷線。
首先讓我們處理最簡單的部分,error event。目前只會發生在網路有問題的情況,因此處理很簡單,就是重新連線。在這裡我使用了一個名為isWSConnected的變數,是用來區別websocketed是否已處於連線的狀態: (假如我可以改Wicket的js,我不會想這麼做)
Wicket.Event.subscribe("/websocket/error", function(jqEvent) { isWSConnected = false; Wicket.WebSocket.close(); Wicket.WebSocket.createDefaultConnection(); });
在成功建立連線後,我們server會給client發送訊息,因此針對message event我們會將isWSConnected設為true;假如你把isWSConnected設定放在open event中,有可能Websocket會是處於連線中的狀態:
Wicket.Event.subscribe("/websocket/message", function(jqEvent, message) { isWSConnected = true; // handle message });closed event的部分我最後再說明,請讓我先說明連線偵測的部分。由於我們的操作都是屬於ajax的request,且這樣的偵測做在client有請求時才發送會比定時有效率;因此我們將這個檢查放在ajax請求前的事件中,主要做以下幾件事情:
- 連線關閉時,
Wicket.Event.subscribe('/ajax/call/beforeSend', function(jqEvent, attributes, jqXHR, errorThrown, textStatus) { if( !Wicket.WebSocket.INSTANCE ){ Wicket.WebSocket.createDefaultConnection(); } else { if( !isWSConnected ) { console.log('websocket is connecting..'); return; } try { sendPing = false; Wicket.WebSocket.send('ping'); sendPing = true; } catch(e) { console.log(e.messsage); Wicket.WebSocket.close(); Wicket.WebSocket.createDefaultConnection(); } } });