跳到主要内容

WebSocketRoute

每当使用 WebSocket route 通过 Page.routeWebSocket() 或 BrowserContext.routeWebSocket() 设置时，WebSocketRoute 对象允许像实际服务器一样处理 WebSocket。

模拟

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

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()，则来自页面的消息将不再转发到服务器，而应由 handler 处理。

类似地，在服务器端 WebSocket 上调用 WebSocketRoute.onMessage() 将停止转发从服务器到页面的消息，并且 handler 应该处理它们。

以下示例阻止了两个方向上的一些消息。 由于它在两个方向上都调用了 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();

返回值