SpringBootTest @EnabledWebSocket 忽略

Question

我想测试我的 WebSocket 应用程序。

测试class：

@RunWith(SpringRunner.class)
@SpringBootTest(
    webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
@ContextConfiguration(
    classes = {WebConfig.class, WebSocketConfig.class}
@DirtiesContext
public class IntegrationTest {

    @Autowired
    public EmbeddedWebApplicationContext server;   

    @Test
    ...
}

WebConfig class:

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

    public final WebSocketService webSocketService;

    @Autowired
    public WebConfig(WebSocketService webSocketService) {
        this.webSocketService = webSocketService;
    }

    @Bean
    public EmbeddedServletContainerFactory servletContainer() {
        TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory();
        tomcat.setPort(1234);
        tomcat.setContextPath("/test");

        return tomcat;
    }
}

和 WebSocketConfig class:

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Autowired
    public WebSocketConfig() {}                     

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {        

        webSocketHandlerRegistry.addHandler(webSocketHandler(), "ws")                
            .setAllowedOrigins("*")                
    }

    @Bean
    public WebSocketHandler webSocketHandler() {
        return new WebsocketHandler(webSocketService());
    }

    @Bean
    publicWebSocketService webSocketService() {
        return newWebSocketServiceImpl();
    }
}

当我开始测试时，Tomcat 正在启动并正在侦听指定的端口 1234。但我无法连接 websocket 客户端。 WebSocketConfig 被调用。但我认为 websocket 映射不起作用。我忘记配置什么了吗？

当我使用带有 @SpringBootApplication 注释的应用程序 class (WebSocketApp.class) 开始测试时，websocket 映射工作正常。

@RunWith(SpringRunner.class)
@SpringBootTest(
    webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
@ContextConfiguration(
    classes = {WebSocketApp.class}
@DirtiesContext
public class IntegrationTest {

    @Autowired
    public EmbeddedWebApplicationContext server;   

    @Test
    ...
}

WebSocketApp也使用相同的配置。

我假设第二种方法有效，因为使用了 @EnableWebSocket。当我不使用 WebSocketApp.class（用 @SpringBootApplication 注释）时，@EnableWebSocket 将被忽略。

有没有人有想法进行测试运行？如何在没有注释的情况下手动启用 websockets？

编辑：

我发现 TomcatEmbeddedContext 使用默认的 servlet 映射而不是 dispatcherServlet 映射。是否可以设置这种类型的映射？

Answer 1

我找到了解决办法。在测试配置中 Spring 没有 bootstrap websocket 容器和 servlet 映射。

我不得不添加一些额外的配置：

@Bean
    public ServletServerContainerFactoryBean createWebSocketContainer() {
        ServletServerContainerFactoryBean container = new ServletServerContainerFactoryBean();
        container.setMaxTextMessageBufferSize(8192);
        container.setMaxBinaryMessageBufferSize(8192);
        return container;
    }

    @Bean
    public DispatcherServlet dispatcherServlet() {
        return new DispatcherServlet();
    }

    @Bean
    public ServletRegistrationBean dispatchServletRegistration() {

        ServletRegistrationBean registration = new ServletRegistrationBean(
            dispatcherServlet(), "/");

        registration
            .setName(DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_BEAN_NAME);

        return registration;

    }

然后到 EmbeddedServletContainerFactory bean：

tomcat.addContextCustomizers((TomcatContextCustomizer) context ->
            context.addServletContainerInitializer(new WsSci(), null));

Answer 2

就我而言，在我的 Spring 启动测试 class 中添加 @EnableAutoConfiguration，解决了这个问题。 Spring 初始化 DispatcherServlet 并正确配置它

SpringBootTest @EnabledWebSocket 忽略

SpringBootTest @EnabledWebSocket ignored

java

spring

spring-boot

spring-websocket

spring-boot-test