SpringBoot整合WebSocket测试报错解决方案

问题描述

ja vax.websocket.server.ServerContainer not a vailable

问题起因

在SpringBoot项目中使用@SpringBootTest进行单元测试时，该注解默认会加载所有受管理的Bean，相当于启动了一个完整的应用上下文。理论上，此时应能正常测试各项功能。然而，问题出现在Web环境的配置上。由于Web服务是常见的测试目标，@SpringBootTest专门提供了webEnvironment参数来控制Web环境的类型，共有四个选项：

• MOCK：默认值，提供一个Mock环境，可配合@AutoConfigureMockMvc或@AutoConfigureWebTestClient使用。注意：此模式下内嵌Servlet容器并未实际启动，也不会监听端口，因此WebSocket相关的容器不可用，报错正是源于此。
• RANDOM_PORT：启动一个真实的Web服务，监听一个随机端口。
• DEFINED_PORT：启动一个真实的Web服务，监听application.properties中配置的端口。
• NONE：启动一个非Web的ApplicationContext，既不提供Mock环境，也不启动真实Web服务。

简而言之，开发者在测试类中未指定webEnvironment，默认使用了MOCK，而WebSocket需要真实的Servlet容器才能正常工作，因此抛出该异常。

解决方案

在@SpringBootTest注解中显式指定一个真实的Web环境即可，例如：

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
class BilibiliApplicationTests {
    // 测试代码
}

也可使用RANDOM_PORT，效果相同——关键是让内嵌容器真正启动运行。

总结

该问题本质上是测试环境与生产环境差异导致的。默认的Mock环境对大多数Web测试友好，但针对WebSocket这类需要真实容器的场景，必须手动切换。这一经验可为遇到类似报错的开发者提供参考。