消息流程

一旦公开 STOMP 端点,Spring 应用程序就会成为连接客户端的 STOMP 代理。本节介绍服务器端消息流。

spring-messaging 模块包含来自 Spring Integration 的消息应用程序的基础支持,后来被提取并合并到 Spring 框架中,以便在许多 Spring 项目 和应用程序场景中更广泛地使用。以下列表简要介绍了一些可用的消息抽象

Java 配置(即 @EnableWebSocketMessageBroker)和 XML 命名空间配置(即 <websocket:message-broker>)都使用上述组件来组装消息工作流。下图显示了启用简单内置消息代理时使用的组件。

message flow simple broker

上图显示了三个消息通道。

  • clientInboundChannel: 用于传递从 WebSocket 客户端接收的消息。

  • clientOutboundChannel: 用于将服务器消息发送到 WebSocket 客户端。

  • brokerChannel: 用于将消息从服务器端应用程序代码发送到消息代理。

下图显示了为管理订阅和广播消息而配置外部代理(如 RabbitMQ)时使用的组件。

message flow broker relay

前两个图之间的主要区别在于使用“代理中继”通过 TCP 将消息传递到外部 STOMP 代理,并将消息从代理传递到已订阅的客户端。

当从 WebSocket 连接接收消息时,它们会被解码为 STOMP 帧,转换为 Spring Message 表示形式,并发送到 clientInboundChannel 以进行进一步处理。例如,目标标头以 /app 开头的 STOMP 消息可能会被路由到带注释控制器的 @MessageMapping 方法,而 /topic/queue 消息可能会直接路由到消息代理。

处理来自客户端的 STOMP 消息的带注释 @Controller 可以通过 brokerChannel 向消息代理发送消息,代理通过 clientOutboundChannel 将消息广播到匹配的订阅者。同一个控制器也可以在响应 HTTP 请求时执行相同的操作,因此客户端可以执行 HTTP POST,然后 @PostMapping 方法可以向消息代理发送消息以广播到已订阅的客户端。

我们可以通过一个简单的示例来跟踪流程。考虑以下示例,它设置了一个服务器。

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

	@Override
	public void registerStompEndpoints(StompEndpointRegistry registry) {
		registry.addEndpoint("/portfolio");
	}

	@Override
	public void configureMessageBroker(MessageBrokerRegistry registry) {
		registry.setApplicationDestinationPrefixes("/app");
		registry.enableSimpleBroker("/topic");
	}
}

@Controller
public class GreetingController {

	@MessageMapping("/greeting")
	public String handle(String greeting) {
		return "[" + getTimestamp() + ": " + greeting;
	}
}

上述示例支持以下流程。

  1. 客户端连接到 localhost:8080/portfolio,并且在建立 WebSocket 连接后,STOMP 帧开始在其上流动。

  2. 客户端发送一个目标标头为 /topic/greeting 的 SUBSCRIBE 帧。一旦接收并解码,消息就会被发送到 clientInboundChannel,然后被路由到消息代理,消息代理存储客户端订阅。

  3. 客户端发送一个 SEND 帧到 /app/greeting/app 前缀帮助将其路由到带注解的控制器。在去除 /app 前缀后,剩余的 /greeting 部分被映射到 GreetingController 中的 @MessageMapping 方法。

  4. GreetingController 返回的值被转换为一个 Spring Message,其负载基于返回值,默认目标头为 /topic/greeting(从输入目标中将 /app 替换为 /topic 导出)。生成的 message 被发送到 brokerChannel 并由消息代理处理。

  5. 消息代理找到所有匹配的订阅者,并通过 clientOutboundChannel 向每个订阅者发送一个 MESSAGE 帧,从这里消息被编码为 STOMP 帧并通过 WebSocket 连接发送。

下一节将详细介绍带注解的方法,包括支持的各种参数和返回值类型。