WebSockets

本参考文档部分涵盖了对响应式堆栈WebSocket消息传递的支持。

WebSocket简介

WebSocket协议，RFC 6455，提供了一种标准化的方式，在单个TCP连接上建立全双工的双向通信通道，用于客户端和服务器之间的通信。它是一种不同于HTTP的TCP协议，但设计用于通过HTTP工作，使用端口80和443，并允许重用现有的防火墙规则。

WebSocket交互始于使用HTTP请求，该请求使用HTTP Upgrade头部来升级或在这种情况下切换到WebSocket协议。以下示例展示了这样的交互：

GET /spring-websocket-portfolio/portfolio HTTP/1.1
Host: localhost:8080
Upgrade: websocket (1)
Connection: Upgrade (2)
Sec-WebSocket-Key: Uc9l9TMkWGbHFD2qnFHltg==
Sec-WebSocket-Protocol: v10.stomp, v11.stomp
Sec-WebSocket-Version: 13
Origin: http://localhost:8080
1 Upgrade头部。
2 使用Upgrade连接。

具有WebSocket支持的服务器返回类似以下内容而不是通常的200状态代码：

HTTP/1.1 101 Switching Protocols (1)
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: 1qVdfYHU9hPOl4JYYNXF623Gzn0=
Sec-WebSocket-Protocol: v10.stomp
1 协议切换

成功握手后，HTTP升级请求下的TCP套接字保持打开状态，以便客户端和服务器继续发送和接收消息。

WebSocket工作原理的完整介绍超出了本文档的范围。请参阅RFC 6455、HTML5的WebSocket章节或网络上的许多介绍和教程。

请注意，如果WebSocket服务器运行在Web服务器（例如nginx）后面，您可能需要配置它以将WebSocket升级请求传递给WebSocket服务器。同样，如果应用程序在云环境中运行，请查看与WebSocket支持相关的云提供商的说明。

HTTP与WebSocket对比

尽管WebSocket旨在与HTTP兼容并以HTTP请求开始，但重要的是要理解这两种协议导致非常不同的架构和应用程序编程模型。

在HTTP和REST中，应用程序被建模为许多URL。客户端通过访问这些URL以请求-响应方式与应用程序交互。服务器根据HTTP URL、方法和头部将请求路由到适当的处理程序。

相比之下，在WebSocket中，通常只有一个URL用于初始连接。随后，所有应用程序消息都在同一个TCP连接上流动。这指向了完全不同的异步、事件驱动、消息传递架构。

WebSocket还是一种低级传输协议，不像HTTP那样对消息内容规定任何语义。这意味着除非客户端和服务器就消息语义达成一致，否则无法路由或处理消息。

WebSocket客户端和服务器可以通过HTTP握手请求上的Sec-WebSocket-Protocol头部协商使用更高级别的消息传递协议（例如STOMP）。在没有这种情况下，它们需要制定自己的约定。

何时使用WebSockets

WebSockets可以使网页动态和交互。然而，在许多情况下，AJAX和HTTP流或长轮询的组合可以提供简单有效的解决方案。

例如，新闻、邮件和社交动态需要动态更新，但每隔几分钟更新可能完全可以。另一方面，协作、游戏和金融应用需要更接近实时。

仅仅延迟不是决定因素。如果消息量相对较低（例如，监视网络故障），HTTP流或轮询可以提供有效的解决方案。低延迟、高频率和高消息量的组合使WebSocket的使用成为最佳选择。

还要记住，在互联网上，您无法控制的限制性代理可能会阻止WebSocket交互，要么是因为它们未配置为传递Upgrade头部，要么是因为它们关闭看似空闲的长连接。这意味着对于防火墙内部应用程序而言，使用WebSocket比面向公众的应用程序更为直接。

WebSocket API

查看在Servlet堆栈中的等效内容

Spring Framework提供了一个WebSocket API，您可以使用它来编写处理WebSocket消息的客户端和服务器端应用程序。

服务器

查看在Servlet堆栈中的等效内容

要创建一个WebSocket服务器，您可以首先创建一个WebSocketHandler。以下示例显示了如何创建：

  • Java

  • Kotlin

import org.springframework.web.reactive.socket.WebSocketHandler;
import org.springframework.web.reactive.socket.WebSocketSession;

public class MyWebSocketHandler implements WebSocketHandler {

	@Override
	public Mono<Void> handle(WebSocketSession session) {
		// ...
	}
}
import org.springframework.web.reactive.socket.WebSocketHandler
import org.springframework.web.reactive.socket.WebSocketSession

class MyWebSocketHandler : WebSocketHandler {

	override fun handle(session: WebSocketSession): Mono<Void> {
		// ...
	}
}

然后您可以将其映射到一个URL：

  • Java

  • Kotlin

@Configuration
class WebConfig {

	@Bean
	public HandlerMapping handlerMapping() {
		Map<String, WebSocketHandler> map = new HashMap<>();
		map.put("/path", new MyWebSocketHandler());
		int order = -1; // 在注解控制器之前

		return new SimpleUrlHandlerMapping(map, order);
	}
}
@Configuration
class WebConfig {

	@Bean
	fun handlerMapping(): HandlerMapping {
		val map = mapOf("/path" to MyWebSocketHandler())
		val order = -1 // 在注解控制器之前

		return SimpleUrlHandlerMapping(map, order)
	}
}

如果使用WebFlux配置，则无需进一步操作；否则，如果不使用WebFlux配置，则需要声明一个WebSocketHandlerAdapter，如下所示：

  • Java

  • Kotlin

@Configuration
class WebConfig {

	// ...

	@Bean
	public WebSocketHandlerAdapter handlerAdapter() {
		return new WebSocketHandlerAdapter();
	}
}
@Configuration
class WebConfig {

	// ...

	@Bean
	fun handlerAdapter() =  WebSocketHandlerAdapter()
}

WebSocketHandler

WebSocketHandler的handle方法接受WebSocketSession并返回Mono<Void>，以指示应用程序处理会话何时完成。会话通过两个流处理，一个用于入站消息，一个用于出站消息。以下表格描述了处理这两个流的两种方法：

WebSocketSession方法 描述

Flux<WebSocketMessage> receive()

提供对入站消息流的访问，并在连接关闭时完成。

Mono<Void> send(Publisher<WebSocketMessage>)

接受用于传出消息的源，写入消息，并返回一个Mono<Void>，当源完成并写入完成时完成。

WebSocketHandler必须将入站和出站流组合成统一流，并返回反映该流完成的Mono<Void>。根据应用程序要求，统一流在以下情况完成：

  • 入站或出站消息流中的任一流完成。

  • 入站流完成（即连接关闭），而出站流是无限的。

  • 通过WebSocketSession的close方法在选择的点完成。

当将入站和出站消息流组合在一起时，无需检查连接是否打开，因为响应式流信号会结束活动。入站流接收完成或错误信号，出站流接收取消信号。

处理程序的最基本实现是处理入站流的处理程序。以下示例显示了这样的实现：

  • Java

  • Kotlin

class ExampleHandler implements WebSocketHandler {

	@Override
	public Mono<Void> handle(WebSocketSession session) {
		return session.receive()			(1)
				.doOnNext(message -> {
					// ...					(2)
				})
				.concatMap(message -> {
					// ...					(3)
				})
				.then();					(4)
	}
}
1 访问入站消息流。
2 对每条消息执行操作。
3 执行使用消息内容的嵌套异步操作。
4 返回一个Mono<Void>，当接收完成时完成。 
class ExampleHandler : WebSocketHandler {

	override fun handle(session: WebSocketSession): Mono<Void> {
		return session.receive()            (1)
				.doOnNext {
					// ...					(2)
				}
				.concatMap {
					// ...					(3)
				}
				.then()                     (4)
	}
}
1 访问入站消息流。
2 对每条消息执行操作。
3 执行使用消息内容的嵌套异步操作。
4 返回一个Mono<Void>，当接收完成时完成。
对于嵌套的异步操作，您可能需要在使用池化数据缓冲区的底层服务器（例如Netty）上调用message.retain()。否则，在读取数据之前，数据缓冲区可能会被释放。有关更多背景信息，请参阅数据缓冲区和编解码器。

以下实现将入站和出站流组合在一起：

  • Java

  • Kotlin

class ExampleHandler implements WebSocketHandler {

	@Override
	public Mono<Void> handle(WebSocketSession session) {

		Flux<WebSocketMessage> output = session.receive()				(1)
				.doOnNext(message -> {
					// ...
				})
				.concatMap(message -> {
					// ...
				})
				.map(value -> session.textMessage("Echo " + value));	(2)

		return session.send(output);									(3)
	}
}
1 处理入站消息流。
2 创建传出消息，生成组合流。
3 返回一个Mono<Void>，在继续接收时不会完成。 
class ExampleHandler : WebSocketHandler {

	override fun handle(session: WebSocketSession): Mono<Void> {

		val output = session.receive()                      (1)
				.doOnNext {
					// ...
				}
				.concatMap {
					// ...
				}
				.map { session.textMessage("Echo $it") }    (2)

		return session.send(output)                         (3)
	}
}
1 处理入站消息流。
2 创建传出消息，生成组合流。
3 返回一个Mono<Void>，在继续接收时不会完成。

入站和出站流可以是独立的，并仅在完成时连接，如下例所示：

  • Java

  • Kotlin

class ExampleHandler implements WebSocketHandler {

	@Override
	public Mono<Void> handle(WebSocketSession session) {

		Mono<Void> input = session.receive()								(1)
				.doOnNext(message -> {
					// ...
				})
				.concatMap(message -> {
					// ...
				})
				.then();

		Flux<String> source = ... ;
		Mono<Void> output = session.send(source.map(session::textMessage));	(2)

		return Mono.zip(input, output).then();								(3)
	}
}
1 处理传入消息流。
2 发送传出消息。
3 合并流并返回一个Mono<Void>，当任一流结束时完成。 
class ExampleHandler : WebSocketHandler {

	override fun handle(session: WebSocketSession): Mono<Void> {

		val input = session.receive()									(1)
				.doOnNext {
					// ...
				}
				.concatMap {
					// ...
				}
				.then()

		val source: Flux<String> = ...
		val output = session.send(source.map(session::textMessage))		(2)

		return Mono.zip(input, output).then()							(3)
	}
}
1 处理传入消息流。
2 发送传出消息。
3 合并流并返回一个Mono<Void>，当任一流结束时完成。

DataBuffer

DataBuffer是WebFlux中字节缓冲区的表示。参考中的Spring Core部分在数据缓冲区和编解码器部分有更多相关内容。要理解的关键点是，在像Netty这样的一些服务器上，字节缓冲区是被池化和引用计数的，必须在消耗时释放以避免内存泄漏。

在Netty上运行时，应用程序必须使用DataBufferUtils.retain(dataBuffer)，如果希望保留输入数据缓冲区以确保它们不被释放，然后在缓冲区被消耗时使用DataBufferUtils.release(dataBuffer)。

握手

在Servlet堆栈中查看等效内容

WebSocketHandlerAdapter委托给一个WebSocketService。默认情况下，这是HandshakeWebSocketService的一个实例，它对WebSocket请求执行基本检查，然后使用RequestUpgradeStrategy用于所使用的服务器。目前，内置支持Reactor Netty、Tomcat、Jetty和Undertow。

HandshakeWebSocketService公开了一个sessionAttributePredicate属性，允许设置一个Predicate<String>来从WebSession中提取属性并将其插入到WebSocketSession的属性中。

服务器配置

在Servlet堆栈中查看等效内容

每个服务器的RequestUpgradeStrategy公开了特定于底层WebSocket服务器引擎的配置。当使用WebFlux Java配置时，您可以自定义这些属性，如在WebFlux配置的相应部分中所示，或者如果不使用WebFlux配置，则使用以下内容：

  • Java

  • Kotlin

@Configuration
class WebConfig {

	@Bean
	public WebSocketHandlerAdapter handlerAdapter() {
		return new WebSocketHandlerAdapter(webSocketService());
	}

	@Bean
	public WebSocketService webSocketService() {
		TomcatRequestUpgradeStrategy strategy = new TomcatRequestUpgradeStrategy();
		strategy.setMaxSessionIdleTimeout(0L);
		return new HandshakeWebSocketService(strategy);
	}
}
@Configuration
class WebConfig {

	@Bean
	fun handlerAdapter() =
			WebSocketHandlerAdapter(webSocketService())

	@Bean
	fun webSocketService(): WebSocketService {
		val strategy = TomcatRequestUpgradeStrategy().apply {
			setMaxSessionIdleTimeout(0L)
		}
		return HandshakeWebSocketService(strategy)
	}
}

检查您的服务器的升级策略，查看可用的选项。目前，只有Tomcat和Jetty公开了这些选项。

CORS

在Servlet堆栈中查看等效内容

WebSocketHandler实现 CorsConfigurationSource并返回一个带有允许的来源、标头和其他详细信息的 CorsConfiguration。如果无法这样做，还可以在 SimpleUrlHandler上设置 corsConfigurations属性，以指定URL模式的CORS设置。如果两者都指定了，可以使用 CorsConfiguration上的 combine方法进行组合。

客户端

Spring WebFlux提供了一个WebSocketClient抽象，其中包含Reactor Netty、Tomcat、Jetty、Undertow和标准Java（即JSR-356）的实现。

Tomcat客户端实际上是标准Java客户端的扩展，具有一些额外功能，用于利用Tomcat特定的API来暂停接收消息以进行背压处理。
execute方法：

  • Java

  • Kotlin

WebSocketClient client = new ReactorNettyWebSocketClient();

URI url = new URI("ws://localhost:8080/path");
client.execute(url, session ->
		session.receive()
				.doOnNext(System.out::println)
				.then());
val client = ReactorNettyWebSocketClient()

		val url = URI("ws://localhost:8080/path")
		client.execute(url) { session ->
			session.receive()
					.doOnNext(::println)
			.then()
		}
Lifecycle，需要在使用之前停止和启动。所有客户端都有与配置底层WebSocket客户端相关的构造函数选项。