本文記錄一個以 WebSocket 搭配 Java 完成的訊息推送功能,伺服器用的是 Tomcat 7.0。部分設計是自己摸索出來的,未必是最佳做法,若有不妥之處還請指正。
程式的基本能力很單純:客戶端 A 可以把訊息送給客戶端 B。在這個骨架上还有不少擴展空間,例如:
實測在 Chrome、搜狗、Firefox 下均可正常運作,程式碼在文末給出。
先開啟第一個瀏覽器,提示輸入名字,這裡輸入 soar:


再開啟第二個瀏覽器,這裡輸入 bill:


由 soar 送出「hello bill i am soar」並點擊 send:

另一個瀏覽器上就能看到訊息:

WebSocket 是為了解決客戶端與伺服器之間的即時雙向通信而出現的技術。它的本質是先透過 HTTP/HTTPS 完成握手,之後建立一條用來交換資料的 TCP 連線,雙方就可以在這條連線上隨時互推訊息。
過去要做推送,通常靠輪詢:瀏覽器每隔一段時間自動發一次請求,把伺服器上的新訊息拉回來。問題是 HTTP 請求的 header 相當冗長,而真正有用的資料可能只有幾個位元組,來回幾趟下來頻寬和伺服器資源都被吃掉了。
WebSocket 的價值就在於:連線建立之後,伺服器可以在任意時刻主動把資料推給客戶端,雙方交換的標頭資訊又極小。
它也不像 Ajax 那樣必須由客戶端發起請求——Ajax 是被動拉取,WebSocket 是雙向推送。
在支援 WebSocket 的瀏覽器中,建立 socket 之後可以透過 onopen、onmessage、onclose、onerror 四個事件來回應狀態變化:
var ws = new WebSocket("ws://localhost:8080");
ws.onopen = function() {
console.log("open");
ws.send("hello");
};
ws.onmessage = function(evt) {
console.log(evt.data);
};
ws.onclose = function(evt) {
console.log("WebSocketClosed!");
};
ws.onerror = function(evt) {
console.log("WebSocketError!");
};
逐段說明:
new WebSocket("ws://localhost:8080") 會申請一個 WebSocket 物件,參數是要連線的伺服器位址。就像 HTTP 用 https:// 開頭一樣,WebSocket 用 ws:// 開頭,加密版本則是 wss://。
ws.send("hello") 負責把訊息送到伺服器。
連線建立成功時觸發 onopen;收到伺服器訊息時觸發 onmessage,資料在 evt.data 裡;收到伺服器的關閉連線請求時觸發 onclose;連線、處理、收發資料出錯時觸發 onerror。
可以注意到,所有操作都是事件驅動的,不會阻塞 UI,因此反應更快、體驗更好。
支援 WebSocket 的伺服器不少,Node.js、Jetty、Tomcat 都可以。這裡用 Tomcat 7.0 搭配 Eclipse 4.2。
Tomcat 7 底下使用 WebSocket 首先要引入相關 jar。Tomcat 7 與 WebSocket 有關的類別都放在 org.apache.catalina.websocket 套件中(實作包含在 catalina.jar 裡),最省事的做法是把 Tomcat 的函式庫整包加進來:
build path → configure build path → libraries → add library → server runtime → Apache Tomcat v7.0
同時需要 import 以下套件:
import org.apache.catalina.websocket.MessageInbound; import org.apache.catalina.websocket.StreamInbound; import org.apache.catalina.websocket.WsOutbound; import org.apache.catalina.websocket.WebSocketServlet;
我們需要兩個類別:第一個處理 WebSocket 請求,第二個處理每一次具體的連線任務。
第一個類別:
public class SocketServer extends WebSocketServlet {
private static final long serialVersionUID = 1L;
@Override
protected StreamInbound createWebSocketInbound(String arg0,
HttpServletRequest arg1) {
return new ChatWebSocket(users);
}
}
這個 Servlet 繼承 WebSocketServlet,實作 createWebSocketInbound 方法,回傳第二個類別的實例。
第二個類別:
public class ChatWebSocket extends MessageInbound {
@Override
protected void onTextMessage(CharBuffer message) throws IOException {
}
@Override
protected void onOpen(WsOutbound outbound) {
}
@Override
protected void onClose(int status) {
}
@Override
protected void onBinaryMessage(ByteBuffer arg0) throws IOException {
}
}
四個回呼的意義分別是:onTextMessage 處理文字訊息、onBinaryMessage 處理二進位訊息、onOpen 在連線建立時觸發、onClose 在連線關閉時觸發。
HTML 部分:
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <script type="text/javascript" src="js/jquery.js"></script> <script type="text/javascript" src="js/socket.js"></script> <title>無標題文檔</title> </head> <body> <table> <tr> <td>Message</td> <td><input type="text" id="message"></td> </tr> <tr> <td>Name</td> <td><input type="text" id="othername"></td> </tr> <tr> <td><input id="sendbutton" type="button" value="send" disabled="true"></td> </tr> </table> </body> </html>
JS 部分(jQuery 相關這裡不展開):
var username = window.prompt("輸入你的名字:");
document.write("Welcome<p id=\"username\">" + username + "</p>");
if (!window.WebSocket && window.MozWebSocket)
window.WebSocket = window.MozWebSocket;
if (!window.WebSocket)
alert("No Support ");
var ws;
$(document).ready(function(){
$("#sendbutton").attr("disabled", false);
$("#sendbutton").click(sendMessage);
startWebSocket();
});
function sendMessage() {
var othername = $("#othername").val();
var msg = "MSG\t" + username + "_" + othername + "_" + $("#message").val();
send(msg);
}
function send(data) {
console.log("Send:" + data);
ws.send(data);
}
function startWebSocket() {
ws = new WebSocket("ws://" + location.host + "/WebSocket/SocketServer");
ws.onopen = function(){
console.log("success open");
$("#sendbutton").attr("disabled", false);
};
ws.onmessage = function(event) {
console.log("RECEIVE:" + event.data);
handleData(event.data);
};
ws.onclose = function(event) {
console.log("Client notified socket has closed", event);
};
}
function handleData(data) {
var vals = data.split("\t");
var msgType = vals[0];
switch(msgType) {
case "NAME":
var msg = vals[1];
var mes = "NAME" + "\t" + msg + "_" + username;
send(mes);
break;
case "MSG":
var val2s = vals[1].split("_");
var from = val2s[0];
var message = val2s[2];
alert(from + ":" + message);
break;
default:
break;
}
}
Java 部分:
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import javax.servlet.http.HttpServletRequest;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArraySet;
import org.apache.catalina.websocket.MessageInbound;
import org.apache.catalina.websocket.StreamInbound;
import org.apache.catalina.websocket.WsOutbound;
import org.apache.catalina.websocket.WebSocketServlet;
public class SocketServer extends WebSocketServlet {
private static final long serialVersionUID = 1L;
public final Set<ChatWebSocket> users = new CopyOnWriteArraySet<ChatWebSocket>();
public static int USERNUMBER = 1;
@Override
protected StreamInbound createWebSocketInbound(String arg0,
HttpServletRequest arg1) {
return new ChatWebSocket(users);
}
public class ChatWebSocket extends MessageInbound {
private String username;
private Set<ChatWebSocket> users = new CopyOnWriteArraySet<ChatWebSocket>();
public ChatWebSocket() {
}
public ChatWebSocket(Set<ChatWebSocket> users) {
this.users = users;
}
@Override
protected void onTextMessage(CharBuffer message) throws IOException {
}
public void onMessage(String data) {
String[] val1 = data.split("\\t");
if (val1[0].equals("NAME")) {
String[] val2 = val1[1].split("_");
for (ChatWebSocket user : users) {
if (user.username.equals(val2[0])) {
user.username = val2[1];
}
}
} else if (val1[0].equals("MSG")) {
String[] val2 = val1[1].split("_");
for (ChatWebSocket user : users) {
if (user.username.equals(val2[1])) {
try {
CharBuffer temp = CharBuffer.wrap(data);
user.getWsOutbound().writeTextMessage(temp);
} catch (IOException e) {
e.printStackTrace();
}
}
}
} else {
System.out.println("ERROR");
}
}
@Override
protected void onOpen(WsOutbound outbound) {
this.username = "#" + String.valueOf(USERNUMBER);
USERNUMBER++;
try {
String message = "NAME" + "\t" + this.username;
CharBuffer buffer = CharBuffer.wrap(message);
this.getWsOutbound().writeTextMessage(buffer);
} catch (IOException e) {
e.printStackTrace();
}
users.add(this);
}
@Override
protected void onClose(int status) {
users.remove(this);
}
@Override
protected void onBinaryMessage(ByteBuffer arg0) throws IOException {
}
}
}
整個設計的運作順序是這樣:
流程圖大致如下(手繪,見笑了):

對應到程式碼,幾個關鍵環節是:
JS 建立連線:
ws = new WebSocket("ws://" + location.host + "/WebSocket/SocketServer");
Java 建立對應的處理物件並觸發 onOpen:
protected StreamInbound createWebSocketInbound(String arg0,
HttpServletRequest arg1) {
return new ChatWebSocket(users);
}
onOpen 中分配暫定名、回問名字,並把使用者加入清單:
@Override
protected void onOpen(WsOutbound outbound) {
this.username = "#" + String.valueOf(USERNUMBER);
USERNUMBER++;
try {
String message = "NAME" + "\t" + this.username;
CharBuffer buffer = CharBuffer.wrap(message);
this.getWsOutbound().writeTextMessage(buffer);
} catch (IOException e) {
e.printStackTrace();
}
users.add(this);
}
JS 收到 NAME 訊息後回報真實名字:
case "NAME": var msg = vals[1]; var mes = "NAME" + "\t" + msg + "_" + username; send(mes); break;
Java 依暫定名找到對應使用者並改名:
if (val1[0].equals("NAME")) {
String[] val2 = val1[1].split("_");
for (ChatWebSocket user : users) {
if (user.username.equals(val2[0])) {
user.username = val2[1];
}
}
}
JS 發起對話,訊息格式為 MSG + 自己名字 + _ + 對方名字 + _ + 內容:
function sendMessage() {
var othername = $("#othername").val();
var msg = "MSG\t" + username + "_" + othername + "_" + $("#message").val();
send(msg);
}
Java 依對方名字在清單中查找並轉發:
else if (val1[0].equals("MSG")) {
String[] val2 = val1[1].split("_");
for (ChatWebSocket user : users) {
if (user.username.equals(val2[1])) {
try {
CharBuffer temp = CharBuffer.wrap(data);
user.getWsOutbound().writeTextMessage(temp);
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
JS 收到他人訊息後提示出來:
case "MSG":
var val2s = vals[1].split("_");
var from = val2s[0];
var message = val2s[2];
alert(from + ":" + message);
break;
Java 偵測使用者離開並移出清單:
@Override
protected void onClose(int status) {
users.remove(this);
}