Webflux websocketclient,如何在同一会话中发送多个请求[设计客户端库]

Mri*_*jay 10 java spring spring-websocket project-reactor spring-webflux

TL; DR;

我们正在尝试使用spring webflux WebSocket实现设计WebSocket服务器.服务器具有通常的HTTP服务器操作,例如create/fetch/update/fetchall.使用WebSockets,我们试图公开一个端点,以便客户端可以利用单个连接进行所有类型的操作,因为WebSockets就是为此目的而设计的.它是一个使用webflux和WebSockets的正确设计吗?

长版

我们正在开始一个将使用反应式网络套接字的项目spring-webflux.我们需要构建一个反应式客户端库,消费者可以使用它来连接到服务器.

在服务器上,我们收到请求,读取消息,保存并返回静态响应:

public Mono<Void> handle(WebSocketSession webSocketSession) {
    Flux<WebSocketMessage> response = webSocketSession.receive()
            .map(WebSocketMessage::retain)
            .concatMap(webSocketMessage -> Mono.just(webSocketMessage)
                    .map(parseBinaryToEvent) //logic to get domain object
                    .flatMap(e -> service.save(e))
                    .thenReturn(webSocketSession.textMessage(SAVE_SUCCESSFUL))
            );

    return webSocketSession.send(response);
}
Run Code Online (Sandbox Code Playgroud)

在客户端,当有人调用save方法并从中返回响应时,我们想要打电话server.

public Mono<String> save(Event message) {
    new ReactorNettyWebSocketClient().execute(uri, session -> {
      session
              .send(Mono.just(session.binaryMessage(formatEventToMessage)))
              .then(session.receive()
                      .map(WebSocketMessage::getPayloadAsText)
                      .doOnNext(System.out::println).then()); //how to return this to client
    });
    return null;
}
Run Code Online (Sandbox Code Playgroud)

我们不确定,如何设计这个.理想情况下,我们认为应该有

1)client.execute应该只调用一次并以某种方式持有session.应使用相同的会话在后续调用中发送数据.

2)如何从我们进入的服务器返回响应session.receive

3)fetch如果响应很大(不仅仅是静态字符串而是事件列表),该session.receive怎么办?

我们正在做一些研究,但我们无法在网上找到适合webflux-websocket-client文档/实现的资源.关于如何前进的任何指示.

Ole*_*uka 10

请!使用RSocket!

这是绝对正确的设计,并且值得节省资源并且仅为每个客户端使用所有可能的操作的连接.

但是,不要实现轮子并使用协议,它为您提供所有这些类型的通信.

  • RSocket有一个请求 - 响应模型,允许您在今天进行最常见的客户端 - 服务器交互.
  • RSocket具有请求流通信模型,因此您可以满足所有需求并返回异步重用相同连接的事件流.RSocket将逻辑流的所有内容都连接到物理连接并返回,因此您不会感受到自己这样做的痛苦.
  • RSocket具有更多的交互模型,例如"即 发即弃"和" 流 - 流",这在以两种方式发送数据流时非常有用.

如何在Spring中使用RSocket

其中一个选项是使用RSocket协议的RSocket-Java实现.RSocket-Java建立在Project Reactor之上,因此它自然适合Spring WebFlux生态系统.

不幸的是,没有与Spring生态系统的特色集成.幸运的是,我花了几个小时来提供一个简单的RSocket Spring Boot Starter,它将Spring WebFlux与RSocket集成在一起,并将WebSocket RSocket服务器与WebFlux Http服务器一起公开.

为什么RSocket是更好的方法?

基本上,RSocket隐藏了自己实现相同方法的复杂性.使用RSocket,我们不必关心交互模型定义作为自定义协议和Java中的实现.RSocket为我们提供了将数据传送到特定逻辑信道的功能.它提供了一个内置客户端,可以将消息发送到同一个WS连接,因此我们不必为此创建自定义实现.

使用RSocket-RPC使其更好

由于RSocket只是一个协议,它不提供任何消息格式,因此这个挑战是针对业务逻辑的.但是,有一个RSocket-RPC项目,它提供一个协议缓冲区作为消息格式,并重用与GRPC相同的代码生成技术.因此,使用RSocket-RPC,我们可以轻松地为客户端和服务器构建API,并且根本不需要传输和协议抽象.

相同的RSocket Spring Boot集成也提供了RSocket-RPC使用的示例.

好吧,它还没有说服我,我想要一个自定义的WebSocket服务器

所以,为此目的,你必须自己实现这个地狱.我之前已经做过一次,但我不能指出那个项目,因为它是一个企业项目.不过,我可以分享几个代码示例,可以帮助您构建适当的客户端和服务器.

服务器端

处理程序和Open逻辑订阅服务器映射

必须考虑的第一点是,一个物理连接中的所有逻辑流都应存储在某处:

class MyWebSocketRouter implements WebSocketHandler {

  final Map<String, EnumMap<ActionMessage.Type, ChannelHandler>> channelsMapping;


  @Override
  public Mono<Void> handle(WebSocketSession session) {
    final Map<String, Disposable> channelsIdsToDisposableMap = new HashMap<>();
    ...
  }
}
Run Code Online (Sandbox Code Playgroud)

上面的示例中有两个地图.第一个是您的路由映射,它允许您根据传入的消息参数识别路由,或者左右.第二个是为请求流用例创建的(在我的例子中它是活动订阅的映射),因此您可以发送创建订阅的消息帧,或者订阅特定操作并在取消订阅后保留该订阅执行操作如果存在订阅,您将被取消订阅.

使用Processor进行消息多路复用

为了从所有逻辑流发回消息,您必须将消息多路复用到一个流.例如,使用Reactor,您可以使用UnicastProcessor以下方法执行此操作:

@Override
public Mono<Void> handle(WebSocketSession session) {
  final UnicastProcessor<ResponseMessage<?>> funIn = UnicastProcessor.create(Queues.<ResponseMessage<?>>unboundedMultiproducer().get());
  ...

  return Mono
    .subscriberContext()
    .flatMap(context -> Flux.merge(
      session
        .receive()
        ...
        .cast(ActionMessage.class)
        .publishOn(Schedulers.parallel())
        .doOnNext(am -> {
          switch (am.type) {
            case CREATE:
            case UPDATE:
            case CANCEL: {
              ...
            }
            case SUBSCRIBE: {
              Flux<ResponseMessage<?>> flux = Flux
                .from(
                  channelsMapping.get(am.getChannelId())
                                 .get(ActionMessage.Type.SUBSCRIBE)
                                 .handle(am) // returns Publisher<>
                );

              if (flux != null) {
                channelsIdsToDisposableMap.compute(
                  am.getChannelId() + am.getSymbol(), // you can generate a uniq uuid on the client side if needed
                  (cid, disposable) -> {
                    ...

                    return flux
                      .subscriberContext(context)
                      .subscribe(
                        funIn::onNext, // send message to a Processor manually
                        e -> {
                          funIn.onNext(
                            new ResponseMessage<>( // send errors as a messages to Processor here
                              0,
                              e.getMessage(),
                              ...
                              ResponseMessage.Type.ERROR
                            )
                          );
                        }
                      );
                  }
                );
              }

              return;
            }
            case UNSABSCRIBE: {
              Disposable disposable = channelsIdsToDisposableMap.get(am.getChannelId() + am.getSymbol());

              if (disposable != null) {
                disposable.dispose();
              }
            }
          }
        })
        .then(Mono.empty()),

        funIn
            ...
            .map(p -> new WebSocketMessage(WebSocketMessage.Type.TEXT, p))
            .as(session::send)
      ).then()
    );
}
Run Code Online (Sandbox Code Playgroud)

正如我们从上面的示例中看到的,那里有很多东西:

  1. 该消息应包括路由信息
  2. 该消息应包含与其相关的唯一流ID.
  3. 用于消息多路复用的独立处理器,其中错误也应该是消息
  4. 每个通道都应该存储在某个地方,在这种情况下我们都有一个简单的用例,每个消息可以提供一条Flux消息或只是一个Mono(如果是单声道,它可以在服务器端实现更简单,所以你不必保持唯一的流ID).
  5. 此示例不包含编码解码消息,因此您将面临这一挑战.

客户端

客户端也不那么简单:

处理会话

为了处理连接,我们必须分配两个处理器,以便我们可以使用它们来复用和解复用消息:

UnicastProcessor<> outgoing = ...
UnicastPorcessor<> incoming = ...
(session) -> {
  return Flux.merge(
     session.receive()
            .subscribeWith(incoming)
            .then(Mono.empty()),
     session.send(outgoing)
  ).then();
}
Run Code Online (Sandbox Code Playgroud)

将所有逻辑流保存在某处

所有创建的流无论是MonoFlux应该存储在某个地方,所以我们将能够区分哪个流消息涉及:

Map<String, MonoSink> monoSinksMap = ...;
Map<String, FluxSink> fluxSinksMap = ...;
Run Code Online (Sandbox Code Playgroud)

自MonoSink以来我们必须保留两张地图,而FluxSink没有相同的父接口.

消息路由

在上面的示例中,我们只考虑了客户端的初始部分.现在我们必须构建一个消息路由机制:

...
.subscribeWith(incoming)
.doOnNext(message -> {
    if (monoSinkMap.containsKey(message.getStreamId())) {
        MonoSink sink = monoSinkMap.get(message.getStreamId());
        monoSinkMap.remove(message.getStreamId());
        if (message.getType() == SUCCESS) {
            sink.success(message.getData());
        }
        else {
            sink.error(message.getCause());
        }
    } else if (fluxSinkMap.containsKey(message.getStreamId())) {
        FluxSink sink = fluxSinkMap.get(message.getStreamId());
        if (message.getType() == NEXT) {
            sink.next(message.getData());
        }
        else if (message.getType() == COMPLETE) {
            fluxSinkMap.remove(message.getStreamId());
            sink.next(message.getData());
            sink.complete();
        }
        else {
            fluxSinkMap.remove(message.getStreamId());
            sink.error(message.getCause());
        }
    }
})
Run Code Online (Sandbox Code Playgroud)

上面的代码示例显示了我们如何路由传入的消息.

多路请求

最后一部分是消息多路复用.为此,我们将涵盖可能的发送者类impl:

class Sender {
    UnicastProcessor<> outgoing = ...
    UnicastPorcessor<> incoming = ...

    Map<String, MonoSink> monoSinksMap = ...;
    Map<String, FluxSink> fluxSinksMap = ...;

    public Sender () {
Run Code Online (Sandbox Code Playgroud)

//在这里创建websocket连接并放置前面提到的代码}

    Mono<R> sendForMono(T data) {
        //generate message with unique 
        return Mono.<R>create(sink -> {
            monoSinksMap.put(streamId, sink);
            outgoing.onNext(message); // send message to server only when subscribed to Mono
        });
    }

     Flux<R> sendForFlux(T data) {
         return Flux.<R>create(sink -> {
            fluxSinksMap.put(streamId, sink);
            outgoing.onNext(message); // send message to server only when subscribed to Flux
        });
     }
}
Run Code Online (Sandbox Code Playgroud)

自定义实现的总结

  1. 性交
  2. 没有实施背压支持,这可能是另一项挑战
  3. 轻松拍摄自己的脚

小贴士

  1. 请使用RSocket,不要自己发明协议,这很难!
  2. 要了解有关Pivotal人员的RSocket的更多信息,请访问https://www.youtube.com/watch?v=WVnAbv65uCU
  3. 要从我的一个演讲中了解有关RSocket的更多信息,请访问https://www.youtube.com/watch?v=XKMyj6arY2A
  4. 在RSocket之上构建了一个名为Proteus的特色框架 - 您可能对此感兴趣 - https://www.netifi.com/
  5. 要了解有关RSocket协议核心开发人员的Proteus的更多信息,请访问https://www.google.com/url?sa=t&source=web&rct=j&url=https://m.youtube.com/watch%3Fv%3D_rqQtkIeNIQ&ved=2ahUKEwjpyLTpsLzfAhXDDiwKHUUUA8gQt9IBMAR6BAgNEB8&usg= AOvVaw0B_VdOj42gjr0YrzLLUX1E

  • @RüdigerSchulzSTOMP的最新更新(截至规范)是7年前...没那么好。另一方面,Java客户端/服务器的维护也已过时。我建议看一下RSocket。目前,Spring团队正在完成RSocket和Spring-Messaging集成的定稿工作,因此将在几个月后公开发布。有关更多信息-&gt; https://github.com/spring-projects/spring-framework/tree/master/spring-messaging/src/main/java/org/springframework/messaging/rsocket (2认同)