用户目的地
应用程序可以发送消息,目标是特定用户,Spring 的 STOMP 支持识别以 /user/
为前缀的目标,用于此目的。例如,客户端可以订阅 /user/queue/position-updates
目标。UserDestinationMessageHandler
处理此目标,并将其转换为对用户会话唯一的目标(例如 /queue/position-updates-user123
)。这提供了订阅通用命名目标的便利,同时确保不会与订阅相同目标的其他用户发生冲突,以便每个用户都可以接收唯一的股票持仓更新。
在使用用户目标时,重要的是要配置代理和应用程序目标前缀,如 启用 STOMP 中所示,否则代理将处理应该仅由 UserDestinationMessageHandler 处理的以 "/user" 为前缀的消息。
|
在发送端,消息可以发送到诸如 /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;
}
}
如果用户有多个会话,默认情况下,所有订阅了给定目标的会话都会成为目标。但是,有时可能需要仅针对发送正在处理的消息的会话。可以通过将 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;
}
}
虽然用户目标通常意味着经过身份验证的用户,但这不是严格要求的。与经过身份验证的用户无关的 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());
}
}
当您将用户目标与外部消息代理一起使用时,您应该检查代理文档以了解如何管理非活动队列,以便在用户会话结束后,所有唯一的用户队列都会被删除。例如,RabbitMQ 在您使用诸如 /exchange/amq.direct/position-updates 的目标时会创建自动删除队列。因此,在这种情况下,客户端可以订阅 /user/exchange/amq.direct/position-updates 。类似地,ActiveMQ 有 配置选项 用于清除非活动目标。
|
在多应用程序服务器场景中,用户目标可能无法解析,因为用户连接到不同的服务器。在这种情况下,您可以配置目标以广播未解析的消息,以便其他服务器有机会尝试。这可以通过 Java 配置中 MessageBrokerRegistry
的 userDestinationBroadcast
属性以及 XML 中 message-broker
元素的 user-destination-broadcast
属性来完成。