句柄
简介
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优先断言。
当需要 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 参考
- JSHandle
- ElementHandle
- ElementHandle.boundingBox()
- ElementHandle.getAttribute()
- ElementHandle.innerText()
- ElementHandle.innerHTML()
- ElementHandle.textContent()
- JSHandle.evaluate()
- Page.evaluateHandle()
- Page.querySelector()
- Page.querySelectorAll()
Locator 与 ElementHandle
我们仅建议在极少数情况下使用 ElementHandle,即当您需要对静态页面执行广泛的 DOM 遍历时。对于所有用户操作和断言,请改用定位器。
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();