用户目的地

应用程序可以发送针对特定用户的消息,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());
	}
}

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

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