Skip to main content

執行 JavaScript 求值

簡介​

Playwright 腳本在您的 Playwright 環境中執行。您的頁面腳本在瀏覽器頁面環境中執行。這些環境不會相交，它們在不同的虛擬機器、不同的程序中執行，甚至可能在不同的電腦上執行。

Page.evaluate() API 可以在網頁的情境中執行 JavaScript 函式，並將結果帶回到 Playwright 環境。瀏覽器全域變數如 window 和 document 可以在 evaluate 中使用。

String href = (String) page.evaluate("document.location.href");

如果結果是一個 Promise 或函式是非同步的，evaluate 會自動等待直到它被解析：

int status = (int) page.evaluate("async () => {\n" +
  "  const response = await fetch(location.href);\n" +
  "  return response.status;\n" +
  "}");

不同環境​

執行求值的腳本在瀏覽器環境中執行，而您的測試在測試環境中執行。這意味著您無法在頁面中使用測試中的變數，反之亦然。相反地，您應該明確地將它們作為參數傳遞。

以下程式碼片段是錯誤的，因為它直接使用變數：

String data = "some data";
Object result = page.evaluate("() => {\n" +
  "  // 錯誤：在網頁中沒有 'data'\n" +
  "  window.myApp.use(data);\n" +
  "}");

以下程式碼片段是正確的，因為它明確地將值作為參數傳遞：

String data = "some data";
// 將 |data| 作為參數傳遞
Object result = page.evaluate("data => {\n" +
  "  window.myApp.use(data);\n" +
  "}", data);

求值參數​

Playwright 求值方法如 Page.evaluate() 接受一個可選參數。此參數可以是 Serializable 值和 JSHandle 實例的混合。控制代碼會自動轉換為它們所代表的值。

// 基本型別值
page.evaluate("num => num", 42);

// 陣列
page.evaluate("array => array.length", Arrays.asList(1, 2, 3));

// 物件
Map<String, Object> obj = new HashMap<>();
obj.put("foo", "bar");
page.evaluate("object => object.foo", obj);

// 單一控制代碼
ElementHandle button = page.evaluateHandle("window.button");
page.evaluate("button => button.textContent", button);

// 使用 JSHandle.evaluate 的替代寫法
button.evaluate("(button, from) => button.textContent.substring(from)", 5);

// 具有多個控制代碼的物件
ElementHandle button1 = page.evaluateHandle("window.button1");
ElementHandle button2 = page.evaluateHandle("window.button2");
Map<String, ElementHandle> arg = new HashMap<>();
arg.put("button1", button1);
arg.put("button2", button2);
page.evaluate("o => o.button1.textContent + o.button2.textContent", arg);

// 物件解構也可以運作。注意屬性名稱必須在
// 解構物件和參數之間相符
// 同時注意必須的括號
Map<String, ElementHandle> arg = new HashMap<>();
arg.put("button1", button1);
arg.put("button2", button2);
page.evaluate("({ button1, button2 }) => button1.textContent + button2.textContent", arg);

// 陣列也可以運作。可以使用任意名稱進行解構
// 注意必須的括號
page.evaluate(
  "([b1, b2]) => b1.textContent + b2.textContent",
  Arrays.asList(button1, button2));

// 可序列化值和控制代碼的任何組合都可以運作
Map<String, Object> arg = new HashMap<>();
arg.put("button1", button1);
arg.put("list", Arrays.asList(button2));
arg.put("foo", 0);
page.evaluate(
  "x => x.button1.textContent + x.list[0].textContent + String(x.foo)",
  arg);

初始化腳本​

有時在頁面開始載入之前在頁面中求值某些內容很方便。例如，您可能想要設定一些模擬或測試資料。

在這種情況下，使用 Page.addInitScript() 或 BrowserContext.addInitScript()。在下面的範例中，我們將用常數值替換 Math.random()。

首先，建立一個包含模擬的 preload.js 檔案。

// preload.js
Math.random = () => 42;

接下來，將初始化腳本新增到頁面。

// 在您的測試中，假設 "preload.js" 檔案在 "mocks" 目錄中
page.addInitScript(Paths.get("mocks/preload.js"));