用户目的地

ChatGPT-4o-mini 中英对照 User Destinations

一个应用程序可以发送针对特定用户的消息，Spring 的 STOMP 支持识别以 /user/ 为前缀的目标。比如，一个客户端可能会订阅 /user/queue/position-updates 目标。UserDestinationMessageHandler 处理这个目标，并将其转换为一个唯一的用户会话目标（例如 /queue/position-updates-user123）。这提供了订阅一个通用命名目标的便利，同时确保与其他订阅相同目标的用户之间没有冲突，从而使每个用户都能够接收独特的股票头寸更新。

提示

在处理用户目的地时，重要的是配置代理和应用程序目的地前缀，如 启用 STOMP 中所示，否则代理将处理以 "/user" 为前缀的消息，而这些消息应该仅由 UserDestinationMessageHandler 处理。

在发送方，消息可以发送到一个目标，例如 /user/{username}/queue/position-updates，该目标会被 UserDestinationMessageHandler 转换为一个或多个目标，每个目标对应与用户关联的一个会话。这使得应用程序中的任何组件都可以发送针对特定用户的消息，而不必了解除了他们的名字和通用目标之外的任何其他信息。这也通过注解和消息模板得到了支持。

一个消息处理方法可以通过 @SendToUser 注解将消息发送给与正在处理的消息相关联的用户（也支持在类级别上共享一个公共目的地），如下例所示：

@Controller
public class PortfolioController {

    @MessageMapping("/trade")
    @SendToUser("/queue/position-updates")
    public TradeResult executeTrade(Trade trade, Principal principal) {
        // ...
        return tradeResult;
    }
}

java

如果用户有多个会话，默认情况下，所有订阅了给定目的地的会话都会被目标定位。然而，有时可能需要仅针对发送正在处理的消息的会话。您可以通过将 broadcast 属性设置为 false 来实现，如以下示例所示：

@Controller
public class MyController {

    @MessageMapping("/action")
    public void handleAction() throws Exception{
        // raise MyBusinessException here
    }

    @MessageExceptionHandler
    @SendToUser(destinations="/queue/errors", broadcast=false)
    public ApplicationError handleException(MyBusinessException exception) {
        // ...
        return appError;
    }
}

java

备注

虽然用户目标通常意味着经过身份验证的用户，但这并不是严格要求的。一个未与经过身份验证的用户关联的 WebSocket 会话可以订阅用户目标。在这种情况下，@SendToUser 注解的行为与 broadcast=false 完全相同（即，仅针对发送正在处理的消息的会话）。

您可以通过从任何应用程序组件发送消息到用户目标，例如，注入由 Java 配置或 XML 命名空间创建的 SimpMessagingTemplate。 （如果需要使用 @Qualifier 进行限定，则 bean 名称为 brokerMessagingTemplate。）以下示例展示了如何做到这一点：

@Service
public class TradeServiceImpl implements TradeService {

    private final SimpMessagingTemplate messagingTemplate;

    @Autowired
    public TradeServiceImpl(SimpMessagingTemplate messagingTemplate) {
        this.messagingTemplate = messagingTemplate;
    }

    // ...

    public void afterTradeExecuted(Trade trade) {
        this.messagingTemplate.convertAndSendToUser(
                trade.getUserName(), "/queue/position-updates", trade.getResult());
    }
}

java

备注

当您使用外部消息代理的用户目的地时，您应该查看代理文档以了解如何管理非活动队列，以便在用户会话结束时，所有唯一用户队列都被移除。例如，RabbitMQ 在您使用诸如 /exchange/amq.direct/position-updates 的目的地时，会创建自动删除队列。因此，在这种情况下，客户端可以订阅 /user/exchange/amq.direct/position-updates。类似地，ActiveMQ 也有 配置选项 用于清除非活动目的地。

在多应用服务器场景中，用户目标可能保持未解析状态，因为用户连接到不同的服务器。在这种情况下，您可以配置一个目标来广播未解析的消息，以便其他服务器有机会进行尝试。这可以通过 Java 配置中的 MessageBrokerRegistry 的 userDestinationBroadcast 属性和 XML 中 message-broker 元素的 user-destination-broadcast 属性来完成。