0

0

怎么在Spring Boot中集成WebSocket_@ServerEndpoint注解与全双工通信实战

P粉602998670

P粉602998670

发布时间:2026-03-13 15:16:33

|

701人浏览过

|

来源于php中文网

原创

@ServerEndpoint在Spring Boot中默认不生效且无法注入Spring Bean,需通过ServerEndpointExporter手动注册并仅限Tomcat;更推荐使用WebSocketHandler+WebSocketConfigurer实现原生支持。

怎么在spring boot中集成websocket_@serverendpoint注解与全双工通信实战

@ServerEndpoint 注解在 Spring Boot 中默认不生效,直接用会 404 或抛 java.lang.IllegalStateException: No suitable default RequestUpgradeStrategy —— 因为 Spring Boot 的嵌入式 Tomcat(或 Jetty/Undertow)没自动注册 WebSocket 容器支持,得手动配。

为什么 @ServerEndpoint 不能直接在 Spring Boot 主类或 Bean 上用

Spring Boot 默认把 @ServerEndpoint 当作原生 Java EE 组件处理,不走 Spring 容器生命周期。它不会被 Spring 管理,无法注入 @Autowired 的 service、repository,也不能用 @Value 或 AOP。常见现象是:连接能建,但 @OnOpenthis.userService 为 null,或者日志里根本没进方法。

实操建议:

  • 不要把 @ServerEndpoint 类声明为 @Component 或放在 @SpringBootApplication 扫描路径下指望自动识别
  • 不要在 @ServerEndpoint 类里直接 @Autowired —— 除非你显式桥接 Spring 上下文(见下一条)
  • 如果坚持用 @ServerEndpoint,必须通过 ServerEndpointExporter 暴露给容器,且仅适用于 Tomcat

用 ServerEndpointExporter + @ServerEndpoint 的最小可行配置

这是兼容性最好、改动最小的方案,适合已有 @ServerEndpoint 代码想快速跑起来的场景。注意:只支持嵌入式 Tomcat,Jetty 和 Undertow 需换方案。

实操建议:

  • 在配置类中加一个 @Bean
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
  • 确保 pom.xml 里有 spring-boot-starter-websocket,不是只靠 spring-boot-starter-web
  • @ServerEndpoint 类仍不能直接 @Autowired,但可通过 WebApplicationContextUtils.getWebApplicationContext(ctx.getServletContext()) 手动取 bean(不推荐,耦合重)
  • 路径写法必须带前缀,比如 @ServerEndpoint("/ws/chat"),前端连 ws://localhost:8080/ws/chat,别漏 /ws

更推荐:用 Spring 的 WebSocketHandler + WebSocketConfigurer 替代 @ServerEndpoint

这才是 Spring Boot 的原生玩法,天然支持依赖注入、拦截器、STOMP 协议扩展,也兼容所有嵌入式容器。全双工通信的关键不在注解,而在 WebSocketSession 的复用和线程安全操作。

零沫AI工具导航
零沫AI工具导航

零沫AI工具导航-AI导航新标杆,探索全球实用AI工具

下载

实操建议:

  • 实现 TextWebSocketHandler,重写 handleTextMessageafterConnectionEstablished
  • ConcurrentHashMap<string websocketsession></string> 存活连接,key 建议用业务 ID(如用户 ID),别用 session.getId() —— 它是随机 UUID,前后端难对齐
  • 发消息时务必检查 session.isOpen(),否则会抛 IllegalStateException: The session has been closed
  • 异步推送要小心:不能在非 WebSocket 线程(如定时任务、HTTP 请求线程)里直接调 session.sendMessage(),需用 session.sendMessage() 的返回值判断是否成功,或改用 session.sendMessage(new TextMessage(...)) 并捕获 IOException

跨域、握手失败与生产部署的隐形坑

本地能通,上线就断开?大概率是反向代理(Nginx)或负载均衡没透传 WebSocket 升级头。错误现象包括:HTTP 200 但没升级成 ws,控制台报 Error during WebSocket handshake: Unexpected response code: 200

实操建议:

  • Nginx 配置必须含:
    location /ws/ {
        proxy_pass http://backend;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
    }
  • Spring Boot 配置里关掉默认 CORS(spring.web.cors.enabled=false),改用 WebSocketConfigurer#registerStompEndpoints 或自定义 HandshakeInterceptor 控制 Origin
  • 别在 @OnMessagehandleTextMessage 里做耗时操作(如查 DB、调远程接口),会阻塞整个 WebSocket 线程池;应丢进 TaskExecutor 异步处理
  • Tomcat 的 WebSocket 默认最大帧大小是 8KB,超长消息会静默断连,需在 application.properties 改:server.tomcat.max-http-post-size=-1spring.websocket.server.max-text-message-size=512000

真正难的从来不是“怎么连上”,而是连接存活期间的状态同步、异常重连策略、多实例 session 广播、以及当 WebSocketSession 在某个节点失效后,如何让其他节点感知并清理 —— 这些没法靠一个注解解决。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
如何配置Tomcat环境变量
如何配置Tomcat环境变量

配置Tomcat环境变量需要在系统中添加CATALINA_HOME变量,并将Tomcat的安装路径添加到PATH变量中。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

117

2023.10.26

idea如何集成Tomcat
idea如何集成Tomcat

idea集成Tomcat的步骤:1、添加Tomcat服务器配置;2、配置项目部署;3、运行Tomcat服务器;4、访问项目;5、注意事项;6、关闭Tomcat服务器。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

173

2024.02.23

怎么查看Tomcat源代码
怎么查看Tomcat源代码

查看Tomcat源代码的步骤:1、下载Tomcat源代码;2、在IDEA中导入Tomcat源代码;3、查看源代码;4、理解Tomcat的工作原理;5、参与社区和贡献;6、注意事项;7、持续学习和更新;8、使用工具和插件。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

99

2024.02.23

常见的tomcat漏洞有哪些
常见的tomcat漏洞有哪些

常见的tomcat漏洞有:1、跨站脚本攻击;2、跨站请求伪造;3、目录遍历漏洞;4、缓冲区溢出漏洞;5、配置漏洞;6、第三方组件漏洞。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

170

2024.02.23

tomcat日志乱码怎么解决
tomcat日志乱码怎么解决

tomcat日志乱码的解决办法:1、修改tomcat的日志编码设置;2、检查ide的编码设置;3、检查操作系统的编码设置;4、使用过滤器处理日志;5、检查外部系统的编码设置;6、检查文件编码方式等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

158

2024.02.23

weblogic和tomcat有哪些区别
weblogic和tomcat有哪些区别

weblogic和tomcat的区别:1、功能;2、性能;3、规模;4、价格;5、安全性;6、配置和管理;7、社区支持;8、集成能力;9、升级和更新;10、可靠性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

200

2024.02.23

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

244

2024.02.23

tomcat启动闪退怎么解决
tomcat启动闪退怎么解决

tomcat启动闪退的解决办法:1、检查java环境;2、检查环境变量配置;3、检查端口被占用;4、检查配置文件编码;5、检查启动时需要的配置文件;6、检查相关文件是否丢失;7、检查防火墙和杀毒软件设置。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

169

2024.02.23

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号