跳到主要内容

WebSocketRoute

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

模拟

默认情况下，路由的 WebSocket 不会连接到服务器。通过这种方式，您可以模拟 WebSocket 上的整个通信。这是一个响应 "request" 并返回 "response" 的示例。

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

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

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

await page.RouteWebSocketAsync("wss://example.com/ws", ws => {
  ws.OnMessage(frame => {
    using var jsonDoc = JsonDocument.Parse(frame.Text);
    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(frame => {
    if (frame.Text == "request")
      server.Send("request2");
    else
      server.Send(frame.Text);
  });
});

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

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

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

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

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

方法​

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

返回值