Javax.WebSocket詳解

一、WebSocket技術簡介

WebSocket是一種網路通信協議，提供雙向通信功能。它建立在TCP協議之上，通過HTTP的握手階段進行握手，然後建立起基於幀的通信。

WebSocket比起HTTP有更少的控制開銷，可以在客戶端和伺服器端同時發送數據，同時減少了延遲和帶寬，使得網頁可以更快地響應用戶的交互操作。

由於其雙向通信的特性，WebSocket可以廣泛應用於在線遊戲、在線協議設計、實時通訊等領域。

二、javax.websocket概述

javax.websocket是Java EE 7標準中新增的api，主要是為了方便Java開發者使用WebSocket。它提供了一組Java工具類和介面，幫助Java開發者開發WebSocket應用。

它包含兩個核心部分：客戶端API和伺服器API。它們都是使用標準的Java類和注釋開發的，適用於任何支持WebSocket的伺服器端和客戶端環境。

伺服器端API包括Endpoint、Session、MessageHandler、Decoder、Encoder等，這些都是實現WebSocket服務端的基本元素；客戶端API包括WebSocketContainer、ClientEndpointConfig、DeploymentConfig和ClientEndpoint等，這些都是實現WebSocket客戶端的基本元素。

三、WebSocket連接建立

在使用javax.websocket進行開發時，WebSocket會默認使用瀏覽器提供的JS API進行連接建立。在服務端也需要提供相應的Endpoint類來處理JS前端發起的WebSocket連接請求。下面是一個簡單的WebSocket連接建立的例子：

@ServerEndpoint("/echo")
public class EchoEndpoint {
    @OnMessage
    public void onMessage(Session session, String message) {
        try {
            session.getBasicRemote().sendText(message);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

其中，@ServerEndpoint註解表示這是一個WebSocket服務端，/echo表示WebSocket通信的路徑。通過@OnMessage註解聲明了一個處理信息的方法，當WebSocket通信時，就會自動觸發這個方法。在這個例子中，當客戶端發送消息時，服務端會把它原封不動地返回給客戶端。

四、WebSocket消息處理

WebSocket的消息處理部分，包括了Decoder、Encoder和MessageHandler這三個重要的介面。

Decoder介面用於將接收到的字元串或碼流轉換為目標類型的Java對象。Encoder介面則用於把Java對象轉換成字元串或碼流。

MessageHandler則是用於處理數據的介面，WebSocket客戶端和服務端都可以使用它。當WebSocket接收到數據時，會自動調用MessageHandler的onMessage方法。下面是一個簡單的MessageHandler的例子：

public class MyMessageHandler implements MessageHandler.Whole<String> {
    @Override
    public void onMessage(String message) {
        System.out.println("Received: " + message);
    }
}

這裡定義了一個實現MessageHandler介面的類MyMessageHandler，指定了它的泛型為String。當WebSocket接收到數據時，就會自動觸發這個onMessage方法，輸出接收到的內容。

五、WebSocket與Tomcat集成

Tomcat是目前應用最廣泛的JavaWeb伺服器，與javax.websocket整合需要以下步驟：

(1)添加依賴：

<dependency>
    <groupId>javax.websocket</groupId>
    <artifactId>javax.websocket-api</artifactId>
    <version>1.1</version>
</dependency>

(2)編寫Endpoint：

@ServerEndpoint(value = "/websocket")
public class MyEndpoint {
    @OnOpen
    public void onOpen(Session session){
        System.out.println("WebSocket opened: " + session.getId());
    }

    @OnClose
    public void onClose(Session session){
        System.out.println("WebSocket closed: " + session.getId());
    }

    @OnMessage
    public void onMessage(String message, Session session){
        System.out.println("WebSocket message: " + message);
        try {
            session.getBasicRemote().sendText("Server response: " + message);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

(3)在web.xml中配置WebSocket:

<web-app>
    <display-name>WebSocket Server&Client Sample</display-name>

    <!-- WebSocket Servlet Mapping -->
    <servlet>
        <servlet-name>websocket</servlet-name>
        <servlet-class>org.apache.tomcat.websocket.server.WsServlet</servlet-class>
        <init-param>
            <param-name>org.apache.tomcat.websocket.servlet.URI_MATCHER_ID</param-name>
            <param-value>websocket</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>websocket</servlet-name>
        <url-pattern>/websocket/*</url-pattern>
    </servlet-mapping>
</web-app>

(4)使用JS API建立WebSocket連接：

var ws = new WebSocket("ws://localhost:8080/MyApp/websocket");

ws.onopen = function(event) {
    console.log("WebSocket opened: " + ws.readyState);
}
ws.onclose = function(event) {
    console.log("WebSocket closed: " + ws.readyState);
}
ws.onmessage = function(event) {
    console.log("WebSocket message: " + event.data);
    ws.send(event.data);
}

六、總結

從WebSocket技術簡介、javax.websocket概述、WebSocket連接建立、WebSocket消息處理和WebSocket與Tomcat集成這幾個方面詳細介紹了javax.websocket的原理和使用方法。javax.websocket可以幫助Java開發者輕鬆地構建WebSocket應用，擁有快速和高效的雙向通信能力。