句柄

简介

Playwright 可以创建对页面 DOM 元素或页面内任何其他对象的句柄。这些句柄存在于 Playwright 进程中，而实际对象存在于浏览器中。句柄有两种类型：

JSHandle 用于引用页面中的任何 JavaScript 对象
ElementHandle 用于引用页面中的 DOM 元素，它有额外的方法，可用于对元素执行操作并断言其属性。

由于页面中的任何 DOM 元素也是一个 JavaScript 对象，因此任何 ElementHandle 也是一个 JSHandle。

句柄用于对页面中的实际对象执行操作。你可以在句柄上进行求值，获取句柄属性，将句柄作为求值参数传递，将页面对象序列化为 JSON 等。有关这些及其他方法，请参阅 JSHandle 类 API。

API 参考

以下是获取 JSHandle 的最简单方法。

JSHandle jsHandle = page.evaluateHandle("window");
// 使用 jsHandle 进行求值。

元素句柄

不推荐

不推荐使用 ElementHandle，请改用 Locator 对象和以网页为优先的断言。

当需要 ElementHandle 时，建议使用 Page.waitForSelector() 或 Frame.waitForSelector() 方法获取它。这些 API 会等待元素附加并可见。

// 获取元素句柄
JSHandle jsHandle = page.waitForSelector("#box");
ElementHandle elementHandle = jsHandle.asElement();

// 断言元素的边界框
BoundingBox boundingBox = elementHandle.boundingBox();
assertEquals(100, boundingBox.width);

// 断言元素的属性
String classNames = elementHandle.getAttribute("class");
assertTrue(classNames.contains("highlighted"));

句柄作为参数

句柄可以传递到 Page.evaluate() 及类似方法中。以下代码片段在页面中创建一个新数组，使用数据对其进行初始化，并将该数组的句柄返回给 Playwright。然后，它在后续的求值中使用该句柄：

// 在页面中创建新数组。
JSHandle myArrayHandle = page.evaluateHandle("() => {\n" +
  "  window.myArray = [1];\n" +
  "  return myArray;\n" +
  "}");

// 获取数组的长度。
int length = (int) page.evaluate("a => a.length", myArrayHandle);

// 使用句柄向数组中再添加一个元素
Map<String, Object> arg = new HashMap<>();
arg.put("myArray", myArrayHandle);
arg.put("newElement", 2);
page.evaluate("arg => arg.myArray.add(arg.newElement)", arg);

// 当不再需要该对象时释放它。
myArrayHandle.dispose();

句柄生命周期

可以使用页面方法获取句柄，例如 Page.evaluateHandle()、Page.querySelector() 或 Page.querySelectorAll()，或者它们对应的框架方法 Frame.evaluateHandle()、Frame.querySelector() 或 Frame.querySelectorAll()。句柄一旦创建，除非页面导航或通过 JSHandle.dispose() 方法手动释放，否则会阻止对象被垃圾回收。

API 参考

Locator 与 ElementHandle

警告

我们仅在极少数需要对静态页面执行大量 DOM 遍历的情况下，才推荐使用 ElementHandle。对于所有用户操作和断言，请使用 locator 代替。

Locator 和 ElementHandle 之间的区别在于，后者指向特定的元素，而 Locator 则记录了如何检索该元素的逻辑。

在下面的示例中，handle 指向页面上的特定 DOM 元素。如果该元素更改了文本，或者 React 使用它来渲染一个完全不同的组件，handle 仍然指向那个过时的 DOM 元素。这可能会导致意外行为。

ElementHandle handle = page.querySelector("text=Submit");
handle.hover();
handle.click();

使用 locator 时，每次使用 locator，都会使用选择器在页面中定位最新的 DOM 元素。因此在下面的代码片段中，底层的 DOM 元素将被定位两次。

Locator locator = page.getByText("Submit");
locator.hover();
locator.click();

简介​

API 参考​

元素句柄​

句柄作为参数​

句柄生命周期​

API 参考​

Locator 与 ElementHandle​

简介

API 参考

元素句柄

句柄作为参数

句柄生命周期

API 参考

Locator 与 ElementHandle