问题描述:

大体描述:
tomcat加载war包 出现javax.websocket.server.ServerContainer not available
详细描述:
springboot项目打了war包,发现在tomcat8.5.32下运行不起来,报下面的异常,经测试,在tomcat8.5.51及以上版本就可以运行起来。

Caused by: org.springframework.beans.factory.BeanCreationException: 
Error creating bean with name 'serverEndpointExporter' defined in class path resource [org/xx/config/WebSocketConfig.class]: 
Invocation of init method failed;
nested exception is java.lang.IllegalStateException: 
javax.websocket.server.ServerContainer not available

问题场景:

经排查后,发现是websoket出现了问题,下面我原来的代码
在这里插入图片描述
后来查阅资料,修改为以下代码,项目正常运行,下面加入了@Profile注解
@Profile注解的参数为字符数组,当项目环境Active profiles为dev或者test时,@bean serverEndpointExporter会正常装配,当Active profiles是其他比如produce的时候,serverEndpointExporter会被忽略不进行装配
在这里插入图片描述

问题原因:

描述1: 创建使用@ServerEndpoint创立websocket endpoint时,首先要注入ServerEndpointExporter,这个bean会自动注册使用了@ServerEndpoint注解声明的Websocket endpoint。要注意,如果使用独立的servlet容器,而不是直接使用springboot的内置容器,就不要注入ServerEndpointExporter,因为它将由容器自己提供和管理。

描述2: 该bean将使用底层的WebSocket容器注册任何被@ServerEndpoint注解的beans。当部署到一个单独的servlet容器时,该角色将被一个servlet容器初始化方法执行,ServerEndpointExporter bean也就不需要了。

描述3: ServerEndpointExporter 是由Spring官方提供的标准实现,用于扫描ServerEndpointConfig配置类和@ServerEndpoint注解实例。使用规则也很简单:
如果使用默认的嵌入式容器,则必须手工在上下文提供ServerEndpointExporter。
如果使用外部容器部署war包,则不需要提供提供ServerEndpointExporter,因为此时SpringBoot默认将扫描服务端的行为交给外部容器处理,所以线上部署的时候要把WebSocketConfig中这段注入bean的代码注掉。

解决方案:

所以发布项目war包时

  1. 要么把serverEndpointExporter方法注释掉,或者直接删掉,
@Configuration
public class WebSocketConfig {
    /**
     *  注入ServerEndpointExporter,
     *  这个bean会自动注册使用了@ServerEndpoint注解声明的Websocket endpoint
     */
//    @Bean
//    public ServerEndpointExporter serverEndpointExporter() {
//        return new ServerEndpointExporter();
//    }
}
  1. 要么使用@Profile注解,在什么模式下进行装配,上面@Profile({“dev”, “test”})的意思就是在dev和test模式下装配,发布为produce时不进行装配

@Configuration
public class WebSocketConfig {
    /**
     *  注入ServerEndpointExporter,
     *  这个bean会自动注册使用了@ServerEndpoint注解声明的Websocket endpoint
     */
    @Profile({"dev", "test"})
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

上面知识为经过以下参考总结,详细可以看下面的网址
1.解决SpringBoot使用war打包后运行javax.websocket.server.ServerContainer not available报错问题
2.使用@ServerEndpoint创建WebSocket端点
3.spring boot Websocket(使用笔记)
4.SpringBoot2.0集成WebSocket,实现后台向前端推送信息

Logo

腾讯云面向开发者汇聚海量精品云计算使用和开发经验,营造开放的云计算技术生态圈。

更多推荐