RSocket

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

Spring Framework 的 spring-messaging 模块提供了对 RSocket 请求者(requesters)和响应者(responders)的支持,包括客户端和服务器端。有关更多详细信息,包括 RSocket 协议的概览,请参阅 Spring Framework 参考文档的RSocket 部分

RSocket Strategies 自动配置

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

  1. 使用 Jackson 的 CBOR 编解码器

  2. 使用 Jackson 的 JSON 编解码器

spring-boot-starter-rsocket starter 同时提供了这两个依赖。有关定制可能性的更多信息,请参阅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 实例是一个原型(prototype)bean,这意味着每个注入点都将为你提供一个新实例。这是故意设计的,因为这个 builder 是有状态的,你不应该使用同一个实例来创建具有不同设置的请求者。

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

  • 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
		)
	}

}