跳转到主要内容

WebSocketRoute

当使用 page.route_web_socket() 或 browser_context.route_web_socket() 设置了 WebSocket 路由时，WebSocketRoute 对象允许像真实的服务器那样处理 WebSocket。

模拟

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

def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
  if message == "request":
    ws.send("response")

page.route_web_socket("wss://example.com/ws", lambda ws: ws.on_message(
    lambda message: message_handler(ws, message)
))

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

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

def message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
  json_message = json.loads(message)
  if json_message["request"] == "question":
    ws.send(json.dumps({ "response": "answer" }))

page.route_web_socket("wss://example.com/ws", lambda ws: ws.on_message(
    lambda message: message_handler(ws, message)
))

拦截

或者，你可能希望连接到真实的服务器，但在中间拦截消息并对其进行修改或阻止。调用 web_socket_route.connect_to_server 会返回一个服务端的 WebSocketRoute 实例，你可以向其发送消息或处理接收到的消息。

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

def message_handler(server: WebSocketRoute, message: Union[str, bytes]):
  if message == "request":
    server.send("request2")
  else:
    server.send(message)

def handler(ws: WebSocketRoute):
  server = ws.connect_to_server()
  ws.on_message(lambda message: message_handler(server, message))

page.route_web_socket("/ws", handler)

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

但是，如果你在原始路由上调用 web_socket_route.on_message()，从页面发送到服务器的消息将不再被转发，而是应该由 handler 进行处理。

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

以下示例在两个方向上都阻止了一些消息。由于它在两个方向上都调用了 web_socket_route.on_message()，因此完全没有自动转发。

def ws_message_handler(server: WebSocketRoute, message: Union[str, bytes]):
  if message != "blocked-from-the-page":
    server.send(message)

def server_message_handler(ws: WebSocketRoute, message: Union[str, bytes]):
  if message != "blocked-from-the-server":
    ws.send(message)

def handler(ws: WebSocketRoute):
  server = ws.connect_to_server()
  ws.on_message(lambda message: ws_message_handler(server, message))
  server.on_message(lambda message: server_message_handler(ws, message))

page.route_web_socket("/ws", handler)

方法​

关闭​

新增于: v1.48 webSocketRoute.close

关闭 WebSocket 连接的一端。

用法

web_socket_route.close()
web_socket_route.close(**kwargs)

参数

返回

on_close​

新增于: v1.48 webSocketRoute.on_close

允许处理 WebSocket.close。

默认情况下，关闭连接的一侧（无论是页面侧还是服务器侧）都会关闭另一侧。但是，当设置了 web_socket_route.on_close() 处理程序时，默认的关闭转发将被禁用，处理程序应负责处理它。

用法

web_socket_route.on_close(handler)

参数

on_message​

新增于: v1.48 webSocketRoute.on_message

此方法允许处理由 WebSocket 发送的消息，无论是从页面还是从服务器。

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

一旦调用了此方法，消息将不再自动转发到服务器或页面 —— 你应该通过调用 web_socket_route.send() 手动完成。有关更多详细信息，请参阅顶部的示例。

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

用法

web_socket_route.on_message(handler)

参数

send​

新增于: v1.48 webSocketRoute.send

向 WebSocket 发送消息。当在原始 WebSocket 上调用时，向页面发送消息。当在 web_socket_route.connect_to_server 的结果上调用时，向服务器发送消息。有关更多详细信息，请参阅顶部的示例。

用法

web_socket_route.send(message)

参数

属性​

connect_to_server​

新增于: v1.48 webSocketRoute.connect_to_server

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

连接到服务器后

有关更多详细信息，请参见顶部的示例。

用法

web_socket_route.connect_to_server

返回

protocols​

添加于: v1.60 webSocketRoute.protocols

页面请求的 WebSocket 子协议列表，通过 WebSocket 构造函数 的第二个参数传递。对应于 Sec-WebSocket-Protocol 请求头。

如果没有指定协议，则返回一个空数组。

用法

def handler(ws: WebSocketRoute):
  if "chat.v2" in ws.protocols:
    ws.on_message(lambda message: ws.send(f"v2:{message}"))
  else:
    ws.close(code=1002, reason="Unsupported protocol")

page.route_web_socket("wss://example.com/ws", handler)

返回

url​

新增于: v1.48 webSocketRoute.url

在页面中创建的 WebSocket 的 URL。

用法

web_socket_route.url

返回