如何使用 Spring WebSocket 向 STOMP 客户端发送错误消息?
How to send ERROR message to STOMP clients with Spring WebSocket?
我正在使用 Spring 的 STOMP over WebSocket 实现和功能齐全的 ActiveMQ 代理。当用户 SUBSCRIBE
访问一个主题时,他们必须通过一些权限逻辑才能成功订阅。我正在使用 ChannelInterceptor 应用权限逻辑,如下配置:
WebSocketConfig.java:
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
registry.addEndpoint("/stomp")
.setAllowedOrigins("*")
.withSockJS();
}
@Override
public void configureMessageBroker(MessageBrokerRegistry registry) {
registry.enableStompBrokerRelay("/topic", "/queue")
.setRelayHost("relayhost.mydomain.com")
.setRelayPort(61613);
}
@Override
public void configureClientInboundChannel(ChannelRegistration registration) {
registration.setInterceptors(new MySubscriptionInterceptor());
}
}
WebSocketSecurityConfig.java:
public class WebSocketSecurityConfig extends AbstractSecurityWebSocketMessageBrokerConfigurer {
@Override
protected void configureInbound(MessageSecurityMetadataSourceRegistry messages) {
messages
.simpSubscribeDestMatchers("/stomp/**").authenticated()
.simpSubscribeDestMatchers("/user/queue/errors").authenticated()
.anyMessage().denyAll();
}
}
MySubscriptionInterceptor.java:
public class MySubscriptionInterceptor extends ChannelInterceptorAdapter {
@Override
public Message<?> preSend(Message<?> message, MessageChannel channel) {
StompHeaderAccessor headerAccessor= StompHeaderAccessor.wrap(message);
Principal principal = headerAccessor.getUser();
if (StompCommand.SUBSCRIBE.equals(headerAccessor.getCommand())) {
checkPermissions(principal);
}
return message;
}
private void checkPermissions(Principal principal) {
// apply permissions logic
// throw Exception permissions not sufficient
}
}
当没有足够权限的客户端尝试订阅受限主题时,他们实际上从未收到来自该主题的任何消息,但也不会收到拒绝订阅的抛出异常的通知。相反,客户端会返回一个 ActiveMQ 代理一无所知的无效订阅。 (正常的、充分许可的客户端与 STOMP 端点和主题的交互按预期工作。)
我已经尝试订阅 users/{subscribingUsername}/queue/errors
并在我的 Java 测试客户端成功连接后只是简单地 users/queue/errors
,但到目前为止我还无法得到某种错误从服务器发送到客户端的有关订阅异常的消息。这显然不太理想,因为从未通知客户他们已被拒绝访问。
你不能只在 clientInboundChannel
上从 MySubscriptionInterceptor
抛出异常,因为最后一个是 ExecutorSubscribableChannel
,因此是 async
以及来自那些的任何异常线程最终会出现在日志中,并重新抛给调用者 - StompSubProtocolHandler.handleMessageFromClient
.
但是你可以做的是 clientOutboundChannel
并像这样使用它:
StompHeaderAccessor headerAccessor = StompHeaderAccessor.create(StompCommand.ERROR);
headerAccessor.setMessage(error.getMessage());
clientOutboundChannel.send(MessageBuilder.createMessage(new byte[0], headerAccessor.getMessageHeaders()));
要考虑的另一个选项是注释映射:
@SubscribeMapping("/foo")
public void handleWithError() {
throw new IllegalArgumentException("Bad input");
}
@MessageExceptionHandler
@SendToUser("/queue/error")
public String handleException(IllegalArgumentException ex) {
return "Got error: " + ex.getMessage();
}
我正在使用 Spring 的 STOMP over WebSocket 实现和功能齐全的 ActiveMQ 代理。当用户 SUBSCRIBE
访问一个主题时,他们必须通过一些权限逻辑才能成功订阅。我正在使用 ChannelInterceptor 应用权限逻辑,如下配置:
WebSocketConfig.java:
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
registry.addEndpoint("/stomp")
.setAllowedOrigins("*")
.withSockJS();
}
@Override
public void configureMessageBroker(MessageBrokerRegistry registry) {
registry.enableStompBrokerRelay("/topic", "/queue")
.setRelayHost("relayhost.mydomain.com")
.setRelayPort(61613);
}
@Override
public void configureClientInboundChannel(ChannelRegistration registration) {
registration.setInterceptors(new MySubscriptionInterceptor());
}
}
WebSocketSecurityConfig.java:
public class WebSocketSecurityConfig extends AbstractSecurityWebSocketMessageBrokerConfigurer {
@Override
protected void configureInbound(MessageSecurityMetadataSourceRegistry messages) {
messages
.simpSubscribeDestMatchers("/stomp/**").authenticated()
.simpSubscribeDestMatchers("/user/queue/errors").authenticated()
.anyMessage().denyAll();
}
}
MySubscriptionInterceptor.java:
public class MySubscriptionInterceptor extends ChannelInterceptorAdapter {
@Override
public Message<?> preSend(Message<?> message, MessageChannel channel) {
StompHeaderAccessor headerAccessor= StompHeaderAccessor.wrap(message);
Principal principal = headerAccessor.getUser();
if (StompCommand.SUBSCRIBE.equals(headerAccessor.getCommand())) {
checkPermissions(principal);
}
return message;
}
private void checkPermissions(Principal principal) {
// apply permissions logic
// throw Exception permissions not sufficient
}
}
当没有足够权限的客户端尝试订阅受限主题时,他们实际上从未收到来自该主题的任何消息,但也不会收到拒绝订阅的抛出异常的通知。相反,客户端会返回一个 ActiveMQ 代理一无所知的无效订阅。 (正常的、充分许可的客户端与 STOMP 端点和主题的交互按预期工作。)
我已经尝试订阅 users/{subscribingUsername}/queue/errors
并在我的 Java 测试客户端成功连接后只是简单地 users/queue/errors
,但到目前为止我还无法得到某种错误从服务器发送到客户端的有关订阅异常的消息。这显然不太理想,因为从未通知客户他们已被拒绝访问。
你不能只在 clientInboundChannel
上从 MySubscriptionInterceptor
抛出异常,因为最后一个是 ExecutorSubscribableChannel
,因此是 async
以及来自那些的任何异常线程最终会出现在日志中,并重新抛给调用者 - StompSubProtocolHandler.handleMessageFromClient
.
但是你可以做的是 clientOutboundChannel
并像这样使用它:
StompHeaderAccessor headerAccessor = StompHeaderAccessor.create(StompCommand.ERROR);
headerAccessor.setMessage(error.getMessage());
clientOutboundChannel.send(MessageBuilder.createMessage(new byte[0], headerAccessor.getMessageHeaders()));
要考虑的另一个选项是注释映射:
@SubscribeMapping("/foo")
public void handleWithError() {
throw new IllegalArgumentException("Bad input");
}
@MessageExceptionHandler
@SendToUser("/queue/error")
public String handleException(IllegalArgumentException ex) {
return "Got error: " + ex.getMessage();
}