跳到主要內容

Handle

簡介​

Playwright 可以在頁面 DOM 元素或頁面內部的任何其他物件建立 handle。這些 handle 存在於 Playwright 處理程序中，而實際的物件則存在於瀏覽器中。有兩種 handle 類型

  • JSHandle 用於參考頁面中的任何 JavaScript 物件
  • ElementHandle 用於參考頁面中的 DOM 元素，它具有額外的方法，可讓您對元素執行動作並斷言其屬性。

由於頁面中的任何 DOM 元素也是 JavaScript 物件，因此任何 ElementHandle 也都是 JSHandle。

Handle 用於對頁面中那些實際物件執行操作。您可以在 handle 上評估、取得 handle 屬性、將 handle 作為評估參數傳遞、將頁面物件序列化為 JSON 等。請參閱 JSHandle 類別 API 以了解這些方法。

API 參考​

以下是取得 JSHandle 最簡單的方式。

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

Element Handle​

不建議使用

不建議使用 ElementHandle，請改用 Locator 物件和網頁優先的斷言。

當需要 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

將 Handle 作為參數​

Handle 可以傳遞到 page.evaluate() 和類似方法中。以下程式碼片段會在頁面中建立新的陣列，使用資料初始化它，並將此陣列的 handle 傳回 Playwright。然後在後續評估中使用該 handle

# 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()

Handle 生命周期​

可以使用頁面方法取得 Handle，例如 page.evaluate_handle()、page.query_selector() 或 page.query_selector_all() 或其框架對應項 frame.evaluate_handle()、frame.query_selector() 或 frame.query_selector_all()。建立後，除非頁面導航或透過 js_handle.dispose() 方法手動處置 handle，否則 handle 將保留來自 垃圾回收 的物件。

API 參考​

Locator 與 ElementHandle​

注意

我們僅建議在少數情況下使用 ElementHandle，亦即當您需要在靜態頁面上執行廣泛的 DOM 遍歷時。對於所有使用者動作和斷言，請改用 locator。

Locator 和 ElementHandle 之間的差異在於，後者指向特定的元素，而 Locator 捕捉如何檢索該元素的邏輯。

在以下範例中，handle 指向頁面上特定的 DOM 元素。如果該元素變更文字，或由 React 用於呈現完全不同的元件，則 handle 仍然指向該非常過時的 DOM 元素。這可能會導致意想不到的行為。

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

使用 locator 時，每次使用 locator，都會使用選擇器在頁面中定位最新的 DOM 元素。因此，在以下程式碼片段中，底層 DOM 元素將被定位兩次。

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