跳到主要内容

WebSocketRoute

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

模拟

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

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

同样，在服务器端 WebSocket 上调用 WebSocketRoute.OnMessage() 将 停止从服务器到页面的消息转发，并且 处理程序 应处理这些消息。

以下示例阻止双向的某些消息。由于它在双向都调用了 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

返回值