在Spring Boot中实现WebSocket实时通信

大家好，我是微赚淘客系统3.0的小编，是个冬天不穿秋裤，天冷也要风度的程序猿！

在现代 web 应用中，实时通信功能越来越受到重视。WebSocket 协议是一种在单个 TCP 连接上进行全双工通信的协议，允许客户端和服务器之间进行实时数据传输。Spring Boot 提供了对 WebSocket 的良好支持，使得实现实时通信变得非常简单。本文将介绍如何在 Spring Boot 中实现 WebSocket 实时通信，包括服务器端和客户端的实现。

1. 创建 Spring Boot 项目

首先，确保你已经创建了一个 Spring Boot 项目。你可以使用 Spring Initializr 生成一个包含 Web 依赖项的项目。

2. 添加依赖

在 pom.xml 文件中，添加 spring-boot-starter-websocket 依赖来支持 WebSocket：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
  • 1.
  • 2.
  • 3.
  • 4.

3. 配置 WebSocket

在 Spring Boot 中，你需要创建一个 WebSocket 配置类来注册 WebSocket 端点。下面是一个示例：

package cn.juwatech.websocket.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/websocket").setAllowedOrigins("*");
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.

在这个配置类中，MyWebSocketHandler 是我们将要实现的 WebSocket 处理器类，/websocket 是 WebSocket 端点的路径。

4. 实现 WebSocket 处理器

接下来，创建一个 WebSocket 处理器类，该类实现 WebSocketHandler 接口：

package cn.juwatech.websocket.handler;

import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketMessage;

public class MyWebSocketHandler extends TextWebSocketHandler {

    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        System.out.println("Received message: " + message.getPayload());
        session.sendMessage(new TextMessage("Message received: " + message.getPayload()));
    }

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        System.out.println("WebSocket connection established");
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        System.out.println("WebSocket connection closed");
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.

在这个处理器中，我们处理接收到的文本消息，并向客户端发送确认消息。

5. 创建 WebSocket 客户端

在前端，我们可以使用 JavaScript 创建一个 WebSocket 客户端来连接到服务器并发送消息：

<!DOCTYPE html>
<html>
<head>
    <title>WebSocket Client</title>
    <script type="text/javascript">
        document.addEventListener("DOMContentLoaded", function() {
            var ws = new WebSocket("ws://localhost:8080/websocket");

            ws.onopen = function() {
                console.log("WebSocket connection opened");
                ws.send("Hello, WebSocket!");
            };

            ws.onmessage = function(event) {
                console.log("Received message: " + event.data);
            };

            ws.onclose = function() {
                console.log("WebSocket connection closed");
            };
        });
    </script>
</head>
<body>
    <h1>WebSocket Client</h1>
</body>
</html>
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.

这个简单的 HTML 页面创建了一个 WebSocket 连接，并在打开连接后发送一条消息。它还处理来自服务器的消息并在控制台中输出。

6. 测试

启动 Spring Boot 应用程序，并在浏览器中打开 HTML 页面。你应该能够看到 WebSocket 连接的建立、消息的发送和接收。控制台中也会输出相应的日志信息。

7. 高级功能

  • 广播消息：可以通过维护 WebSocket 会话列表，在处理器中向所有会话发送广播消息。
  • 用户身份验证：可以使用 Spring Security 配合 WebSocket 进行用户身份验证。
  • Ping/Pong：可以实现心跳检测来确保连接的健康状态。

8. 结论

通过以上步骤，你可以在 Spring Boot 应用中轻松实现 WebSocket 实时通信。无论是构建聊天应用、实时通知系统，还是其他需要实时数据传输的应用，WebSocket 都是一个强大的工具。Spring Boot 的 WebSocket 支持让这一过程变得简单而高效。