点作为分隔符

当消息被路由到 @MessageMapping 方法时,它们会与 AntPathMatcher 进行匹配。默认情况下,模式期望使用斜杠 (/) 作为分隔符。这在 Web 应用程序中是一个很好的约定,类似于 HTTP URL。但是,如果你更习惯于消息传递约定,则可以切换到使用点 (.) 作为分隔符。

以下示例展示了如何这样做

  • Java

  • Kotlin

  • XML

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfiguration implements WebSocketMessageBrokerConfigurer {

	// ...

	@Override
	public void configureMessageBroker(MessageBrokerRegistry registry) {
		registry.setPathMatcher(new AntPathMatcher("."));
		registry.enableStompBrokerRelay("/queue", "/topic");
		registry.setApplicationDestinationPrefixes("/app");
	}
}
@Configuration
@EnableWebSocketMessageBroker
class WebSocketConfiguration : WebSocketMessageBrokerConfigurer {

	// ...

	override fun configureMessageBroker(registry: MessageBrokerRegistry) {
		registry.setPathMatcher(AntPathMatcher("."))
		registry.enableStompBrokerRelay("/queue", "/topic")
		registry.setApplicationDestinationPrefixes("/app")
	}
}
<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" path-matcher="pathMatcher">
		<websocket:stomp-endpoint path="/stomp"/>
		<websocket:stomp-broker-relay prefix="/topic,/queue" />
	</websocket:message-broker>

	<bean id="pathMatcher" class="org.springframework.util.AntPathMatcher">
		<constructor-arg index="0" value="."/>
	</bean>

</beans>

之后,控制器可以在 @MessageMapping 方法中使用点 (.) 作为分隔符,如下例所示

  • Java

  • Kotlin

@Controller
@MessageMapping("red")
public class RedController {

	@MessageMapping("blue.{green}")
	public void handleGreen(@DestinationVariable String green) {
		// ...
	}
}
@Controller
@MessageMapping("red")
class RedController {

	@MessageMapping("blue.{green}")
	fun handleGreen(@DestinationVariable green: String) {
		// ...
	}
}

客户端现在可以向 /app/red.blue.green123 发送消息。

在前面的示例中,我们没有更改“broker relay”上的前缀,因为它们完全取决于外部消息 broker。请参阅你使用的 broker 的 STOMP 文档页面,了解它对目标 header 支持哪些约定。

另一方面,“simple broker”确实依赖于配置的 PathMatcher,因此,如果你切换分隔符,该更改也会应用于 broker 以及 broker 将消息中的目标与订阅模式匹配的方式。