跳到主要內容

WebSocketRoute

每當使用 Page.routeWebSocket() 或 BrowserContext.routeWebSocket() 設定 WebSocket 路徑時，WebSocketRoute 物件允許處理 WebSocket，就像實際的伺服器一樣。

模擬

預設情況下，路由的 WebSocket 不會連線到伺服器。這樣一來，您可以模擬透過 WebSocket 的整個通訊。以下範例回應 "request" 並傳回 "response"。

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()，則從頁面傳送至伺服器的訊息將不再轉發，而應由 處理常式 處理。

同樣地，在伺服器端 WebSocket 上呼叫 WebSocketRoute.onMessage() 將停止轉發從伺服器到頁面的訊息，並且 處理常式 應負責處理它們。

以下範例封鎖雙向的一些訊息。由於它在兩個方向都呼叫了 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());
  });
});

方法​

close​

新增於：v1.48 webSocketRoute.close

關閉 WebSocket 連線的一端。

用法

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

引數

傳回

connectToServer​

新增於：v1.48 webSocketRoute.connectToServer

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

連線到伺服器後

如需更多詳細資訊，請參閱頂端的範例。

用法

WebSocketRoute.connectToServer();

傳回

onClose​

新增於：v1.48 webSocketRoute.onClose

允許處理 WebSocket.close。

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

用法

WebSocketRoute.onClose(handler);

引數

onMessage​

新增於：v1.48 webSocketRoute.onMessage

此方法允許處理由 WebSocket 傳送的訊息，無論是從頁面還是從伺服器傳送。

在原始 WebSocket 路徑上呼叫時，此方法會處理從頁面傳送的訊息。您可以透過使用 WebSocketRoute.send() 回應這些訊息、將它們轉發到 WebSocketRoute.connectToServer() 傳回的伺服器端連線，或執行其他操作來處理這些訊息。

一旦呼叫此方法，訊息將不會自動轉發到伺服器或頁面 - 您應透過呼叫 WebSocketRoute.send() 手動執行此操作。如需更多詳細資訊，請參閱頂端的範例。

再次呼叫此方法將使用新的處理常式覆寫該處理常式。

用法

WebSocketRoute.onMessage(handler);

引數

send​

新增於：v1.48 webSocketRoute.send

將訊息傳送到 WebSocket。在原始 WebSocket 上呼叫時，將訊息傳送到頁面。在 WebSocketRoute.connectToServer() 的結果上呼叫時，將訊息傳送到伺服器。如需更多詳細資訊，請參閱頂端的範例。

用法

WebSocketRoute.send(message);

引數

url​

新增於：v1.48 webSocketRoute.url

在頁面中建立的 WebSocket 的 URL。

用法

WebSocketRoute.url();

傳回