启用STOMP

STOMP over WebSocket支持在spring-messagingspring-websocket模块中可用。一旦您有了这些依赖项,您就可以像下面的示例一样在WebSocket上公开一个STOMP端点:

import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

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

	@Override
	public void configureMessageBroker(MessageBrokerRegistry config) {
		config.setApplicationDestinationPrefixes("/app"); (2)
		config.enableSimpleBroker("/topic", "/queue"); (3)
	}
}
1 /portfolio是WebSocket(或SockJS)客户端需要连接进行WebSocket握手的端点的HTTP URL。
2 目的地标头以/app开头的STOMP消息将路由到@Controller类中的@MessageMapping方法。
3 使用内置消息代理进行订阅和广播,并将目的地标头以/topic/queue开头的消息路由到代理。

以下示例展示了前面示例的XML配置等效项:

<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:websocket="http://www.springframework.org/schema/websocket"
	xsi:schemaLocation="
		http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/websocket
		https://www.springframework.org/schema/websocket/spring-websocket.xsd">

	<websocket:message-broker application-destination-prefix="/app">
		<websocket:stomp-endpoint path="/portfolio" />
		<websocket:simple-broker prefix="/topic, /queue"/>
	</websocket:message-broker>

</beans>
对于内置的简单代理,/topic/queue前缀没有任何特殊含义。它们只是一种区分发布-订阅与点对点消息传递(即,多个订阅者与一个消费者)的约定。当您使用外部代理时,请查看代理的STOMP页面,了解它支持的STOMP目的地和前缀的类型。

要从浏览器连接,对于STOMP,您可以使用stomp-js/stompjs,这是最活跃维护的JavaScript库。

以下示例代码基于此:

const stompClient = new StompJs.Client({
       brokerURL: 'ws://domain.com/portfolio',
       onConnect: () => {
           // ...
       }
   });

或者,如果通过SockJS连接,您可以在服务器端启用SockJS Fallback,使用registry.addEndpoint("/portfolio").withSockJS(),在JavaScript端,按照这些说明进行操作。

请注意,在前面的示例中,stompClient不需要指定loginpasscode标头。即使指定了,它们也会在服务器端被忽略(或者说被覆盖)。有关身份验证的更多信息,请参阅连接到代理身份验证

更多示例代码请参见: