Vert.x的Event bus bridge对WebSocket的处理细节

原创已于 2023-04-12 11:18:15 修改 · 689 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#websocket #java #服务器

于 2023-03-04 10:28:40 首次发布

Vert.x编程指南专栏收录该内容

17 篇文章

订阅专栏

本文详细介绍了Vert.x的Eventbusbridge如何处理WebSocket连接，特别是对文本格式和JSON格式的消息传递进行了深入解析。连接URL的不同决定了消息类型，纯文本格式需包含特定路径，而JSON格式则不包含特定部分。当WebSocket连接关闭或异常时，系统会自动清理已注册的Event地址。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Vert.x的Event bus bridge只支持文本格式的协议不支持二进制协议! 同时支持WebSocket的纯文本字符串和JSON格式字符串的消息传递.

参见io.vertx.ext.web.handler.sockjs.impl.SockJSImpl 类的 public Router socketHandler(Handler<SockJSSocket> sockHandler) 方法里

    if (enabledTransports.contains(Transport.WEBSOCKET.toString())) {
      new WebSocketTransport(vertx, router, sessions, options, sockHandler);
      new RawWebSocketTransport(vertx, router, options, sockHandler);
    }

纯文本格式和 JSON格式的消息类型识别

纯文本格式

url里包含了/${server}/${sessionId}路径的让 io.vertx.ext.web.handler.sockjs.impl.WebSocketTransport类来处理纯文本消息

JSON格式

url里不包含/${server}/${sessionId}路径的让 io.vertx.ext.web.handler.sockjs.impl.RawWebSocketTransport类来处理JSON消息

收发JSON格式:

连接的url里不能包含server 和 sessionId ,例如:

/eventbus/websocket

在接收消息的时候整个消息体就是个JSON对象字符串

收发纯文本格式:

连接的url里必需包含server 和 sessionId ,例如:

/eventbus/${server}/${sessionId}/websocket

server (字符串): 要附加到实际数据连接的 url 的字符串。默认为随机的 4 位数字。

sessionId (数字): 客户端和服务器都使用会话标识符来区分连接。

具体细节参见SockJS文档

在接收消息的时候根据第1个字节来区分消息的类型(例如o代表是打开连接,a代表消息体是JSON数组).

如下图所示:
在这里插入图片描述

EventBusBridgeImpl类

io.vertx.ext.web.handler.sockjs.impl.EventBusBridgeImpl类是处理 SockJS 桥接 Event Bus的核心类

  private void handleSocketClosed(SockJSSocket sock, Map<String, MessageConsumer<?>> registrations) {
    clearSocketState(sock, registrations);
    checkCallHook(() -> new BridgeEventImpl(BridgeEventType.SOCKET_CLOSED, null, sock));
  }

当客户端WebSocket连接断开或者发生异常时clearSocketState方法会清理掉客户端注册的所有Event地址.

private void clearSocketState(SockJSSocket sock, Map<String, MessageConsumer<?>> registrations) {
    // On close or exception unregister any handlers that haven't been unregistered
    for (MessageConsumer<?> registration : registrations.values()) {
      registration.unregister();
      checkCallHook(() ->
        new BridgeEventImpl(
          BridgeEventType.UNREGISTER,
          new JsonObject().put("type", "unregister").put("address", registration.address()),
          sock));
    }
    // ensure that no timers remain active
    SockInfo info = sockInfos.remove(sock);
    if (info != null) {
      PingInfo pingInfo = info.pingInfo;
      if (pingInfo != null) {
        vertx.cancelTimer(pingInfo.timerID);
      }
    }
  }