对于最新的稳定版本,请使用 Spring Framework 6.2.10spring-doc.cadn.net.cn

用户目标

应用程序可以发送针对特定用户的消息,并且 Spring 的 STOMP 支持识别以/user/为此目的。例如,客户端可能会订阅/user/queue/position-updates目的地。UserDestinationMessageHandler处理此目的地并将其转换为用户会话独有的目的地(例如/queue/position-updates-user123). 这提供了订阅通用名称目的地的便利,同时,同时,确保不会与订阅相同目的地的其他用户发生冲突目的地,以便每个用户都可以接收到唯一的股票头寸更新。spring-doc.cadn.net.cn

使用用户目标时,配置代理和应用程序目标前缀非常重要,如启用 STOMP 中所示,否则代理将处理仅应由UserDestinationMessageHandler.

在发送端,可以将消息发送到目标,例如/user/{username}/queue/position-updates,而这又被翻译由UserDestinationMessageHandler进入一个或多个目的地,每个目的地一个与用户关联的会话。这使得应用程序内的任何组件都可以发送针对特定用户的消息,而不必知道更多比他们的名称和通用目的地。这也通过注释和消息传递模板。spring-doc.cadn.net.cn

消息处理方法可以向与通过@SendToUser注释(也支持类级别以共享公共目标),如以下示例所示:spring-doc.cadn.net.cn

@Controller
public class PortfolioController {

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

如果用户有多个会话,默认情况下,所有订阅的会话都定向给定目标。但是,有时可能需要仅定位发送正在处理的消息的会话。您可以通过以下方式将broadcast属性设置为 false,如以下示例所示:spring-doc.cadn.net.cn

@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(也就是说,仅针对发送正在处理的消息的会话)。

您可以从任何应用程序向用户目标发送消息组件,例如,通过注入SimpMessagingTemplate由 Java 配置创建或XML 命名空间。(bean 名称为brokerMessagingTemplate如有需要以取得资格@Qualifier.) 以下示例显示了如何执行此作:spring-doc.cadn.net.cn

@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 具有用于清除非活动目标的配置选项

在多应用程序服务器场景中,用户目标可能保持未解析状态,因为用户连接到不同的服务器。在这种情况下,您可以配置destination 来广播未解析的消息,以便其他服务器有机会尝试。这可以通过userDestinationBroadcast属性的MessageBrokerRegistry在 Java 配置中,并且user-destination-broadcast属性 的message-brokerXML 中的元素。spring-doc.cadn.net.cn