DIV CSS 佈局教程網

用 HTML5 WebSocket 搭配 Tomcat 7.0 打造簡易即時聊天室
編輯:關於JavaScript     

傳統的 HTTP 是「你問我才答」的半雙工模式,要做即時通訊只能靠輪詢硬撐。WebSocket 把這件事徹底翻過來。本文先觀念、後實作,最後用 Tomcat 7.0 跑出一個能雙向對話的聊天室。

一、WebSocket 是什麼

它是一條全雙工、雙向、單一連線的通道。使用 WebSocket 之後,原本的一次 HTTP 請求會升級成一個 WebSocket 連線(加密版本為 WebSocket over TLS,也就是 wss),之後不論用戶端到伺服器、還是伺服器到用戶端,都重用同一條連線。

延遲因此大幅降低:連線一旦建立,伺服器只要有新訊息就能主動推送,不必像輪詢那樣每隔幾秒就送出一個空請求。反過來說,用戶端也能在任意時刻主動說話,雙向都不需要等待對方先開口。

二、WebSocket API 與建構方式

WebSocket 是瀏覽器提供的介面,規範了用戶端可用的方法與網路互動方式。要建立連線,只需用代表端點的 URL 實例化一個物件即可。協議定義了兩種 scheme:ws 為非加密、wss 為加密流量。

var ws = new WebSocket("ws://www.websocket.org");

三、四個事件

整個 API 是純事件驅動的,應用程式只要監聽 WebSocket 物件上的事件,就能掌握資料與連線狀態。

open——伺服器回應連線請求後觸發,回呼為 onopen。

ws.onopen = function (e) {
    console.log("Connection open...");
};

message——收到訊息時觸發,回呼為 onmessage。可從 e.data 判斷內容型別。

ws.onmessage = function (e) {
    if (typeof e.data === "string") {
        console.log("String message received", e, e.data);
    } else {
        console.log("Other message received", e, e.data);
    }
};

error——發生非預期故障時觸發,回呼為 onerror。

ws.onerror = function (e) {
    console.log('websocket error');
    handerError();
};

close——連線關閉時觸發,回呼為 onclose。

ws.onclose = function (e) {
    console.log("Connection closed", e);
};

四、兩個方法

send():連線開啟後即可用來向伺服器送訊息,送完可以保持連線,也可以接著關閉。

ws.send("Hello WebSocket!");

close():關閉連線或終止連線嘗試;若連線已關,呼叫它不會有任何作用,而且關閉後就不能再送資料。它接受兩個選填參數:code(數字狀態碼)與 reason(文字原因),可用來告知伺服器客戶端關閉的理由。

五、動手做:Tomcat 7.0 上的聊天室

先建立一個名為 chatroom 的 Web 專案,再新增一個套件並放入伺服器端實作類別 ChatWebSocketServlet.java。

Tomcat 7 的 WebSocket 實作方式與後續版本差異不小,它沿用 servlet 的模型:繼承 WebSocketServlet,改寫 createWebSocketInbound,再回傳一個繼承自 MessageInbound 的物件。

package com.yc.chat.Servlet;

import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServletRequest;
import org.apache.catalina.websocket.MessageInbound;
import org.apache.catalina.websocket.StreamInbound;
import org.apache.catalina.websocket.WebSocketServlet;
import org.apache.catalina.websocket.WsOutbound;

@WebServlet("/chat")
public class ChatWebSocketServlet extends WebSocketServlet {

    private final Map<Integer, WsOutbound> map = new HashMap<Integer, WsOutbound>();
    private static final long serialVersionUID = -1058445282919079067L;

    @Override
    protected StreamInbound createWebSocketInbound(String arg0, HttpServletRequest request) {
        // StreamInbound:基於流的 WebSocket 實作,需繼承並實作 onBinaryData / onTextData
        return new ChatMessageInbound();
    }

    class ChatMessageInbound extends MessageInbound {

        // MessageInbound:基於訊息的 WebSocket 實作,需實作 onBinaryMessage / onTextMessage
        @Override
        protected void onOpen(WsOutbound outbound) {
            map.put(outbound.hashCode(), outbound);   // 上線:登記連線
            super.onOpen(outbound);
        }

        @Override
        protected void onClose(int status) {
            map.remove(getWsOutbound().hashCode());   // 下線:移除連線
            super.onClose(status);
        }

        @Override
        protected void onBinaryMessage(ByteBuffer buffer) throws IOException {
        }

        @Override
        protected void onTextMessage(CharBuffer buffer) throws IOException {
            String msg = buffer.toString();
            Date date = new Date();
            SimpleDateFormat sdf = new SimpleDateFormat("HH:mm:ss");
            msg = "<font color=green>匿名用戶 " + sdf.format(date) + "</font><br/> " + msg;
            broadcast(msg);   // 廣播給所有在線的人
        }

        private void broadcast(String msg) {
            Set<Integer> set = map.keySet();
            for (Integer integer : set) {
                WsOutbound outbound = map.get(integer);
                CharBuffer buffer = CharBuffer.wrap(msg);
                try {
                    outbound.writeTextMessage(buffer);
                    outbound.flush();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

寫作重點:用一個 Map 以連線雜湊值為索引保存所有 WsOutbound,onOpen 時加入、onClose 時移除,收到文字訊息就加上時間戳後巡一圈寫回每條連線,這就是最精簡的廣播。

接著是前台頁面 index.jsp(先求功能,樣式從簡):

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>websocket 聊天室</title>
<style type="text/css">
#chat { text-align: left; width: 600px; height: 500px; }
#up   { text-align: left; width: 100%; height: 400px; border: 1px solid green; overflow-y: auto; }
#down { text-align: left; height: 100px; width: 100%; }
</style>
</head>
<body>
<h2 align="center">基於 HTML5 的聊天室</h2>
<div align="center" style="width: 100%; height: 700px;">
  <div id="chat">
    <div id="up"></div>
    <div id="down">
      <textarea style="width: 602px; height: 100%;" id="send"></textarea>
    </div>
  </div>
  <input type="button" value="連接" onclick="chat(this);">
  <input type="button" value="發送" onclick="send(this);" disabled="disabled"
         id="send_btn" title="Ctrl+Enter 發送">
</div>

<script type="text/javascript">
var socket;
var receive_text = document.getElementById("up");
var send_text = document.getElementById("send");

function addText(msg) {
    receive_text.innerHTML += "<br/>" + msg;
    receive_text.scrollTop = receive_text.scrollHeight;   // 捲到底,永遠看得到最新訊息
}

var chat = function (obj) {
    obj.disabled = "disabled";
    socket = new WebSocket('ws://localhost:8080/chatroom/chat');
    receive_text.innerHTML += "<font color=green>正在連接伺服器……</font><br/>";

    socket.onopen = function (event) {
        addText("<font color=green>連接成功!</font>");
        document.getElementById("send_btn").disabled = false;
        send_text.focus();
        document.onkeydown = function (event) {
            if (event.keyCode == 13 && event.ctrlKey) {   // Ctrl + Enter 送出
                send();
            }
        };
    };

    socket.onmessage = function (event) {
        addText(event.data);
    };

    socket.onclose = function (event) {
        addText("<font color=red>連接斷開!</font>");
        obj.disabled = "";
    };

    if (socket == null) {
        addText("<font color=red>連接失敗!</font>");
    }
};

var send = function () {
    if (send_text.value == "") { return; }
    socket.send(send_text.value);
    send_text.value = "";
    send_text.focus();
};
</script>
</body>
</html>

六、部署與驗證

把專案部署到 Tomcat 7.0 並啟動伺服器,在瀏覽器網址列輸入:

https://127.0.0.1:8080/chatroom/index.jsp

點擊「連接」,畫面會顯示「連接成功」,此時「發送」按鈕才會啟用。

接著打開兩個不同的瀏覽器(例如 Chrome 與 Firefox)連上同一頁,雙方互送訊息,訊息會即時同步出現在兩邊。

補充提醒

這個範例刻意保持精簡,因此還有幾處值得你在實戰中補強:一是連線中斷後缺少自動重連;二是 innerHTML 直接拼接使用者輸入會有 XSS 風險,正式環境請改用 textContent;三是 Tomcat 7 的 WebSocket 實作已在後續版本改用 JSR-356 標準(@ServerEndpoint),若你在 Tomcat 8 以上部署,這份伺服器端程式碼需要改寫。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved