讲师中心 微信公众号
AI工具推荐 视频效率加速

Spring Boot WebSocket 实现多客户端实时同步的完整教程

胖宇同学_1177

胖宇同学_1177

发布时间:2026-04-28 22:01:30

|

582人浏览过

|

来源于php中文网

原创

本文详细讲解如何基于 spring boot 的 websocket + stomp 协议实现多个客户端连接到同一服务器后的数据自动同步,涵盖服务端配置、消息广播机制及关键的客户端订阅逻辑。

本文详细讲解如何基于 spring boot 的 websocket + stomp 协议实现多个客户端连接到同一服务器后的数据自动同步,涵盖服务端配置、消息广播机制及关键的客户端订阅逻辑。

在 Spring Boot 中使用 WebSocket 实现多客户端自动同步,核心在于构建一个发布-订阅(Pub/Sub)模型:当任一客户端发起变更(如创建 Collection),服务端处理后主动将更新广播至所有已订阅的客户端,而非依赖轮询或手动刷新。你当前的服务端配置整体方向正确,但存在几个关键遗漏点,导致“发送了却无响应”——问题不在服务端逻辑失效,而在于缺少客户端的主动订阅与消息消费机制。

✅ 正确的服务端配置要点

你的 WebSocketConfig 基本符合规范,但有两处建议优化:

  1. 端点路径需明确区分:/chat 是 STOMP 连接端点,不应与业务路径混淆;推荐统一为 /ws 或 /stomp,并确保前端连接 URL 与之严格匹配;
  2. 启用跨域支持(开发阶段必需):若前端运行在 http://localhost:3000 等非同源地址,需添加 setAllowedOrigins("*"):
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
    registry.addEndpoint("/ws")
            .setAllowedOrigins("http://localhost:3000", "http://localhost:8080") // 生产环境请精确配置
            .withSockJS();
}

⚠️ 注意:SockJS 是兼容性降级方案(用于不支持原生 WebSocket 的旧浏览器),现代应用可直接使用原生 WebSocket,只需移除 .withSockJS() 即可。

✅ 消息广播逻辑:不只是 @SendTo

你的 MessageController 使用 @SendTo("/topic/messages") 是正确的广播方式,但需确保:

  • 客户端已订阅 /topic/messages(这是关键!服务端不会“推送给未订阅者”);
  • 消息体必须是可序列化对象(如 Collection),且客户端需配置对应反序列化器(如 MappingJackson2MessageConverter)。

无需修改控制器逻辑,但建议增强健壮性:

WebSocket 8.18.2
WebSocket 8.18.2

WebSocket 8.18.2 是该协议规范的一个重要迭代版本,主要优化了连接稳定性与数据传输效率。它通过全双工通信机制,允许客户端与服务器在单一长连接上实时交换数据,大幅降低传统 HTTP 轮询的开销。该版本增强了心跳保活、自动重连及二进制帧传输能力,适用于即时通讯、在线游戏及金融行情推送等低延迟场景,为开发者提供更可靠的实时网络交互基础。

下载
@MessageMapping("/collection/update")
@SendTo("/topic/collections")
public Collection updateCollection(@Payload Collection collection) {
    // 业务逻辑:保存到数据库、触发事件等
    collectionService.save(collection);
    System.out.println("Broadcasting updated collection: " + collection.getId());
    return collection; // 广播给所有 /topic/collections 订阅者
}

✅ 客户端:必须显式订阅才能接收广播

这才是你“什么都没发生”的根本原因。Spring WebSocket 的 @SendTo 仅向已建立订阅关系的客户端发送消息。客户端必须通过 STOMP 协议执行两个动作:

  1. 建立 WebSocket 连接并握手(STOMP over WebSocket);
  2. 调用 subscribe() 方法监听指定目标(如 /topic/collections)。

以下为 Java 客户端(如测试工具或桌面应用)的标准接入代码:

// 1. 建立连接
private StompSession connect() {
    WebSocketClient client = new StandardWebSocketClient();
    WebSocketStompClient stompClient = new WebSocketStompClient(client);
    stompClient.setMessageConverter(new MappingJackson2MessageConverter()); // 支持 JSON ↔ 对象转换

    try {
        return stompClient.connect("ws://localhost:8080/ws", new StompSessionHandlerAdapter() {}).get();
    } catch (Exception e) {
        throw new RuntimeException("Failed to connect to WebSocket", e);
    }
}

// 2. 订阅主题(关键!)
public void subscribeToCollections(Consumer<Collection> handler) {
    session.subscribe("/topic/collections", new StompFrameHandler() {
        @Override
        public Type getPayloadType(StompHeaders headers) {
            return Collection.class;
        }

        @Override
        public void handleFrame(StompHeaders headers, Object payload) {
            handler.accept((Collection) payload); // 接收到更新,触发 UI 刷新等
        }
    });
}

// 3. 发送更新(触发广播)
public void sendCollectionUpdate(Collection collection) {
    session.send("/app/collection/update", collection);
}

? 前端 Web 客户端(JavaScript)同理:需使用 @stomp/stompjs 库,调用 client.subscribe('/topic/collections', callback) —— 没有这行代码,永远收不到服务端推送。

? 总结:三步走通自动同步

步骤 关键操作 验证方式
1. 服务端就绪 配置 @EnableWebSocketMessageBroker、/topic/* 广播、/app/* 接收端点 启动后访问 ws://localhost:8080/ws 能成功握手(浏览器控制台无 404)
2. 客户端连接+订阅 使用 STOMP 客户端连接 /ws,并 subscribe("/topic/collections") 客户端日志出现 "Subscribed to /topic/collections"
3. 触发广播 任一客户端 send("/app/collection/update", data) 其他已订阅客户端的 handleFrame() 回调被触发,控制台打印接收日志

只要三者全部满足,任意客户端创建/更新 Collection,其余所有客户端将毫秒级实时同步,无需刷新页面或额外请求。记住:WebSocket 同步的本质是「服务端广播 + 客户端订阅」,缺一不可。

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3609

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2428

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1380

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1318

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1416

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2338

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3880

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

18255

2023.09.22

Uvicorn 报错与问题解决教程
Uvicorn 报错与问题解决教程

本专题汇总了Uvicorn服务器常见问题与报错解决的教程合集,涵盖启动失败、端口占用、模块导入错误、事件循环冲突及热重载失效等典型故障的排查思路。同时整理了多进程与Worker配置、SSL/HTTPS证书报错、跨域与代理配置等实战解决方案,助你快速定位并解决Uvicorn运行中的各类问题。

20

2026.11.02

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebSocket手册
WebSocket手册

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn