跳至主要内容

评估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实例的混合。句柄会自动转换为它们所代表的值。

// 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");