在Spring Websockets上构建自定义API

Question

我必须在Websockets上实现自定义API,这需要:

• 自定义WAMP类子协议
• 套接字URI中的路径参数

所以我有以下问题:

• 是否有任何关于在Spring中实现自定义子协议的文档或指南？协议要求必须在Sec-Websocket-Protocol字段中指定确切的版本.哪个字段可以在服务器端读取？

• 将路径参数传递给消息处理程序的正确方法是什么？我可以在处理程序注册中使用ant模式

      @Override 
      public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
          registry.addHandler(customHandler(), "/api/custom/{clientId}");
      }
  

  但是TextWebSocketHandler似乎没有.我现在通过以下方式扩展默认的HttpSessionHandshakeInterceptor来解决这个问题:

  public class CustomHandshakeInterceptor extends HttpSessionHandshakeInterceptor {
      private static final UriTemplate URI_TEMPLATE = new UriTemplate("/api/custom/{clientId}");
  
      @Override
      public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response,
                                     WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception {
          Map<String, String> segments = URI_TEMPLATE.match(request.getURI().getPath());
          attributes.put("CLIENTID", segments.get("clientId"));
  
          return super.beforeHandshake(request, response, wsHandler, attributes);
      }
  }
  

  然后在TextWebSocketHandler中访问它:

  public class CustomHandler extends TextWebSocketHandler {
  
      @Override
      protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
          super.handleTextMessage(session, message);
  
          String clientId = session.getAttributes().get("CLIENTID");
  
          ...
  
          session.sendMessage(response);
      }
  
  }
  

  但在我看来,这种方法有点笨拙.有没有更合适的方法来解决这个问题？

谢谢.

Answer 1

我能给出的最好建议是遵循内置的子协议支持的示例——从SubProtocolWebSocketHandler和开始SubProtocolHandler，它委托包括实现StompSubProtocolHandler。进一步SubProtocolWebSocketHandler连接到“clientInbound”和“clientOutbound”通道，然后使用这些通道形成处理流并提供线程边界。

有一个 STOMP 处理流程的描述http://docs.spring.io/spring/docs/current/spring-framework-reference/html/websocket.html#websocket-stomp-message-flow其中包括将消息委托给带注释的控制器和/或消息代理，消息代理也可以将消息发送回下游客户端。

本质上是与具有协议特定内容的 SpringStompSubProtocolHandler之间的转换。因此，控制器、消息代理或来自客户端入站通道的消息的任何其他使用者都与 WebSocket 传输层分离并且不知道。许多围绕此类子协议消息的构建、发送和处理而构建的设施可能可用于支持其他类似 STOMP 的协议。这包括包中的所有类。WebSocketMessageMessageorg.springframework.messaging.simp

至于 URL 路径参数，Spring 在 WebSocket 级别没有提供任何内容，主要是传输层。大多数有趣的事情发生在子协议级别。例如，对于 STOMP，aMessageMapping是基于目标标头支持的，与在 Spring MVC 中@DestinationVariable使用的 a 相当@PathVariable，但基于目标标头，而不是 URL。