tomcat部署WebSocket服务，初始化ServerEndPointExporter失败问题

原创已于 2022-04-09 17:32:45 修改 · 4.8k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#java #tomcat

于 2022-04-09 17:06:39 首次发布

java 专栏收录该内容

6 篇文章

订阅专栏

本文探讨了SpringBoot项目中WebSocket在内置容器和Tomcat容器下运行时遇到的ServerEndPointExporter类加载失败问题。当在Tomcat中部署时，由于容器扫描机制的不同，需要移除或通过@Profile注解来条件化@Bean注解。解决方案包括直接删除bean注解或者使用环境配置来控制bean的创建，确保在正确环境中加载WebSocket配置。

原代码如下

@ServerEndPoint("push")
@Component
public class MyWebSocket｛
    ＠OnOpen
    public void onOpen(Session session) {
        //收到客户端连接
    }

    @OnMessage
    public void onMessage(String message){
        //收到客户端发送的消息
    }
｝


@Configuration
public class WebSocketConfiguration{
     @Bean
    public ServerEndPointExporter serverEndPointExporter()｛
        return new ServerEndPointExporter();
    ｝
}

上述是本地项目启动测试代码，调试都没有任何问题，但是打包后部署在tomcat中启动，就会报ServerEndPointExporter类加载失败问题

解决方案

1、直接删除serverEndPointExporter()方法上的bean注解，然后打包部署，测试websocket功能都能正常调用（本地测试就会有问题，本地需要将bean注解打开）

2、通过@profile注解，解决bean注解忘记注释的问题

@Configuration
public class WebSocketConfiguration{
    @Profile("test")
 	@Bean
    public ServerEndPointExporter serverEndPointExporter｛
    	return new ServerEndPointExporter();
    ｝
}
//需要在application.properties中指定 spring.profiles.active = test

分析原因：

简单来说：就是ServerEndPointExporter，在springboot内置容器（嵌入式容器）中运行时，必须上下文提供ServerEndpointExporter

但是在tomcat容器中运行时，扫描工作会交给容器处理，不需要bean注入。