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

时间:2018-12-17 09:43:03

标签: java spring spring-webflux spring-websocket project-reactor

TL; DR;

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

长版

我们正在启动一个项目,该项目将使用spring-webflux中的反应式Web套接字。我们需要建立一个反应式客户端库,供消费者使用以连接到服务器。

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

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

在客户端上,我们希望在有人调用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;
}

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

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

2)如何从session.receive中获得的服务器返回响应?

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

我们正在做一些研究,但是我们找不到在线的webflux-websocket-client文档/实现适当的资源。有关如何前进的任何指示。

2 个答案:

答案 0 :(得分:8)

请!使用RSocket

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

但是,不要实施转轮,而要使用可以为您提供所有此类通信的协议。

  • RSocket具有一个 request-response 模型,该模型使您可以进行当今最常见的客户端-服务器交互。
  • RSocket具有一个 request-stream 通信模型,因此您可以满足您的所有需求并异步重用同一连接来返回事件流。 RSocket可以将逻辑流映射到物理连接并进行映射,因此您自己不会感到痛苦。
  • RSocket具有更多的交互模型,例如 一劳永逸 stream-stream 在以下情况下可能很有用 通过两种方式发送数据流。

如何在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集成也提供了example的RSocket-RPC使用情况。

好的,它还没有说服我,我仍然想拥有一个自定义的WebSocket服务器

因此,为此,您必须自己实现该死。我以前已经做过一次,但是由于它是企业级项目,所以我无法指出该项目。 不过,我可以共享一些代码示例,这些示例可以帮助您构建合适的客户端和服务器。

服务器端

处理程序和开放逻辑订户映射

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

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<>();
    ...
  }
}

上面的示例中有两个地图。第一个是您的路由映射,它使您可以根据传入的消息参数等来识别路由。第二个是针对请求流用例创建的(在我的案例中是活动订阅的映射),因此您可以发送创建订阅的消息框架,或者订阅您的特定操作并保留该订阅,以便一旦取消订阅操作已执行,如果有订阅,您将被取消订阅。

使用处理器进行消息多路复用

为了从所有逻辑流发送回消息,您必须将消息多路复用到一个流。例如,使用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()
    );
}

从上面的示例中我们可以看到,那里有一堆东西:

  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();
}

将所有逻辑流保持在某个地方

所有创建的流,无论是Mono还是Flux都应存储在某个地方,以便我们能够区分与哪个流消息相关:

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

自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());
        }
    }
})

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

多路请求

最后一部分是消息多路复用。为此,我们将介绍可能的发件人类impl:

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

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

    public Sender () {

//在此处创建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
        });
     }
}

自定义实施总结

  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

答案 1 :(得分:2)

不确定这是您的问题吗? 我看到您正在发送静态磁通响应(这是一个可关闭的流) 您需要一个开放的流来向该会话发送消息,例如,您可以创建一个处理器

public class SocketMessageComponent {
private DirectProcessor<String> emitterProcessor;
private Flux<String> subscriber;

public SocketMessageComponent() {
    emitterProcessor = DirectProcessor.create();
    subscriber = emitterProcessor.share();
}

public Flux<String> getSubscriber() {
    return subscriber;
}

public void sendMessage(String mesage) {
    emitterProcessor.onNext(mesage);
}

}

然后您可以发送

 public Mono<Void> handle(WebSocketSession webSocketSession) {
    this.webSocketSession = webSocketSession;
    return webSocketSession.send(socketMessageComponent.getSubscriber()
            .map(webSocketSession::textMessage))
            .and(webSocketSession.receive()
                    .map(WebSocketMessage::getPayloadAsText).log());
}