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

@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。常见现象是:连接能建,但 @OnOpen 里 this.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 的复用和线程安全操作。
实操建议:
- 实现
TextWebSocketHandler,重写handleTextMessage和afterConnectionEstablished - 用
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 - 别在
@OnMessage或handleTextMessage里做耗时操作(如查 DB、调远程接口),会阻塞整个 WebSocket 线程池;应丢进TaskExecutor异步处理 - Tomcat 的 WebSocket 默认最大帧大小是 8KB,超长消息会静默断连,需在
application.properties改:server.tomcat.max-http-post-size=-1和spring.websocket.server.max-text-message-size=512000
真正难的从来不是“怎么连上”,而是连接存活期间的状态同步、异常重连策略、多实例 session 广播、以及当 WebSocketSession 在某个节点失效后,如何让其他节点感知并清理 —— 这些没法靠一个注解解决。










