带注解的控制器

应用程序可以使用带注解的 @Controller 类来处理来自客户端的消息。此类可以声明 @MessageMapping@SubscribeMapping@ExceptionHandler 方法,如下所述:

@MessageMapping

您可以使用 @MessageMapping 注解方法,根据消息目的地路由消息。它支持方法级别和类型级别。在类型级别上,@MessageMapping 用于表示控制器中所有方法共享的映射。

默认情况下,映射值是 Ant 风格的路径模式(例如 /thing*/thing/**),包括支持模板变量(例如 /thing/{id})。这些值可以通过 @DestinationVariable 方法参数引用。应用程序还可以切换到以点分隔的目的地约定进行映射,如作为分隔符的点中所述。

支持的方法参数

下表描述了方法参数:

方法参数 描述

Message

用于访问完整消息。

MessageHeaders

用于访问 Message 中的头部。

MessageHeaderAccessorSimpMessageHeaderAccessorStompHeaderAccessor

通过类型化访问器方法访问头部。

@Payload

用于访问消息负载,通过配置的 MessageConverter 进行转换(例如,从 JSON)。

此注解不是必需的,因为它在默认情况下,如果没有其他参数匹配,则假定存在。

您可以使用 @jakarta.validation.Valid 或 Spring 的 @Validated 注解负载参数,以便自动验证负载参数。

@Header

用于访问特定头部值 — 必要时,通过 org.springframework.core.convert.converter.Converter 进行类型转换。

@Headers

用于访问消息中的所有头部。此参数必须可赋值给 java.util.Map

@DestinationVariable

用于访问从消息目的地提取的模板变量。必要时,将值转换为声明的方法参数类型。

java.security.Principal

反映 WebSocket HTTP 握手时登录的用户。

返回值

默认情况下,@MessageMapping 方法的返回值通过匹配的 MessageConverter 序列化为负载,并作为 Message 发送到 brokerChannel,然后从那里广播给订阅者。出站消息的目的地与入站消息的目的地相同,但前缀为 /topic

您可以使用 @SendTo@SendToUser 注解自定义输出消息的目的地。@SendTo 用于自定义目标目的地或指定多个目的地。@SendToUser 用于将输出消息仅发送给与输入消息关联的用户。请参阅用户目的地

您可以在同一方法上同时使用 @SendTo@SendToUser,并且它们都支持在类级别使用,在这种情况下,它们充当类中方法的默认值。但是,请记住,任何方法级别的 @SendTo@SendToUser 注解都会覆盖类级别的任何此类注解。

消息可以异步处理,@MessageMapping 方法可以返回 ListenableFutureCompletableFutureCompletionStage

请注意,@SendTo@SendToUser 仅仅是方便用法,相当于使用 SimpMessagingTemplate 发送消息。如果需要,对于更高级的场景,@MessageMapping 方法可以直接使用 SimpMessagingTemplate。这可以代替或可能额外返回一个值。请参阅发送消息

@SubscribeMapping

@SubscribeMapping 类似于 @MessageMapping,但将映射范围缩小到仅订阅消息。它支持与 @MessageMapping 相同的方法参数。但是对于返回值,默认情况下,消息直接发送到客户端(通过 clientOutboundChannel,作为对订阅的响应),而不是发送到代理(通过 brokerChannel,作为对匹配订阅的广播)。添加 @SendTo@SendToUser 会覆盖此行为,并改为发送到代理。

这何时有用?假设代理映射到 /topic/queue,而应用程序控制器映射到 /app。在这种设置下,代理存储所有旨在重复广播的 /topic/queue 订阅,应用程序无需参与。客户端也可以订阅某个 /app 目的地,控制器可以响应该订阅返回一个值,而无需涉及代理,也无需再次存储或使用该订阅(实际上是一次性请求-回复交换)。一个用例是在启动时用初始数据填充 UI。

这何时无用?除非您希望代理和控制器都以某种原因独立处理消息(包括订阅),否则不要尝试将它们映射到相同的前缀。入站消息是并行处理的。无法保证代理或控制器首先处理给定消息。如果目标是在订阅存储并准备好进行广播时收到通知,如果服务器支持(简单代理不支持),客户端应该请求收据。例如,使用 Java STOMP 客户端,您可以执行以下操作来添加收据:

@Autowired
private TaskScheduler messageBrokerTaskScheduler;

// During initialization..
stompClient.setTaskScheduler(this.messageBrokerTaskScheduler);

// When subscribing..
StompHeaders headers = new StompHeaders();
headers.setDestination("/topic/...");
headers.setReceipt("r1");
FrameHandler handler = ...;
stompSession.subscribe(headers, handler).addReceiptTask(receiptHeaders -> {
	// Subscription ready...
});

服务器端选项是在 brokerChannel注册一个 ExecutorChannelInterceptor 并实现 afterMessageHandled 方法,该方法在消息(包括订阅)处理后调用。

@MessageExceptionHandler

应用程序可以使用 @MessageExceptionHandler 方法来处理来自 @MessageMapping 方法的异常。您可以在注解本身中声明异常,或者如果您想访问异常实例,可以通过方法参数声明。以下示例通过方法参数声明异常:

@Controller
public class MyController {

	// ...

	@MessageExceptionHandler
	public ApplicationError handleException(MyException exception) {
		// ...
		return appError;
	}
}

@MessageExceptionHandler 方法支持灵活的方法签名,并支持与 @MessageMapping 方法相同的方法参数类型和返回值。

通常,@MessageExceptionHandler 方法适用于它们声明的 @Controller 类(或类层次结构)中。如果您希望这些方法更全局地应用(跨控制器),您可以在用 @ControllerAdvice 标记的类中声明它们。这与 Spring MVC 中可用的类似支持相当。

© . This site is unofficial and not affiliated with VMware.