用户目的地

应用可以发送针对特定用户的消息,Spring 的 STOMP 支持为此目的识别以 /user/ 为前缀的目的地。例如,客户端可以订阅 /user/queue/position-updates 这个目的地。UserDestinationMessageHandler 会处理这个目的地,并将其转换为用户会话独有的目的地(例如 /queue/position-updates-user123)。这提供了订阅通用命名目的地的便利,同时确保不会与订阅同一目的地的其他用户发生冲突,从而使每个用户都能接收到独特的股票仓位更新。

使用用户目的地时,请务必按照启用 STOMP 中所示配置 broker 和应用目的地前缀,否则 broker 将处理本应只由 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());
	}
}
当使用外部消息 broker 与用户目的地结合时,你应该查阅 broker 文档了解如何管理非活跃队列,以便在用户会话结束后,所有独有的用户队列都会被移除。例如,当你使用 /exchange/amq.direct/position-updates 这样的目的地时,RabbitMQ 会创建自动删除队列。因此,在这种情况下,客户端可以订阅 /user/exchange/amq.direct/position-updates。类似地,ActiveMQ 也有用于清除非活跃目的地的配置选项

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