句柄

简介

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

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

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

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

API 参考

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

JSHandle jsHandle = page.evaluateHandle("window");
//  Use jsHandle for evaluations.

元素句柄

不推荐

不鼓励使用 ElementHandle，请改用 Locator 对象和 web-first 断言。

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

// Get the element handle
JSHandle jsHandle = page.waitForSelector("#box");
ElementHandle elementHandle = jsHandle.asElement();

// Assert bounding box for the element
BoundingBox boundingBox = elementHandle.boundingBox();
assertEquals(100, boundingBox.width);

// Assert attribute for the element
String classNames = elementHandle.getAttribute("class");
assertTrue(classNames.contains("highlighted"));

作为参数的句柄

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

// Create new array in page.
JSHandle myArrayHandle = page.evaluateHandle("() => {\n" +
  "  window.myArray = [1];\n" +
  "  return myArray;\n" +
  "}");

// Get the length of the array.
int length = (int) page.evaluate("a => a.length", myArrayHandle);

// Add one more element to the array using the handle
Map<String, Object> arg = new HashMap<>();
arg.put("myArray", myArrayHandle);
arg.put("newElement", 2);
page.evaluate("arg => arg.myArray.add(arg.newElement)", arg);

// Release the object when it is no longer needed.
myArrayHandle.dispose();

句柄生命周期

句柄可以使用页面方法（例如 Page.evaluateHandle()、Page.querySelector() 或 Page.querySelectorAll()）或其帧对应项（Frame.evaluateHandle()、Frame.querySelector() 或 Frame.querySelectorAll()）获取。一旦创建，句柄将保留对象，使其免于垃圾回收，除非页面导航或句柄通过 JSHandle.dispose() 方法手动处置。

API 参考

Locator vs ElementHandle

注意

我们只建议在极少数需要对静态页面进行大量 DOM 遍历的情况下使用 ElementHandle。对于所有用户操作和断言，请改用定位器。

Locator 和 ElementHandle 的区别在于，后者指向特定的元素，而 Locator 捕获如何检索该元素的逻辑。

在下面的示例中，句柄指向页面上的特定 DOM 元素。如果该元素改变文本或被 React 用于渲染一个完全不同的组件，句柄仍然指向那个非常陈旧的 DOM 元素。这可能导致意外的行为。

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

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

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

简介​

API 参考​

元素句柄​

作为参数的句柄​

句柄生命周期​

API 参考​

Locator vs ElementHandle​

简介

API 参考

元素句柄

作为参数的句柄

句柄生命周期

API 参考

Locator vs ElementHandle