跳至主要内容

WebSocketRoute

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

模拟

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

await page.RouteWebSocketAsync("wss://example.com/ws", ws => {
  ws.OnMessage(message => {
    if (message == "request")
      ws.Send("response");
  });
});

由于我们在 WebSocket 路由处理程序中没有调用 WebSocketRoute.ConnectToServer，因此 Playwright 假设 WebSocket 将被模拟，并在页面内部自动打开 WebSocket。

以下另一个处理 JSON 消息的示例

await page.RouteWebSocketAsync("wss://example.com/ws", ws => {
  ws.OnMessage(message => {
    using var jsonDoc = JsonDocument.Parse(message);
    JsonElement root = jsonDoc.RootElement;
    if (root.TryGetProperty("request", out JsonElement requestElement) && requestElement.GetString() == "question")
    {
      var response = new Dictionary<string, string> { ["response"] = "answer" };
      string jsonResponse = JsonSerializer.Serialize(response);
      ws.Send(jsonResponse);
    }
  });
});

拦截

或者，您可能希望连接到实际的服务器，但在两者之间拦截消息并修改或阻止它们。调用 WebSocketRoute.ConnectToServer 会返回一个服务器端 WebSocketRoute 实例，您可以向其发送消息或处理传入的消息。

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

await page.RouteWebSocketAsync("/ws", ws => {
  var server = ws.ConnectToServer();
  ws.OnMessage(message => {
    if (message == "request")
      server.Send("request2");
    else
      server.Send(message);
  });
});

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

但是，如果您在原始路由上调用 WebSocketRoute.OnMessage()，则页面发送到服务器的消息 **将不再转发**，而应由 处理程序 处理。

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

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

await page.RouteWebSocketAsync("/ws", ws => {
  var server = ws.ConnectToServer();
  ws.OnMessage(message => {
    if (message != "blocked-from-the-page")
      server.Send(message);
  });
  server.OnMessage(message => {
    if (message != "blocked-from-the-server")
      ws.Send(message);
  });
});

方法​

CloseAsync​

新增于：v1.48 webSocketRoute.CloseAsync

关闭 WebSocket 连接的一侧。

用法

await WebSocketRoute.CloseAsync(options);

参数

返回值

ConnectToServer​

新增于：v1.48 webSocketRoute.ConnectToServer

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

连接到服务器后

有关更多详细信息，请参阅顶部的示例。

用法

WebSocketRoute.ConnectToServer

返回值

OnClose​

新增于：v1.48 webSocketRoute.OnClose

允许处理 WebSocket.close。

默认情况下，在页面或服务器中关闭连接的一侧将关闭另一侧。但是，当设置 WebSocketRoute.OnClose() 处理程序时，关闭的默认转发将被禁用，处理程序应负责处理它。

用法

WebSocketRoute.OnClose(handler);

参数

  • handler Action<int?, string>#

    将处理 WebSocket 关闭的函数。接收一个可选的 关闭代码 和一个可选的 关闭原因。

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

返回值