在 Spring Boot 中使用 Java API for WebSocket (JSR-356)

Question

我是 Spring 新手（并且在 stackoverflow 上提问）。

我想通过 Spring Boot 启动嵌入式 (Tomcat) 服务器并向其注册 JSR-356 WebSocket 端点。

这是主要的方法：

@ComponentScan
@EnableAutoConfiguration
public class Server {
    public static void main(String[] args) {
        SpringApplication.run(Server.class, args);
    }
}

这是配置的样子：

@Configuration
public class EndpointConfig {

    @Bean
    public EchoEndpoint echoEndpoint() {
        return new EchoEndpoint();
    }

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

EchoEndpoint 的实现很简单：

@ServerEndpoint(value = "/echo", configurator = SpringConfigurator.class)
public class EchoEndpoint {

    @OnMessage
    public void handleMessage(Session session, String message) throws IOException {
        session.getBasicRemote().sendText("echo: " + message);
    }
}

对于第二部分，我关注了这篇博文：https://spring.io/blog/2013/05/23/spring-framework-4-0-m1-websocket-support。

但是，当我运行应用程序时，我得到：

Exception in thread "main" org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'endpointExporter' defined in class path resource [hello/EndpointConfig.class]: Initialization of bean failed; nested exception is java.lang.IllegalStateException: Failed to get javax.websocket.server.ServerContainer via ServletContext attribute

该异常进一步是由ServerEndpointExporter 中的NullPointerException 引起的，因为此时applicationContext 上的getServletContext 方法仍返回null。

有对 Spring 有更深入了解的人可以帮帮我吗？谢谢！

Answer 1

ServerEndpointExporter 对应用程序上下文的生命周期做出了一些假设，当您使用 Spring Boot 时这些假设不成立。具体来说，假设当调用setApplicationContext 时，在该ApplicationContext 上调用getServletContext 将返回一个非空值。

您可以通过替换来解决该问题：

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

与：

@Bean
public ServletContextAware endpointExporterInitializer(final ApplicationContext applicationContext) {
    return new ServletContextAware() {

        @Override
        public void setServletContext(ServletContext servletContext) {
            ServerEndpointExporter serverEndpointExporter = new ServerEndpointExporter();
            serverEndpointExporter.setApplicationContext(applicationContext);
            try {
                serverEndpointExporter.afterPropertiesSet();
            } catch (Exception e) {
                throw new RuntimeException(e);
            }               
        }           
    };
}

这会延迟处理，直到 servlet 上下文可用。

更新：您可能想观看SPR-12109。修复后，上述解决方法将不再需要。