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)
))

非同步

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

await 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)
))

非同步

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" }))

await 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)

非同步

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))

await 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)

非同步

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))

await page.route_web_socket("/ws", handler)

---

方法

close

新增於：v1.48 webSocketRoute.close

關閉 WebSocket 連線的其中一端。

用法

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

引數

• code int (選用)#

  選用的 關閉代碼。

• reason str (選用)#

  選用的 關閉原因。

傳回

• NoneType#

---

on_close

新增於：v1.48 webSocketRoute.on_close

允許處理 WebSocket.close。

預設情況下，關閉連線的其中一端（無論是在頁面中還是在伺服器上）都會關閉另一端。但是，當設定 web_socket_route.on_close() 處理常式時，關閉的預設轉發會停用，而處理常式應負責處理它。

用法

web_socket_route.on_close(handler)

引數

• handler Callable[int | [undefined]]:Promise[Any] | Any#

  將處理 WebSocket 關閉的函式。接收選用的 關閉代碼 和選用的 關閉原因。

---

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)

引數

• handler Callable[str]:Promise[Any] | Any#

  將處理訊息的函式。

---

send

新增於：v1.48 webSocketRoute.send

將訊息傳送到 WebSocket。當在原始 WebSocket 上呼叫時，將訊息傳送到頁面。當在 web_socket_route.connect_to_server 的結果上呼叫時，將訊息傳送到伺服器。請參閱頂部的範例以取得更多詳細資訊。

用法

web_socket_route.send(message)

引數

• message str | bytes#

  要傳送的訊息。

---

屬性

connect_to_server

新增於：v1.48 webSocketRoute.connect_to_server

預設情況下，路由的 WebSocket 不會連線到伺服器，因此您可以模擬整個 WebSocket 通訊。此方法連線到實際的 WebSocket 伺服器，並傳回伺服器端的 WebSocketRoute 實例，讓您能夠傳送和接收來自伺服器的訊息。

連線到伺服器後

• 從伺服器接收的訊息將自動轉發到頁面中的 WebSocket，除非在伺服器端 WebSocketRoute 上呼叫 web_socket_route.on_message()。
• 由頁面中的 WebSocket.send() 呼叫傳送的訊息將自動轉發到伺服器，除非在原始 WebSocketRoute 上呼叫 web_socket_route.on_message()。

請參閱頂部的範例以取得更多詳細資訊。

用法

web_socket_route.connect_to_server

傳回

• WebSocketRoute#

---

url

新增於：v1.48 webSocketRoute.url

在頁面中建立的 WebSocket 的 URL。

用法

web_socket_route.url

傳回

• str#