Java API 開發中使用 Websocket 進行即時通信

隨著網路的不斷發展，Web 應用程式的即時性要求越來越高。而傳統的 HTTP 協定並不能滿足即時通訊的需求，因為它是一種無狀態的請求-響應式通訊方式，請求和回應之間是一個單向的短暫的連線。因此，為了滿足即時通訊的需求，Websocket 技術誕生了。 Websocket 是一種全雙工的、長連接的、即時的通訊技術，它允許客戶端和伺服器之間建立一條持久的雙向連接，可以在通訊過程中任意發送資料。

Java API（Application Programming Interface）作為一種開發語言，可以很方便地使用 Websocket 進行即時通訊。 Java API 提供了一些工具類別和框架，使 Websocket 開發更簡單、更有效率。本文將從以下幾個方面介紹 Java API 開發中如何使用 Websocket 進行即時通訊。

一、Websocket 基礎使用

Java API 提供了 JSR-356 標準，用於在 Java 語言中支援 Websocket 技術。 Java API 中的 Websocket 介面提供了與 Websocket 相關的基本方法和事件處理方法，開發人員可以透過使用這些方法來實作自己的 Websocket 伺服器和用戶端。

使用 Java API 開發 Websocket 程式需要用到 javax.websocket.server.ServerEndpoint 註解和 javax.websocket.OnMessage 註解。其中，@ServerEndpoint 註解用於指定 Websocket 服務的 URL、編碼方式（如 UTF-8）、訊息處理器（即 WebSocketHandler）等配置資訊。 @OnMessage 註解用於宣告一個指定類型的訊息處理方法，該方法將在 Websocket 服務接收到客戶端發送的訊息時被呼叫。當客戶端發送訊息時，訊息將被提取並解析，然後傳遞給指定的訊息處理方法進行處理。訊息處理方法可以透過 Websocket Session 物件來傳送回應訊息。

下面是一個簡單的範例程式碼：

@ServerEndpoint(value = "/test")
public class WebSocketDemo {

    @OnMessage
    public String handleMessage(String message, Session session) {
        System.out.println("Received message: " + message);
        String echoMsg = "Echo from server: " + message;

        // 发送响应消息
        try {
            session.getBasicRemote().sendText(echoMsg);
        } catch (IOException e) {
            e.printStackTrace();
        }

        return echoMsg;
    }
}

以上程式碼定義了一個名為 WebSocketDemo 的 WebSocket 處理器，綁定到 URL “/test”。當客戶端發送訊息時，WebSocketDemo 的 handleMessage 方法將被調用，並發送回應訊息。

二、利用 Spring Boot 簡化 Websocket 開發

Spring Boot 是一個基於 Spring 框架的開發框架，同時它也能很好地支援 Websocket。透過使用 Spring Boot，可以更輕鬆地整合 Websocket 技術到 Java API 專案中，從而加速應用程式的開發。

首先，需要在 Spring Boot 專案的 pom.xml 檔案中新增以下依賴：

<dependency> 
   <groupId>org.springframework.boot</groupId> 
   <artifactId>spring-boot-starter-websocket</artifactId> 
</dependency>

然後，需要在 Spring Boot 應用程式中定義 WebSocketHandler 類別。 WebSocketHandler 類別需要繼承自Spring 的WebSocketHandler 接口，並實作一些基本方法，如handleTextMessage() 方法，用於處理客戶端發送的文字訊息：

public class MyHandler extends TextWebSocketHandler {

   @Override
   public void handleTextMessage(WebSocketSession session, TextMessage message) 
           throws InterruptedException, IOException { 

        String payload = message.getPayload(); 

        // 处理消息
        String echoMsg = "Echo from server: " + payload;

        // 发送响应消息
        session.sendMessage(new TextMessage(echoMsg)); 
   } 

}

最後，需要在Spring Boot 應用程式的設定檔中配置WebSocket，如下所示：

@Configuration 
@EnableWebSocket 
public class WebSocketConfig implements WebSocketConfigurer { 

    @Override 
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { 

        registry.addHandler(new MyHandler(), "/myHandler").setAllowedOrigins("*"); 
   } 

}

在以上程式碼中，MyHandler 類別將被綁定到URL “/myHandler”，並設定了允許跨域請求。你可以實作自己的 WebSocket 處理器、修改 URL 或使用其他設定選項。使用 Spring Boot 可以為 Websocket 開發提供許多方便，簡化開發流程。

三、利用 Javascript 開發 Websocket 用戶端

在使用 Java API 開發 Websocket 伺服器的同時，我們需要開發 Websocket 用戶端來與伺服器進行通訊。 Javascript 的 websocket API 可以讓我們輕鬆地在 Web 應用程式中使用 Websocket 實作客戶端通訊。

在Javascript 中使用Websocket，首先需要建立Websocket 物件並指定Websocket 伺服器位址：

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

然後，可以使用以下程式碼傳送訊息並接收來自Websocket 伺服器的回應訊息：

ws.onopen = function() {
   alert("Websocket连接已建立！");
   ws.send("Hello world!");
}; 

ws.onmessage = function(evt) {
   var receivedMsg = evt.data;
   alert("Received message: " + receivedMsg);
   ws.close();
};

以上程式碼將會連接到URL 為ws://localhost:8080/test 的Websocket 伺服器，並發送一條包含字串「Hello world!」 的訊息。當伺服器處理該訊息後，便會發送回應訊息，最終用戶端會收到回應訊息並關閉連線。

四、Websocket 實作類似聊天室的應用

透過以上的介紹，相信大家已經了解如何使用 Java API 進行 Websocket 編程，以及如何使用 Javascript 用戶端與之進行通訊。接下來，我們可以嘗試使用 Websocket 實作一個簡單的聊天室應用程式。

首先，需要使用 Java API 實作一個 Websocket 處理器用於處理 Websocket 用戶端發送的訊息：

@ServerEndpoint(value = "/chat/{username}")
public class ChatServer {

    private static Set<Session> clients = Collections.synchronizedSet(new HashSet<>());

    @OnOpen
    public void onOpen(Session session, @PathParam("username") String username) {
        // 将用户加入到聊天室中
        clients.add(session);

        // 广播消息
        broadcast(username, " joined the chat room!");
    }

    @OnMessage
    public void onMessage(String message, Session session, @PathParam("username") String username) {
        // 广播消息
        broadcast(username, ": " + message);
    }

    @OnClose
    public void onClose(Session session, @PathParam("username") String username) {
        // 将用户从聊天室中移除
        clients.remove(session);

        // 广播消息
        broadcast(username, " left the chat room!");
    }

    private static void broadcast(String username, String message) {
        // 向所有用户广播消息
        for (Session client : clients) {
            try {
                client.getBasicRemote().sendText(username + message);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

以上代码定义了一个名为 ChatServer 的 Websocket 处理器，绑定到 URL “/chat/{username}”。当客户端连接到聊天室时，ChatServer 的 onOpen 方法将被调用，并将客户端添加到 clients 集合中，然后广播一条 “加入聊天室” 的消息。当客户端在聊天室中发送一条消息时，ChatServer 的 onMessage 方法将被调用，并向聊天室的所有客户端广播一条消息。当客户端离开聊天室时，ChatServer 的 onClose 方法将被调用，并将客户端从 clients 集合中移除，然后广播一条 “离开聊天室” 的消息。

然后，需要使用简单的 HTML 和 Javascript 代码实现一个 Websocket 客户端：

<!DOCTYPE html>
<html>
<head>
   <title>Chat room</title>
</head>
<body>
   <h1>Chat room</h1>
   <div id="messageArea"></div>
   <form>
       <input type="text" id="inputField" onkeydown="return send(event)">
   </form>

   <script>
       var ws = new WebSocket("ws://localhost:8080/chat/"+prompt("Please enter your name:"));

       ws.onmessage = function(evt) {
           var receivedMsg = evt.data;
           var messageArea = document.getElementById("messageArea");
           messageArea.innerHTML += receivedMsg + "<br>";
       };

       function send(event) {
           if (event.keyCode == 13) {
               event.preventDefault();
               var inputField = document.getElementById("inputField")
               ws.send(inputField.value);
               inputField.value = "";
               return false;
           }
       }
   </script>
</body>
</html>

以上代码将会要求用户输入他们的名称，然后使用 Websocket 连接到 ChatServer 上。用户可以在输入框中输入文本并按下回车键进行发送。当接收到来自 ChatServer 的消息时，HTML 页面将在聊天窗口底部添加一条新的消息。

通过使用 Java API 和 Websocket 技术，我们可以方便地实现高效、实时的 Web 应用程序。无论你是在开发聊天室、在线游戏还是其他实时 Web 应用程序，Websocket 都可以是一个很好的选择。现在开始尝试使用 Websocket，构建自己的实时 Web 应用程序吧！

以上是Java API 開發中使用 Websocket 進行即時通信的詳細內容。更多資訊請關注PHP中文網其他相關文章！