跳到主要内容

WebSocketRoute

每当使用 Page.routeWebSocket() 或 BrowserContext.routeWebSocket() 设置 WebSocket 路由时，WebSocketRoute 对象就允许像实际服务器那样处理 WebSocket。

模拟

默认情况下，路由的 WebSocket 不会连接到服务器。这样，您可以模拟整个 WebSocket 通信。这是一个响应 "request" 并发送 "response" 的示例。

page.routeWebSocket("wss://example.com/ws", ws -> {
  ws.onMessage(frame -> {
    if ("request".equals(frame.text()))
      ws.send("response");
  });
});

由于我们在 WebSocket 路由处理程序内部没有调用 WebSocketRoute.connectToServer()，Playwright 假定 WebSocket 将被模拟，并自动在页面内部打开 WebSocket。

这是另一个处理 JSON 消息的示例

page.routeWebSocket("wss://example.com/ws", ws -> {
  ws.onMessage(frame -> {
    JsonObject json = new JsonParser().parse(frame.text()).getAsJsonObject();
    if ("question".equals(json.get("request").getAsString())) {
      Map<String, String> result = new HashMap();
      result.put("response", "answer");
      ws.send(gson.toJson(result));
    }
  });
});

拦截

或者，您可能想要连接到实际服务器，但在消息之间进行拦截并修改或阻止它们。调用 WebSocketRoute.connectToServer() 返回一个服务器端 WebSocketRoute 实例，您可以使用它发送消息或处理传入消息。

下面是一个修改页面发送到服务器的一些消息的示例。从服务器发送到页面的消息保持不变，依赖于默认转发。

page.routeWebSocket("/ws", ws -> {
  WebSocketRoute server = ws.connectToServer();
  ws.onMessage(frame -> {
    if ("request".equals(frame.text()))
      server.send("request2");
    else
      server.send(frame.text());
  });
});

连接到服务器后，默认情况下会在页面和服务器之间自动转发所有消息。

然而，如果您在原始路由上调用 WebSocketRoute.onMessage()，从页面到服务器的消息将不再被转发，而应该由 处理程序 处理。

同样，在服务器端 WebSocket 上调用 WebSocketRoute.onMessage() 将停止转发从服务器到页面的消息，并由 处理程序 处理它们。

以下示例阻止了两个方向的一些消息。由于它在两个方向都调用了 WebSocketRoute.onMessage()，因此根本没有自动转发。

page.routeWebSocket("/ws", ws -> {
  WebSocketRoute server = ws.connectToServer();
  ws.onMessage(frame -> {
    if (!"blocked-from-the-page".equals(frame.text()))
      server.send(frame.text());
  });
  server.onMessage(frame -> {
    if (!"blocked-from-the-server".equals(frame.text()))
      ws.send(frame.text());
  });
});

方法​

close​

新增于：v1.48 webSocketRoute.close

关闭 WebSocket 连接的一端。

用法

WebSocketRoute.close();
WebSocketRoute.close(options);

参数

返回值

connectToServer​

新增于：v1.48 webSocketRoute.connectToServer

默认情况下，路由的 WebSocket 不会连接到服务器，因此您可以模拟整个 WebSocket 通信。此方法连接到实际的 WebSocket 服务器，并返回服务器端 WebSocketRoute 实例，使您能够从服务器发送和接收消息。

连接到服务器后

详见顶部的示例。

用法

WebSocketRoute.connectToServer();

返回值

onClose​

新增于：v1.48 webSocketRoute.onClose

允许处理 WebSocket.close。

默认情况下，关闭连接的一端（无论在页面还是服务器上）都会关闭另一端。然而，当设置了 WebSocketRoute.onClose() 处理程序时，默认的关闭转发将被禁用，并且应由处理程序负责处理。

用法

WebSocketRoute.onClose(handler);

参数

onMessage​

新增于：v1.48 webSocketRoute.onMessage

此方法允许处理由 WebSocket 发送的消息，无论这些消息是来自页面还是来自服务器。

当在原始 WebSocket 路由上调用时，此方法处理从页面发送的消息。您可以通过使用 WebSocketRoute.send() 响应它们，将它们转发到 WebSocketRoute.connectToServer() 返回的服务器端连接，或执行其他操作来处理这些消息。

调用此方法后，消息不会自动转发到服务器或页面 - 您应该通过调用 WebSocketRoute.send() 手动完成。详见顶部的示例。

再次调用此方法将用新的处理程序覆盖原有的处理程序。

用法

WebSocketRoute.onMessage(handler);

参数

send​

新增于：v1.48 webSocketRoute.send

向 WebSocket 发送消息。当在原始 WebSocket 上调用时，将消息发送到页面。当在 WebSocketRoute.connectToServer() 的结果上调用时，将消息发送到服务器。详见顶部的示例。

用法

WebSocketRoute.send(message);

参数

url​

新增于：v1.48 webSocketRoute.url

页面中创建的 WebSocket 的 URL。

用法

WebSocketRoute.url();

返回值