SpringBoot如何使用WebSocket实现点对点消息

发布时间：2023-05-17 16:26:47 作者：zzz
来源：亿速云阅读：176

SpringBoot如何使用WebSocket实现点对点消息

WebSocket 是一种在单个 TCP 连接上进行全双工通信的协议，它允许服务器和客户端之间进行实时、双向的通信。在 Spring Boot 中，我们可以通过集成 WebSocket 来实现点对点的消息传递。本文将介绍如何在 Spring Boot 项目中使用 WebSocket 实现点对点消息。

1. 添加依赖

首先，在 pom.xml 文件中添加 WebSocket 相关的依赖：

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

2. 配置 WebSocket

接下来，我们需要配置 WebSocket。创建一个配置类 WebSocketConfig，并继承 WebSocketConfigurer 接口：

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(), "/ws").setAllowedOrigins("*");
    }
}

在这个配置类中，我们注册了一个 WebSocket 处理器 MyWebSocketHandler，并将其映射到 /ws 路径。

3. 实现 WebSocket 处理器

接下来，我们需要实现一个 WebSocket 处理器 MyWebSocketHandler，它继承自 TextWebSocketHandler：

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

public class MyWebSocketHandler extends TextWebSocketHandler {

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        String payload = message.getPayload();
        // 处理接收到的消息
        session.sendMessage(new TextMessage("Received: " + payload));
    }
}

在这个处理器中，我们重写了 handleTextMessage 方法，用于处理客户端发送的消息，并返回一个响应消息。

4. 前端连接 WebSocket

在前端页面中，我们可以使用 JavaScript 来连接 WebSocket 并发送消息：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>WebSocket Client</title>
</head>
<body>
    <input type="text" id="message" placeholder="Enter message">
    <button onclick="sendMessage()">Send</button>
    <div id="response"></div>

    <script>
        const socket = new WebSocket('ws://localhost:8080/ws');

        socket.onopen = function(event) {
            console.log('WebSocket connection established.');
        };

        socket.onmessage = function(event) {
            document.getElementById('response').innerText = event.data;
        };

        function sendMessage() {
            const message = document.getElementById('message').value;
            socket.send(message);
        }
    </script>
</body>
</html>

在这个 HTML 页面中，我们创建了一个 WebSocket 连接，并通过 sendMessage 函数向服务器发送消息。服务器返回的响应消息会显示在页面上。

5. 运行项目

完成上述步骤后，启动 Spring Boot 项目，并访问前端页面。你可以在输入框中输入消息并点击发送按钮，服务器会返回一个响应消息。

6. 实现点对点消息

为了实现点对点消息传递，我们需要在服务器端维护一个会话列表，并根据用户 ID 或其他标识符来区分不同的会话。以下是一个简单的实现：

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

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

public class MyWebSocketHandler extends TextWebSocketHandler {

    private static final Map<String, WebSocketSession> sessions = new HashMap<>();

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        String userId = session.getHandshakeHeaders().getFirst("userId");
        sessions.put(userId, session);
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        String payload = message.getPayload();
        String[] parts = payload.split(":");
        String targetUserId = parts[0];
        String content = parts[1];

        WebSocketSession targetSession = sessions.get(targetUserId);
        if (targetSession != null && targetSession.isOpen()) {
            targetSession.sendMessage(new TextMessage(content));
        }
    }
}

在这个实现中，我们维护了一个 sessions 映射，用于存储用户 ID 和对应的 WebSocket 会话。当客户端发送消息时，消息格式为 targetUserId:content，服务器会根据 targetUserId 找到对应的会话并发送消息。

7. 前端发送点对点消息

在前端页面中，我们可以通过以下方式发送点对点消息：

function sendMessage() {
    const targetUserId = document.getElementById('targetUserId').value;
    const message = document.getElementById('message').value;
    socket.send(targetUserId + ":" + message);
}

在这个例子中，我们假设页面中有两个输入框，一个用于输入目标用户 ID，另一个用于输入消息内容。

8. 总结

通过以上步骤，我们成功地在 Spring Boot 项目中集成了 WebSocket，并实现了点对点的消息传递。WebSocket 提供了一种高效、实时的通信方式，非常适合需要实时交互的应用场景。在实际项目中，你可能还需要考虑会话管理、消息格式、安全性等问题，但这些都可以在现有基础上进行扩展和优化。

SpringBoot如何使用WebSocket实现点对点消息

SpringBoot如何使用WebSocket实现点对点消息

1. 添加依赖

2. 配置 WebSocket

3. 实现 WebSocket 处理器

4. 前端连接 WebSocket

5. 运行项目

6. 实现点对点消息

7. 前端发送点对点消息

8. 总结

相关阅读