Spring Boot 2.x集成WebSocket

盖丽男2024-02-10 23:37

Spring Boot 2.x集成WebSocket详解

websocket的接入是非常简单的，就是可能会遇到起不来或者调不通的问题，大部分是因为jar包冲突，可以根据自己碰到的不同问题针对解决。

一、准备工作

引入spring-boot-starter-websocket依赖包
配置支持Servlet 3.1的运行时环境,比如Tomcat 8+
在Spring Boot主应用类上添加@EnableWebSocket注解启用WebSocket功能

二、核心配置

创建一个配置类,定义ServerEndpointExporter的@Bean,该Bean负责扫描和注册@ServerEndpoint注解的WebSocket Endpoint

java 复制代码

@Bean
public ServerEndpointExporter serverEndpointExporter() {
    return new ServerEndpointExporter(); 
}

使用@ServerEndpoint注解实现一个WebSocket Endpoint,处理连接、消息、关闭等事件

java 复制代码

@Component
@ServerEndpoint("/websocket")
public class MyEndpoint {

    @OnOpen
    public void onOpen(){
        // 连接建立时执行
    } 
    
    @OnMessage
    public void onMessage(Session session, String message) {
        // 收到消息时执行
    }

}

WebSocket Endpoint可以直接注入Spring管理的业务Bean进行复用

三、注意事项

IllegalStateException: javax.websocket.server.ServerContainer not available

该问题大概率是因为项目中混入了一个以上的容器，请把你能看到的所有jetty包都排除出去，推荐使用maven-helper辅助解决。