跳至主要内容

WebSocketRoute

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

模拟

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

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()，则来自页面到服务器的消息将不再转发，而应由 处理程序 处理。

类似地，在服务器端 WebSocket 上调用 web_socket_route.on_message() 将停止转发来自服务器到页面的消息，并且 处理程序 应该处理它们。

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

方法​

close​

新增于：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

返回值

url​

新增于：v1.48 webSocketRoute.url

在页面中创建的 WebSocket 的 URL。

用法

web_socket_route.url

返回值