如何使用 Spring 实现自定义 WebSocket 子协议

kaq*_*qao 5 java spring websocket spring-websocket

我必须在 Spring Boot 应用程序中添加对自定义 WebSocket 子协议(因此不是 STOMP)的支持,但我很难理解我需要提供什么以及 Spring 已经拥有什么。

这就是我走了多远:

@Configuration
@EnableWebSocket
public class WebSocketAutoConfiguration implements WebSocketConfigurer {

    public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {
        webSocketHandlerRegistry.addHandler(this.webSocketHandler(), new String[]{endpointUrl});
    }

    @Bean
    public WebSocketHandler webSocketHandler() {
        ExecutorSubscribableChannel clientInboundChannel = new ExecutorSubscribableChannel();
        ExecutorSubscribableChannel clientOutboundChannel = new ExecutorSubscribableChannel();
        SubProtocolWebSocketHandler subProtocolWebSocketHandler = new SubProtocolWebSocketHandler(clientInboundChannel, clientOutboundChannel);
        subProtocolWebSocketHandler.addProtocolHandler(new SubProtocolHandler() {
            public List<String> getSupportedProtocols() {
                return Collections.singletonList("custom-protocol");
            }

            public void handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> message, MessageChannel outputChannel) throws Exception {
                session.sendMessage(new TextMessage("some message"));
            }

            public void handleMessageToClient(WebSocketSession session, Message<?> message) throws Exception {
            }

            public String resolveSessionId(Message<?> message) {
                return UUID.randomUUID().toString();
            }

            public void afterSessionStarted(WebSocketSession session, MessageChannel outputChannel) throws Exception {
                System.out.println("SESSION STARTED");
            }

            public void afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel) throws Exception {
                session.close();
                System.out.println("SESSION ENDED");
            }
        });
        return subProtocolWebSocketHandler;
    }
}
Run Code Online (Sandbox Code Playgroud)

从某种意义上说,这是有效的,它handleMessageFromClient确实在网络套接字消息上触发,但我无法理解MessageChannel outputChannel和的目的handleMessageToClient

是否有可能获得PerConnectionWebSocketHandler语义SubProtocolWebSocketHandler

与此相关的文档基本上不存在,例如文档handleMessageToClient

将给定的 {@link Message} 处理给与给定 WebSocket 会话关联的客户端。

嗯,太棒了。而且 STOMP 的实现令人难以置信,因此它们作为指南不太有用。

任何例子,广泛的步骤或任何东西,真的,将不胜感激。

kaq*_*qao 3

事实证明这非常容易。SubProtocolWebSocketHandler根本没必要去乱搞。唯一的要求是提供的WebSocketHandler实现SubProtocolCapable

public class CustomHandler implements WebSocketHandler, SubProtocolCapable {
   ...
}
Run Code Online (Sandbox Code Playgroud)

就这样。要制作一个PerConnectionWebSocketHandler,只需扩展它并实现即可SubProtocolCapable

public class CustomHandler extends PerConnectionWebSocketHandler implements SubProtocolCapable {
   ...
}
Run Code Online (Sandbox Code Playgroud)

  • @lqbweb 我正在实现 [graphql-ws](https://github.com/apollographql/subscriptions-transport-ws/blob/master/PROTOCOL.md) 子协议,以与 Apollo 客户端兼容。 (3认同)
  • 我只是好奇,为什么你必须实现自己的子协议? (2认同)