RSocket

RSocket 是一种用于字节流传输的二进制协议。它通过单个连接上的异步消息传递,支持对称交互模型。

Spring 框架的 spring-messaging 模块为 RSocket 请求者和响应者提供支持,无论是在客户端还是在服务器端。有关更多详细信息,包括 RSocket 协议概述,请参阅 Spring 框架参考中的 RSocket 部分

RSocket 策略自动配置

Spring Boot 自动配置一个 RSocketStrategies bean,该 bean 提供对 RSocket 负载进行编码和解码所需的所有基础设施。默认情况下,自动配置将尝试按以下顺序配置:

  1. CBOR 编解码器与 Jackson

  2. JSON 编解码器与 Jackson

spring-boot-starter-rsocket 启动器提供了这两个依赖项。有关自定义选项的更多信息,请参阅 Jackson 支持部分

开发人员可以通过创建实现 RSocketStrategiesCustomizer 接口的 Bean 来自定义 RSocketStrategies 组件。请注意,它们的 @Order 非常重要,因为它决定了编解码器的顺序。

RSocket 服务器自动配置

Spring Boot 提供了 RSocket 服务器自动配置。所需的依赖项由 spring-boot-starter-rsocket 提供。

Spring Boot 允许从 WebFlux 服务器通过 WebSocket 公开 RSocket,或启动独立的 RSocket 服务器。这取决于应用程序的类型及其配置。

对于 WebFlux 应用程序(类型为 WebApplicationType.REACTIVE),只有在以下属性匹配时,RSocket 服务器才会被插入 Web 服务器。

  • 属性

  • YAML

spring.rsocket.server.mapping-path=/rsocket
spring.rsocket.server.transport=websocket
spring:
  rsocket:
    server:
      mapping-path: "/rsocket"
      transport: "websocket"
将 RSocket 插入 Web 服务器仅在使用 Reactor Netty 时受支持,因为 RSocket 本身就是使用该库构建的。

或者,RSocket TCP 或 websocket 服务器作为独立的嵌入式服务器启动。除了依赖项要求之外,唯一需要的配置是为该服务器定义一个端口。

  • 属性

  • YAML

spring.rsocket.server.port=9898
spring:
  rsocket:
    server:
      port: 9898

Spring Messaging RSocket 支持

Spring Boot 将自动配置 RSocket 的 Spring Messaging 基础设施。

这意味着 Spring Boot 将创建一个 RSocketMessageHandler Bean,该 Bean 将处理对应用程序的 RSocket 请求。

使用 RSocketRequester 调用 RSocket 服务

一旦服务器和客户端之间建立了 RSocket 通道,任何一方都可以向另一方发送或接收请求。

作为服务器,您可以在 RSocket @Controller 的任何处理程序方法中注入 RSocketRequester 实例。作为客户端,您需要先配置并建立 RSocket 连接。Spring Boot 为此类情况自动配置了 RSocketRequester.Builder,并使用预期的编解码器并应用任何 RSocketConnectorConfigurer Bean。

RSocketRequester.Builder 实例是一个原型 Bean,这意味着每个注入点都会为您提供一个新的实例。这是有意为之的,因为此构建器是有状态的,您不应使用同一个实例创建具有不同设置的请求器。

以下代码显示了一个典型的示例

  • Java

  • Kotlin

import reactor.core.publisher.Mono;

import org.springframework.messaging.rsocket.RSocketRequester;
import org.springframework.stereotype.Service;

@Service
public class MyService {

	private final RSocketRequester rsocketRequester;

	public MyService(RSocketRequester.Builder rsocketRequesterBuilder) {
		this.rsocketRequester = rsocketRequesterBuilder.tcp("example.org", 9898);
	}

	public Mono<User> someRSocketCall(String name) {
		return this.rsocketRequester.route("user").data(name).retrieveMono(User.class);
	}

}
import org.springframework.messaging.rsocket.RSocketRequester
import org.springframework.stereotype.Service
import reactor.core.publisher.Mono

@Service
class MyService(rsocketRequesterBuilder: RSocketRequester.Builder) {

	private val rsocketRequester: RSocketRequester

	init {
		rsocketRequester = rsocketRequesterBuilder.tcp("example.org", 9898)
	}

	fun someRSocketCall(name: String): Mono<User> {
		return rsocketRequester.route("user").data(name).retrieveMono(
			User::class.java
		)
	}

}