Spring Boot WebSocket 如何实现多客户端实时数据同步？

本文共计1163个文字，预计阅读时间需要5分钟。

本文将简要介绍如何基于Spring Boot的STOMP实现WebSocket通信。首先，简要介绍STOMP和WebSocket的概念，然后说明如何在Spring Boot项目中配置和使用STOMP，最后通过一个示例展示如何实现简单的WebSocket通信。

在 Spring Boot 中实现多客户端自动同步，核心不是“轮询”或“手动刷新”，而是构建一个发布-订阅（Pub/Sub）式实时通信通道：当任一客户端触发变更（如新增 Collection），服务端应立即将该变更广播至所有已连接且订阅了对应主题的客户端。你当前的服务端配置已具备基础骨架，但存在几个关键缺失点——既涉及服务端逻辑完善，也依赖客户端正确接入与监听。

✅ 服务端需确保消息真正“广播出去”

你的 WebSocketConfig 配置基本正确，但注意两点：

• @EnableWebSocketMessageBroker 已替代过时的 AbstractWebSocketMessageBrokerConfigurer（Spring Boot 2.6+ 推荐继承 WebSocketMessageBrokerConfigurer）；
• enableSimpleBroker("/topic") 表示以 /topic/xxx 为前缀的主题支持服务端向所有订阅者群发，这正是自动同步所需。

然而，MessageController 中的 @MessageMapping("/chat") 仅处理“接收请求”，并通过 @SendTo("/topic/messages") 将返回值推送到 /topic/messages —— 这本身是正确的，但前提是客户端必须提前订阅 /topic/messages，否则消息发出即被丢弃。

因此，服务端无需额外“推送逻辑”，只要确保：

• 消息确实被发送到广播主题（已满足）；
• 消息体可被序列化（建议为 Collection 添加无参构造器和 @JsonInclude(JsonInclude.Include.NON_NULL) 等 Jackson 友好注解）；
• 避免阻塞主线程（Thread.sleep(1000) 仅用于演示，生产环境应移除）。

// 推荐优化后的 MessageController @Controller public class MessageController { @MessageMapping("/chat") @SendTo("/topic/messages") public Collection handleMessage(@Payload Collection collection) { System.out.println("Received: " + collection.getName()); // 此处可加入业务逻辑：持久化、校验、触发事件等 return collection; // 原样广播，或返回更新后对象 } }

✅ 客户端必须主动订阅主题才能接收广播

这是你问题的根本原因：服务端发了，但客户端没“开收音机”。仅建立 WebSocket 连接不等于自动监听任何消息。你提供的客户端代码片段指出了正确方向——使用 StompSession.subscribe() 显式订阅 /topic/messages：

// Java 客户端（如 Spring WebFlux 或测试工具中） StompSession session = connect("ws://localhost:8080/chat"); // 注意：endpoint 是 /chat，非 /websocket // 关键：必须订阅主题才能接收广播 session.subscribe("/topic/messages", new StompFrameHandler() { @Override public Type getPayloadType(StompHeaders headers) { return Collection.class; } @Override public void handleFrame(StompHeaders headers, Object payload) { Collection updated = (Collection) payload; System.out.println("Auto-sync received: " + updated.getName()); // ✅ 在此更新本地 UI 或状态树 } });

⚠️ 注意事项：

• Endpoint URL 必须与 WebSocketConfig.registerStompEndpoints() 中注册的一致（你配置的是 /chat，所以连接地址应为 ws://localhost:8080/chat，若启用 SockJS 则用 http://localhost:8080/chat + SockJS 客户端）；
• MappingJackson2MessageConverter 必须设置，否则 JSON → Java 对象反序列化失败；
• 浏览器前端推荐使用 @stomp/stompjs 库，订阅方式类似：

  client.subscribe('/topic/messages', (message) => { const collection = JSON.parse(message.body); renderCollection(collection); // 自动更新视图 });

✅ 总结：自动同步的完整链路

角色	关键动作	是否缺失？
服务端	配置 STOMP Broker + @SendTo 广播到 /topic/*	✅ 已完成（稍作优化即可）
服务端	接收客户端操作（如 POST /app/chat）并触发广播	✅ @MessageMapping 已覆盖
客户端 A	发送变更（client.send("/app/chat", {}, JSON.stringify(collection))）	需自行实现
客户端 A & B	均需提前执行 subscribe("/topic/messages")	❌ 当前缺失 → 同步失效主因

只要所有客户端在连接建立后统一订阅 /topic/messages，任意客户端通过 /app/chat 发起变更，其余所有订阅者将毫秒级收到相同消息，实现真正的自动同步。无需轮询、无需手动刷新、无需服务端维护客户端列表——STOMP Broker 已为你托管整个广播分发过程。