跳到主要内容

WebSocketRoute

每当使用 page.routeWebSocket() 或 browserContext.routeWebSocket() 设置 WebSocket 路由时，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()，则从页面发送到服务器的消息将不再转发，而应由 handler 处理。

同样，在服务器端 WebSocket 上调用 webSocketRoute.onMessage() 将停止转发从服务器到页面的消息，并且 handler 应该处理它们。

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

返回值