WebSocketRoute
每当使用 Page.RouteWebSocketAsync() 或 BrowserContext.RouteWebSocketAsync() 设置 WebSocket
路由时,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(),则从页面到服务器的消息将不再转发,而应由 处理程序 处理。
同样,在服务器端 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关闭 WebSocket 连接的一端。
用法
await WebSocketRoute.CloseAsync(options);
参数
返回
ConnectToServer
新增于: v1.48默认情况下,路由的 WebSocket 不会连接到服务器,因此您可以模拟整个 WebSocket 通信。此方法连接到实际的 WebSocket 服务器,并返回服务器端 WebSocketRoute 实例,从而能够从服务器发送和接收消息。
连接到服务器后
- 从服务器接收到的消息将自动转发到页面中的 WebSocket,除非在服务器端
WebSocketRoute
上调用了 WebSocketRoute.OnMessage()。 - 页面中通过
WebSocket.send()
调用发送的消息将自动转发到服务器,除非在原始WebSocketRoute
上调用了 WebSocketRoute.OnMessage()。
有关更多详细信息,请参见顶部的示例。
用法
WebSocketRoute.ConnectToServer
返回
OnClose
新增于: v1.48允许处理 WebSocket.close
。
默认情况下,关闭连接的任意一端(无论是在页面中还是在服务器上)都会关闭另一端。但是,当设置了 WebSocketRoute.OnClose() 处理程序时,默认的关闭转发将被禁用,处理程序应负责处理它。
用法
WebSocketRoute.OnClose(handler);
参数
OnMessage
新增于: v1.48此方法允许处理由 WebSocket 发送的消息,无论是从页面还是从服务器。
当在原始 WebSocket 路由上调用时,此方法处理从页面发送的消息。您可以通过使用 WebSocketRoute.Send() 响应这些消息,将它们转发到 WebSocketRoute.ConnectToServer 返回的服务器端连接,或执行其他操作来处理这些消息。
一旦调用此方法,消息将不会自动转发到服务器或页面 - 您应该通过调用 WebSocketRoute.Send() 手动完成。有关更多详细信息,请参阅顶部的示例。
再次调用此方法将用新的处理程序覆盖现有的处理程序。
用法
WebSocketRoute.OnMessage(handler);
参数
-
handler
Action<WebSocketFrame>#将处理消息的函数。
Send
新增于: v1.48向 WebSocket 发送消息。当在原始 WebSocket 上调用时,将消息发送到页面。当在 WebSocketRoute.ConnectToServer 的结果上调用时,将消息发送到服务器。有关更多详细信息,请参阅顶部的示例。
用法
WebSocketRoute.Send(message);
参数
Url
新增于: v1.48在页面中创建的 WebSocket 的 URL。
用法
WebSocketRoute.Url
返回