0

0

如何配置Java的WebSocket开发环境_ServerEndpoint注解支持

P粉602998670

P粉602998670

发布时间:2026-03-17 14:00:14

|

885人浏览过

|

来源于php中文网

原创

@ServerEndpoint不生效的根本原因是WebSocket容器实现缺失或Tomcat未启用WebSocket支持,需确保tomcat-embed-websocket依赖正确、避免spring-boot-starter-websocket干扰、统一使用javax.websocket-api 1.1,并通过ServletContext手动注册端点。

如何配置java的websocket开发环境_serverendpoint注解支持

为什么 @ServerEndpoint 注解不生效?

根本原因通常是类路径下缺少 WebSocket 容器实现,或者容器(比如 Tomcat)没启用 WebSocket 支持。Spring Boot 2.3+ 默认用的是 Tomcat 9+,但如果你用的是嵌入式 Tomcat,@ServerEndpoint 不会自动扫描——它不走 Spring 的组件扫描机制,而是依赖 Servlet 容器的原生 WebSocket 扩展。

  • Tomcat 需要确保 tomcat-websocket.jar 在 classpath(Maven 里对应 org.apache.tomcat.embed:tomcat-embed-websocket
  • Spring Boot 项目中,若同时引入了 spring-boot-starter-websocket,反而可能干扰原生 @ServerEndpoint,因为该 starter 会注册自己的 WebSocket 配置,覆盖掉容器级支持
  • IDE 运行时(如 IntelliJ)若用 “Spring Boot Run Configuration”,默认不会激活 Tomcat 的 WebSocket 模块,得手动确认依赖和启动方式

如何让 @ServerEndpoint 被 Tomcat 正确加载?

关键不是加注解,而是让 Tomcat 主动发现并注册这个端点。最稳妥的方式是通过 ServerEndpointConfig.Builder + ServletContext 手动注册,绕过自动扫描的不可靠性。

  • @ServletComponentScanServletContainerInitializer 中注册,但更简单的是在 @Configuration 类里写一个 @Bean 方法,返回 ServerEndpointExporter(仅适用于 Spring WebFlux 或老版本 Spring;Spring Boot 2.5+ 已弃用)
  • 推荐做法:不依赖自动扫描,在 ServletContextInitializer 中调用 server.getServletContext().addServerEndpoint(...)
  • 示例片段:
    registry.addServlet(new ServletRegistrationBean<>(new ServerEndpointRegistration(), "/echo"));
    实际上不成立——ServerEndpointRegistration 不是 Servlet,必须用 ServerEndpointConfig.Builder.create(MyEndpoint.class, "/echo").build() 构造后交给容器

Maven 依赖冲突导致 @ServerEndpoint 编译通过但运行报错

典型错误是 java.lang.NoClassDefFoundError: javax/websocket/Endpoint 或启动时报 ClassNotFoundException: org.apache.tomcat.websocket.server.WsSci,说明 JSR-356 API 和实现没对齐。

ProcessOn
ProcessOn

免费在线流程图思维导图,专业强大的作图工具,支持多人实时在线协作

下载
  • 确保只有一套 WebSocket API:用 javax.websocket-api(1.1),不要混用 jakarta.websocket-api(2.0+),后者是 Jakarta EE 9+,与 Tomcat 9/10 兼容性有坑
  • Tomcat 9 对应 javax.websocket-api:1.1,Tomcat 10.1+ 才正式支持 jakarta.websocket-api:2.1;若强行在 Tomcat 9 里引 jakarta 包,@ServerEndpoint 注解会被忽略且无提示
  • 检查 mvn dependency:tree -Dincludes=websocket,删掉重复或版本错配的依赖,尤其是 spring-boot-starter-websocket 带来的 tomcat-embed-websocket 和你手动引的冲突

开发调试时容易忽略的容器初始化时机

@ServerEndpoint 类的静态块、构造方法、@OnOpen 方法执行顺序,取决于容器何时完成扫描和实例化——它不等 Spring 上下文就绪,所以不能在 @OnOpen 里直接注入 @Autowired Bean。

立即学习Java免费学习笔记(深入)”;

  • 如果需要访问 Spring Bean,必须通过 ApplicationContextProvider 手动获取,或改用 Spring 的 WebSocketHandler + WebSocketConfigurer 方案
  • 日志打不出来?因为 @OnOpen 可能在 Logback 初始化前执行,建议先用 System.out.println 确认是否进入
  • 路径匹配失败常见于 URL 写成 /ws/echo 却在客户端连 ws://localhost:8080/echo,注意上下文路径(context-path)是否影响前缀
事情说清了就结束。真正卡住的往往不是注解本身,而是容器、API 版本、类加载顺序这三者之间的隐式耦合。

热门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、检查文件编码方式等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

159

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、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

245

2024.02.23

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

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

169

2024.02.23

c++ 字符处理
c++ 字符处理

本专题整合了c++字符处理教程、字符串处理函数相关内容,阅读专题下面的文章了解更多详细内容。

0

2026.03.17

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 4.5万人学习

C# 教程
C# 教程

共94课时 | 11.5万人学习

Java 教程
Java 教程

共578课时 | 83.7万人学习

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

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