使用Stomp的WebSocket客户端无法接收订阅数据求助

1. 订阅路径完全匹配检查 #

• 客户端订阅路径与服务端发送目的地必须完全一致，包括前缀（/topic/、/queue/）、大小写、后缀：
  • 错误示例：客户端订/topic/data，服务端发/topic/Data或/topic/datas
  • 正确示例：双方统一用/topic/real-time-data
• 确认服务端消息代理前缀配置覆盖了订阅路径：

  @Configuration
  @EnableWebSocketMessageBroker
  public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
      @Override
      public void configureMessageBroker(MessageBrokerRegistry registry) {
          // 必须包含客户端订阅的路径前缀
          registry.enableSimpleBroker("/topic", "/queue");
          registry.setApplicationDestinationPrefixes("/app");
      }
  
      @Override
      public void registerStompEndpoints(StompEndpointRegistry registry) {
          registry.addEndpoint("/ws-stomp").withSockJS();
      }
  }
  

2. 消息目标类型与用户定向检查 #

• 区分广播与点对点场景：
  • 广播用/topic/前缀，服务端可直接用SimpMessagingTemplate.convertAndSend("/topic/xxx", data)
  • 点对点用/queue/前缀，若给特定用户发送，必须用convertAndSendToUser方法，客户端订阅路径需加/user/前缀：
    服务端代码：

    @Autowired
    private SimpMessagingTemplate messagingTemplate;
    
    public void sendToUser(String username, Object data) {
        // 第二个参数是用户专属路径前缀
        messagingTemplate.convertAndSendToUser(username, "/queue/private", data);
    }
    

    客户端订阅：

    stompClient.subscribe('/user/queue/private', function(msg) {
        console.log('收到私有消息:', JSON.parse(msg.body));
    });
    

• 若用@SendToUser注解，客户端同样需要订阅/user/前缀的路径

3. 客户端订阅时机与错误排查 #

• 必须在STOMP连接成功回调内发起订阅，不能提前执行：

  const socket = new SockJS('/ws-stomp');
  const stompClient = Stomp.over(socket);
  
  stompClient.connect({}, function(frame) {
      // 连接成功后再订阅
      stompClient.subscribe('/topic/real-time-data', function(msg) {
          console.log('收到消息:', JSON.parse(msg.body));
      });
  }, function(error) {
      // 打印连接失败原因
      console.error('STOMP连接失败:', error);
  });
  

• 打开浏览器控制台（F12），查看是否有订阅失败的HTTP错误（403/404）或STOMP协议错误，不要只依赖网络面板的发布请求日志

4. 服务端配置与拦截器检查 #

• 确认WebSocket配置类被Spring正确扫描（比如放在主启动类同包或子包下）
• 若自定义了消息拦截器，检查preSend方法是否返回null（会丢弃消息）：

  @Override
  public void configureClientInboundChannel(ChannelRegistration registration) {
      registration.interceptors(new ChannelInterceptor() {
          @Override
          public Message<?> preSend(Message<?> message, MessageChannel channel) {
              // 不要返回null，除非明确要拦截该消息
              return message;
          }
      });
  }
  

5. 消息序列化/反序列化检查 #

• 若服务端发送Java对象，确保Spring Boot已配置Jackson JSON转换器（默认已配置，但需确认对象有无无参构造、getter方法）
• 客户端回调必须解析message.body，而不是直接打印message对象：

  // 错误：直接打印message对象
  stompClient.subscribe('/topic/xxx', function(msg) { console.log(msg); });
  // 正确：解析消息体
  stompClient.subscribe('/topic/xxx', function(msg) { console.log(JSON.parse(msg.body)); });
  

内容的提问来源于stack exchange，提问作者Priya