跳到主要内容

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.onMessage(handler);

参数

send​

Added in: v1.48 webSocketRoute.send

向 WebSocket 发送消息。当在原始 WebSocket 上调用时，会将消息发送到页面。当在 webSocketRoute.connectToServer() 的结果上调用时，会将消息发送到服务器。更多详情请参见顶部的示例。

用法

webSocketRoute.send(message);

参数

url​

Added in: v1.48 webSocketRoute.url

页面中创建的 WebSocket 的 URL。

用法

webSocketRoute.url();

返回值