跳至主要内容

WebSocketRoute

每当通过page.route_web_socket()或browser_context.route_web_socket()设置WebSocket路由时，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()，从页面到服务器的消息将不再被转发，而应该由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)

方法​

关闭​

Added in: v1.48 webSocketRoute.close

关闭WebSocket连接的一端。

用法

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

参数

返回

on_close​

Added in: v1.48 webSocketRoute.on_close

允许处理 WebSocket.close。

默认情况下，在页面或服务器端关闭连接的任何一端都会导致另一端也被关闭。然而，当设置了web_socket_route.on_close()处理程序时，默认的关闭转发功能将被禁用，此时应由处理程序来负责处理关闭操作。

用法

web_socket_route.on_close(handler)

参数

on_message​

Added in: 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)

参数

发送​

Added in: v1.48 webSocketRoute.send

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

用法

web_socket_route.send(message)

参数

属性​

连接到服务器​

Added in: v1.48 webSocketRoute.connect_to_server

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

连接到服务器后：

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

用法

web_socket_route.connect_to_server

返回

网址​

Added in: v1.48 webSocketRoute.url

页面中创建的WebSocket的URL。

用法

web_socket_route.url

返回