跳转到主要内容

句柄

简介​

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

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

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

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

API 参考​

这是获取 JSHandle 最简单的方法。

js_handle = page.evaluate_handle('window')
#  Use jsHandle for evaluations.

元素句柄 (Element Handles)​

不推荐

不建议使用 ElementHandle，请改用 Locator 对象和 Web 优先断言 (web-first assertions)。

当必须使用 ElementHandle 时，建议使用 page.wait_for_selector() 或 frame.wait_for_selector() 方法获取它。这些 API 会等待元素被附加并可见。

# Get the element handle
element_handle = page.wait_for_selector('#box')

# Assert bounding box for the element
bounding_box = element_handle.bounding_box()
assert bounding_box.width == 100

# Assert attribute for the element
class_names = element_handle.get_attribute('class')
assert 'highlighted' in class_names

作为参数的句柄​

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

# Create new array in page.
my_array_handle = page.evaluate_handle("""() => {
  window.myArray = [1];
  return myArray;
}""")

# Get current length of the array.
length = page.evaluate("a => a.length", my_array_handle)

# Add one more element to the array using the handle
page.evaluate("(arg) => arg.myArray.push(arg.newElement)", {
  'myArray': my_array_handle,
  'newElement': 2
})

# Release the object when it's no longer needed.
my_array_handle.dispose()

句柄生命周期​

可以使用页面方法（如 page.evaluate_handle()、page.query_selector() 或 page.query_selector_all()，或者它们的 frame 对应方法 frame.evaluate_handle()、frame.query_selector() 或 frame.query_selector_all()）来获取句柄。创建后，句柄将阻止对象被 垃圾回收，除非页面发生导航，或者通过 js_handle.dispose() 方法手动释放句柄。

API 参考​

Locator 与 ElementHandle 对比​

注意

我们仅建议在极少数需要对静态页面执行复杂 DOM 遍历的情况下使用 ElementHandle。对于所有的用户操作和断言，请使用 locator。

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

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

handle = page.query_selector("text=Submit")
handle.hover()
handle.click()

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

locator = page.get_by_text("Submit")
locator.hover()
locator.click()