執行 JavaScript

簡介

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

Page.EvaluateAsync() API 可以在網頁的上下文中執行 JavaScript 函式，並將結果帶回 Playwright 環境。像 window 和 document 這樣的瀏覽器全域物件可以在 evaluate 中使用。

var href = await page.EvaluateAsync<string>("document.location.href");

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

int status = await page.EvaluateAsync<int>(@"async () => {
  const response = await fetch(location.href);
  return response.status;
}");

不同的環境

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

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

var data = "some data";
var result = await page.EvaluateAsync(@"() => {
  // WRONG: there is no 'data' in the web page.
  window.myApp.use(data);
}");

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

var data = "some data";
// Pass |data| as a parameter.
var result = await page.EvaluateAsync("data => { window.myApp.use(data); }", data);

評估參數

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

// A primitive value.
await page.EvaluateAsync<int>("num => num", 42);

// An array.
await page.EvaluateAsync<int[]>("array => array.length", new[] { 1, 2, 3 });

// An object.
await page.EvaluateAsync<object>("object => object.foo", new { foo = "bar" });

// A single handle.
var button = await page.EvaluateHandleAsync("window.button");
await page.EvaluateAsync<IJSHandle>("button => button.textContent", button);

// Alternative notation using JSHandle.EvaluateAsync.
await button.EvaluateAsync<string>("(button, from) => button.textContent.substring(from)", 5);

// Object with multiple handles.
var button1 = await page.EvaluateHandleAsync("window.button1");
var button2 = await page.EvaluateHandleAsync("window.button2");
await page.EvaluateAsync("o => o.button1.textContent + o.button2.textContent", new { button1, button2 });

// Object destructuring works. Note that property names must match
// between the destructured object and the argument.
// Also note the required parenthesis.
await page.EvaluateAsync("({ button1, button2 }) => button1.textContent + button2.textContent", new { button1, button2 });

// Array works as well. Arbitrary names can be used for destructuring.
// Note the required parenthesis.
await page.EvaluateAsync("([b1, b2]) => b1.textContent + b2.textContent", new[] { button1, button2 });

// Any mix of serializables and handles works.
await page.EvaluateAsync("x => x.button1.textContent + x.list[0].textContent + String(x.foo)", new { button1, list = new[] { button2 }, foo = null as object });

初始化腳本

有時在頁面開始載入之前評估一些內容是很方便的。例如，你可能想要設定一些模擬或測試資料。

在此情況下，使用 Page.AddInitScriptAsync() 或 BrowserContext.AddInitScriptAsync()。在下面的範例中，我們將用一個常數值取代 Math.random()。

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

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

接下來，將初始化腳本添加到頁面。

// In your test, assuming the "preload.js" file is in the "mocks" directory.
await Page.AddInitScriptAsync(scriptPath: "mocks/preload.js");