跳至主要内容

WebSocketRoute

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

模拟

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

await page.routeWebSocket('wss://example.com/ws', ws => {
  ws.onMessage(message => {
    if (message === 'request')
      ws.send('response');
  });
});

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

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

await page.routeWebSocket('wss://example.com/ws', ws => {
  ws.onMessage(message => {
    const json = JSON.parse(message);
    if (json.request === 'question')
      ws.send(JSON.stringify({ response: 'answer' }));
  });
});

拦截

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

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

await page.routeWebSocket('/ws', ws => {
  const 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.routeWebSocket('/ws', ws => {
  const 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);
  });
});

方法​

close​

在以下版本中添加：v1.48 webSocketRoute.close

关闭 WebSocket 连接的一侧。

用法

await webSocketRoute.close();
await 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();

返回值