WebSocketRoute

每当通过Page.routeWebSocket()或BrowserContext.routeWebSocket()设置WebSocket路由时，WebSocketRoute对象允许像真实服务器一样处理WebSocket连接。

模拟

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

page.routeWebSocket("wss://example.com/ws", ws -> {
  ws.onMessage(frame -> {
    if ("request".equals(frame.text()))
      ws.send("response");
  });
});

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

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

page.routeWebSocket("wss://example.com/ws", ws -> {
  ws.onMessage(frame -> {
    JsonObject json = new JsonParser().parse(frame.text()).getAsJsonObject();
    if ("question".equals(json.get("request").getAsString())) {
      Map<String, String> result = new HashMap();
      result.put("response", "answer");
      ws.send(gson.toJson(result));
    }
  });
});

拦截

或者，您可能希望连接到实际服务器，但在通信过程中拦截消息并修改或阻止它们。调用WebSocketRoute.connectToServer()会返回一个服务器端的WebSocketRoute实例，您可以通过该实例发送消息或处理传入消息。

以下是一个修改页面发送到服务器的部分消息的示例。从服务器发送到页面的消息保持不变，依赖于默认转发。

page.routeWebSocket("/ws", ws -> {
  WebSocketRoute server = ws.connectToServer();
  ws.onMessage(frame -> {
    if ("request".equals(frame.text()))
      server.send("request2");
    else
      server.send(frame.text());
  });
});

连接到服务器后，默认情况下所有消息都会在页面和服务器之间转发。

然而，如果您在原始路由上调用WebSocketRoute.onMessage()，从页面发送到服务器的消息将不再被转发，而应该由handler处理。

类似地，在服务器端WebSocket上调用WebSocketRoute.onMessage()将会停止转发消息从服务器到页面，此时handler应该负责处理这些消息。

以下示例在两个方向上都会拦截部分消息。由于它在两个方向上都调用了WebSocketRoute.onMessage()，因此完全不会自动转发。

page.routeWebSocket("/ws", ws -> {
  WebSocketRoute server = ws.connectToServer();
  ws.onMessage(frame -> {
    if (!"blocked-from-the-page".equals(frame.text()))
      server.send(frame.text());
  });
  server.onMessage(frame -> {
    if (!"blocked-from-the-server".equals(frame.text()))
      ws.send(frame.text());
  });
});

方法​

关闭​

关闭WebSocket连接的一端。

用法

WebSocketRoute.close();
WebSocketRoute.close(options);

参数

• options WebSocketRoute.CloseOptions (optional)

  • setCode int (可选)#

    可选的 close code。

  • setReason String (可选)#

    可选的关闭原因。

返回

• void#

connectToServer​

默认情况下，路由式WebSocket不会连接到服务器，因此您可以模拟整个WebSocket通信。此方法会连接到实际的WebSocket服务器，并返回服务器端的WebSocketRoute实例，从而具备从服务器发送和接收消息的能力。

连接到服务器后：

• 从服务器接收到的消息将自动转发到页面中的WebSocket，除非在服务器端WebSocketRoute上调用了WebSocketRoute.onMessage()。
• 页面中通过WebSocket.send()调用发送的消息将被自动转发到服务器，除非在原始的WebSocketRoute上调用了WebSocketRoute.onMessage()。

更多详情请参见顶部的示例。

用法

WebSocketRoute.connectToServer();

返回

• WebSocketRoute#

onClose​

允许处理 WebSocket.close。

默认情况下，在页面或服务器上关闭连接的一端将同时关闭另一端。然而，当设置了WebSocketRoute.onClose()处理程序时，默认的关闭转发功能将被禁用，此时应由处理程序负责处理关闭操作。

用法

WebSocketRoute.onClose(handler);

参数

• handler Consumer<null | int>#

  处理WebSocket关闭的函数。接收一个可选的关闭代码和一个可选的关闭原因。

onMessage​

该方法允许处理通过WebSocket发送的消息，无论是来自页面还是服务器。

当在原始的WebSocket路由上调用时，此方法处理从页面发送的消息。您可以通过使用WebSocketRoute.send()响应这些消息、将它们转发到由WebSocketRoute.connectToServer()返回的服务器端连接或执行其他操作来处理这些消息。

一旦调用此方法，消息将不会自动转发到服务器或页面 - 您应通过调用WebSocketRoute.send()手动完成此操作。更多详情请参见顶部的示例。

再次调用此方法将用新的处理程序覆盖原有处理程序。

用法

WebSocketRoute.onMessage(handler);

参数

• handler Consumer<WebSocketFrame>#

  用于处理消息的函数。

发送​

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

用法

WebSocketRoute.send(message);

参数

• message String | byte[]#

  要发送的消息。

网址​

页面中创建的WebSocket的URL。

用法

WebSocketRoute.url();

返回

• String#