定位器
簡介
定位器是 Playwright 自動等待和重試能力的核心。簡單來說，定位器代表一種在任何時刻於頁面上尋找元素的方式。
快速指南
這些是推薦的內建定位器。
- page.getByRole() 依據明確和隱含的協助工具屬性定位。
- page.getByText() 依據文字內容定位。
- page.getByLabel() 依據關聯標籤的文字定位表單控制項。
- page.getByPlaceholder() 依據 placeholder 定位輸入框。
- page.getByAltText() 依據文字替代方案定位元素，通常是圖片。
- page.getByTitle() 依據 title 屬性定位元素。
- page.getByTestId() 依據其
data-testid屬性定位元素 (可以設定其他屬性)。
await page.getByLabel('User Name').fill('John');
await page.getByLabel('Password').fill('secret-password');
await page.getByRole('button', { name: 'Sign in' }).click();
await expect(page.getByText('Welcome, John!')).toBeVisible();
定位元素
Playwright 內建多種定位器。為了使測試更具彈性，我們建議優先使用面向使用者的屬性和明確的契約，例如 page.getByRole()。
例如，考慮以下 DOM 結構。
<button>Sign in</button>
依據角色 button 和名稱 “Sign in” 定位元素。
await page.getByRole('button', { name: 'Sign in' }).click();
使用程式碼產生器產生定位器，然後根據您的需求進行編輯。
每次將定位器用於操作時，都會在頁面中定位最新的 DOM 元素。在下面的程式碼片段中，底層 DOM 元素將被定位兩次，每次操作前一次。這表示如果 DOM 在呼叫之間由於重新渲染而發生變化，則將使用與定位器對應的新元素。
const locator = page.getByRole('button', { name: 'Sign in' });
await locator.hover();
await locator.click();
請注意，所有建立定位器的方法，例如 page.getByLabel()，在 Locator 和 FrameLocator 類別上也可用，因此您可以將它們串聯起來並迭代地縮小您的定位器範圍。
const locator = page
.frameLocator('#my-frame')
.getByRole('button', { name: 'Sign in' });
await locator.click();
依角色定位
page.getByRole() 定位器反映了使用者和輔助技術如何感知頁面，例如，某些元素是按鈕還是核取方塊。依角色定位時，您通常也應該傳遞可存取名稱，以便定位器精確地指出目標元素。
例如，考慮以下 DOM 結構。
註冊
<h3>Sign up</h3>
<label>
<input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>
您可以依據每個元素的隱含角色來定位
await expect(page.getByRole('heading', { name: 'Sign up' })).toBeVisible();
await page.getByRole('checkbox', { name: 'Subscribe' }).check();
await page.getByRole('button', { name: /submit/i }).click();
角色定位器包括 按鈕、核取方塊、標題、連結、清單、表格以及更多，並遵循 W3C 規範 ARIA 角色、ARIA 屬性 和 可存取名稱。 請注意，許多 html 元素 (如 <button>) 具有 隱含定義的角色，該角色可被角色定位器識別。
請注意，角色定位器不能取代協助工具稽核和符合性測試，而是提供有關 ARIA 指南的早期回饋。
我們建議優先使用角色定位器來定位元素，因為這是最接近使用者和輔助技術感知頁面的方式。
依標籤定位
大多數表單控制項通常都有專用的標籤，可以方便地用於與表單互動。在這種情況下，您可以使用 page.getByLabel() 依據其關聯標籤定位控制項。
例如，考慮以下 DOM 結構。
<label>Password <input type="password" /></label>
您可以在依據標籤文字定位輸入框後填寫內容
await page.getByLabel('Password').fill('secret');
當定位表單欄位時，請使用此定位器。
依 placeholder 定位
輸入框可能具有 placeholder 屬性，以提示使用者應輸入的值。您可以使用 page.getByPlaceholder() 定位此類輸入框。
例如，考慮以下 DOM 結構。
<input type="email" placeholder="name@example.com" />
您可以在依據 placeholder 文字定位輸入框後填寫內容
await page
.getByPlaceholder('name@example.com')
.fill('playwright@microsoft.com');
當定位沒有標籤但有 placeholder 文字的表單元素時，請使用此定位器。
依文字定位
依據元素包含的文字尋找元素。使用 page.getByText() 時，您可以依子字串、確切字串或正規表示式進行比對。
例如，考慮以下 DOM 結構。
<span>Welcome, John</span>
您可以依據元素包含的文字定位元素
await expect(page.getByText('Welcome, John')).toBeVisible();
設定精確比對
await expect(page.getByText('Welcome, John', { exact: true })).toBeVisible();
使用正規表示式比對
await expect(page.getByText(/welcome, [A-Za-z]+$/i)).toBeVisible();
依文字比對始終會正規化空白字元，即使是精確比對也是如此。例如，它會將多個空格變成一個空格，將換行符號變成空格，並忽略開頭和結尾的空白字元。
我們建議使用文字定位器來尋找非互動式元素，如 div、span、p 等。對於互動式元素，如 button、a、input 等，請使用 角色定位器。
您也可以依文字篩選，這在嘗試在清單中尋找特定項目時非常有用。
依 alt 文字定位
所有圖片都應具有描述圖片的 alt 屬性。您可以使用 page.getByAltText() 依據文字替代方案定位圖片。
例如，考慮以下 DOM 結構。
<img alt="playwright logo" src="/img/playwright-logo.svg" width="100" />
您可以在依據文字替代方案定位圖片後點擊圖片
await page.getByAltText('playwright logo').click();
當您的元素支援 alt 文字時 (例如 img 和 area 元素)，請使用此定位器。
依標題定位
使用 page.getByTitle() 定位具有相符 title 屬性的元素。
例如，考慮以下 DOM 結構。
<span title='Issues count'>25 issues</span>
您可以在依據標題文字定位問題計數後檢查問題計數
await expect(page.getByTitle('Issues count')).toHaveText('25 issues');
當您的元素具有 title 屬性時，請使用此定位器。
依測試 ID 定位
依測試 ID 進行測試是最具彈性的測試方式，因為即使您的文字或屬性的角色發生變化，測試仍然會通過。QA 和開發人員應定義明確的測試 ID，並使用 page.getByTestId() 查詢它們。但是，依測試 ID 進行測試並非面向使用者。如果角色或文字值對您很重要，請考慮使用面向使用者的定位器，例如 角色 和 文字定位器。
例如，考慮以下 DOM 結構。
<button data-testid="directions">Itinéraire</button>
您可以依據其測試 ID 定位元素
await page.getByTestId('directions').click();
設定自訂測試 ID 屬性
預設情況下，page.getByTestId() 將依據 data-testid 屬性定位元素，但您可以在測試設定中或透過呼叫 selectors.setTestIdAttribute() 來設定它。
設定測試 ID 以將自訂資料屬性用於您的測試。
import { defineConfig } from '@playwright/test';
export default defineConfig({
use: {
testIdAttribute: 'data-pw'
}
});
在您的 html 中，您現在可以使用 data-pw 作為您的測試 ID，而不是預設的 data-testid。
<button data-pw="directions">Itinéraire</button>
然後像平常一樣定位元素
await page.getByTestId('directions').click();
依 CSS 或 XPath 定位
如果您絕對必須使用 CSS 或 XPath 定位器，您可以使用 page.locator() 建立一個定位器，該定位器採用一個選擇器來描述如何在頁面中尋找元素。Playwright 支援 CSS 和 XPath 選擇器，如果您省略 css= 或 xpath= 前綴，它會自動偵測它們。
await page.locator('css=button').click();
await page.locator('xpath=//button').click();
await page.locator('button').click();
await page.locator('//button').click();
XPath 和 CSS 選擇器可能與 DOM 結構或實作相關聯。當 DOM 結構變更時，這些選擇器可能會損壞。以下長 CSS 或 XPath 鏈是導致不穩定測試的不良實務範例
await page.locator(
'#tsf > div:nth-child(2) > div.A8SBwf > div.RNNXgb > div > div.a4bIc > input'
).click();
await page
.locator('//*[@id="tsf"]/div[2]/div[1]/div[1]/div/div[2]/input')
.click();
在 Shadow DOM 中定位
Playwright 中的所有定位器預設都適用於 Shadow DOM 中的元素。例外情況如下：
- 依 XPath 定位無法穿透 shadow root。
- 封閉模式 shadow root 不受支援。
考慮以下使用自訂網頁元件的範例
<x-details role=button aria-expanded=true aria-controls=inner-details>
<div>Title</div>
#shadow-root
<div id=inner-details>Details</div>
</x-details>
您可以像 shadow root 完全不存在一樣進行定位。
點擊 <div>Details</div>
await page.getByText('Details').click();
<x-details role=button aria-expanded=true aria-controls=inner-details>
<div>Title</div>
#shadow-root
<div id=inner-details>Details</div>
</x-details>
點擊 <x-details>
await page.locator('x-details', { hasText: 'Details' }).click();
<x-details role=button aria-expanded=true aria-controls=inner-details>
<div>Title</div>
#shadow-root
<div id=inner-details>Details</div>
</x-details>
確保 <x-details> 包含文字 "Details"
await expect(page.locator('x-details')).toContainText('Details');
篩選定位器
考慮以下 DOM 結構，我們想要點擊第二個產品卡的購買按鈕。為了篩選定位器以取得正確的定位器，我們有幾個選項。
產品 1
產品 2
<ul>
<li>
<h3>Product 1</h3>
<button>Add to cart</button>
</li>
<li>
<h3>Product 2</h3>
<button>Add to cart</button>
</li>
</ul>
依文字篩選
可以使用 locator.filter() 方法依文字篩選定位器。它將在元素內部 (可能在後代元素中) 搜尋特定字串，不區分大小寫。您也可以傳遞正規表示式。
await page
.getByRole('listitem')
.filter({ hasText: 'Product 2' })
.getByRole('button', { name: 'Add to cart' })
.click();
使用正規表示式
await page
.getByRole('listitem')
.filter({ hasText: /Product 2/ })
.getByRole('button', { name: 'Add to cart' })
.click();
依不包含文字篩選
或者，依不包含文字篩選
// 5 in-stock items
await expect(page.getByRole('listitem').filter({ hasNotText: 'Out of stock' })).toHaveCount(5);
依子元素/後代元素篩選
定位器支援一個選項，僅選取具有或不具有與另一個定位器相符的後代元素的元素。因此，您可以依任何其他定位器進行篩選，例如 locator.getByRole()、locator.getByTestId()、locator.getByText() 等。
產品 1
產品 2
<ul>
<li>
<h3>Product 1</h3>
<button>Add to cart</button>
</li>
<li>
<h3>Product 2</h3>
<button>Add to cart</button>
</li>
</ul>
await page
.getByRole('listitem')
.filter({ has: page.getByRole('heading', { name: 'Product 2' }) })
.getByRole('button', { name: 'Add to cart' })
.click();
我們也可以斷言產品卡，以確保只有一張
await expect(page
.getByRole('listitem')
.filter({ has: page.getByRole('heading', { name: 'Product 2' }) }))
.toHaveCount(1);
篩選定位器必須相對於原始定位器，並且從原始定位器比對開始查詢，而不是從文件根目錄開始查詢。因此，以下程式碼將無法運作，因為篩選定位器從 <ul> 清單元素開始比對，而該元素位於原始定位器比對的 <li> 清單項目之外
// ✖ WRONG
await expect(page
.getByRole('listitem')
.filter({ has: page.getByRole('list').getByText('Product 2') }))
.toHaveCount(1);
依不包含子元素/後代元素篩選
我們也可以依不包含內部相符元素進行篩選。
await expect(page
.getByRole('listitem')
.filter({ hasNot: page.getByText('Product 2') }))
.toHaveCount(1);
請注意，內部定位器從外部定位器開始比對，而不是從文件根目錄開始比對。
定位器運算子
在定位器內比對
您可以串聯建立定位器的方法 (如 page.getByText() 或 locator.getByRole()) ，以將搜尋範圍縮小到頁面的特定部分。
在此範例中，我們首先建立一個名為 product 的定位器，方法是定位其 listitem 角色。然後我們依文字篩選。我們可以再次使用 product 定位器依按鈕角色取得並點擊它，然後使用斷言來確保只有一個包含文字 "產品 2" 的產品。
const product = page.getByRole('listitem').filter({ hasText: 'Product 2' });
await product.getByRole('button', { name: 'Add to cart' }).click();
await expect(product).toHaveCount(1);
您也可以將兩個定位器串聯在一起，例如在特定對話框內尋找 "儲存" 按鈕
const saveButton = page.getByRole('button', { name: 'Save' });
// ...
const dialog = page.getByTestId('settings-dialog');
await dialog.locator(saveButton).click();
同時比對兩個定位器
方法 locator.and() 透過比對額外的定位器來縮小現有定位器的範圍。例如，您可以結合 page.getByRole() 和 page.getByTitle() 以同時依角色和標題進行比對。
const button = page.getByRole('button').and(page.getByTitle('Subscribe'));
比對兩個替代定位器之一
如果您想要鎖定兩個或多個元素之一，但您不知道它會是哪一個，請使用 locator.or() 建立一個定位器，該定位器與任一或兩個替代方案都相符。
例如，考慮這樣一種情境：您想要點擊 "新電子郵件" 按鈕，但有時會出現安全設定對話框。在這種情況下，您可以等待 "新電子郵件" 按鈕或對話框，並據此採取行動。
如果 "新電子郵件" 按鈕和安全對話框都出現在螢幕上，則 "or" 定位器將同時比對它們，可能會拋出「嚴格模式違規」錯誤。在這種情況下，您可以使用 locator.first() 僅比對其中一個。
const newEmail = page.getByRole('button', { name: 'New' });
const dialog = page.getByText('Confirm security settings');
await expect(newEmail.or(dialog).first()).toBeVisible();
if (await dialog.isVisible())
await page.getByRole('button', { name: 'Dismiss' }).click();
await newEmail.click();
僅比對可見元素
通常最好找到一種更可靠的方式來唯一識別元素，而不是檢查可見性。
考慮一個包含兩個按鈕的頁面，第一個按鈕不可見，第二個按鈕可見。
<button style='display: none'>Invisible</button>
<button>Visible</button>
-
這將找到兩個按鈕並拋出嚴格模式違規錯誤
await page.locator('button').click(); -
這將僅找到第二個按鈕，因為它是可見的，然後點擊它。
await page.locator('button').locator('visible=true').click();
清單
計算清單中的項目
您可以斷言定位器以計算清單中的項目數。
例如，考慮以下 DOM 結構
- 蘋果
- 香蕉
- 橘子
<ul>
<li>apple</li>
<li>banana</li>
<li>orange</li>
</ul>
使用計數斷言來確保清單包含 3 個項目。
await expect(page.getByRole('listitem')).toHaveCount(3);
斷言清單中的所有文字
您可以斷言定位器以尋找清單中的所有文字。
例如，考慮以下 DOM 結構
- 蘋果
- 香蕉
- 橘子
<ul>
<li>apple</li>
<li>banana</li>
<li>orange</li>
</ul>
使用 expect(locator).toHaveText() 確保清單包含文字 "蘋果"、"香蕉" 和 "橘子"。
await expect(page
.getByRole('listitem'))
.toHaveText(['apple', 'banana', 'orange']);
取得特定項目
有很多方法可以取得清單中的特定項目。
依文字取得
使用 page.getByText() 方法依據文字內容在清單中定位元素，然後點擊它。
例如，考慮以下 DOM 結構
- 蘋果
- 香蕉
- 橘子
<ul>
<li>apple</li>
<li>banana</li>
<li>orange</li>
</ul>
依據文字內容定位項目並點擊它。
await page.getByText('orange').click();
依文字篩選
使用 locator.filter() 定位清單中的特定項目。
例如，考慮以下 DOM 結構
- 蘋果
- 香蕉
- 橘子
<ul>
<li>apple</li>
<li>banana</li>
<li>orange</li>
</ul>
依 "listitem" 角色定位項目，然後依 "橘子" 文字篩選，然後點擊它。
await page
.getByRole('listitem')
.filter({ hasText: 'orange' })
.click();
依測試 ID 取得
使用 page.getByTestId() 方法定位清單中的元素。您可能需要修改 html 並新增測試 ID (如果您尚未擁有測試 ID)。
例如，考慮以下 DOM 結構
- 蘋果
- 香蕉
- 橘子
<ul>
<li data-testid='apple'>apple</li>
<li data-testid='banana'>banana</li>
<li data-testid='orange'>orange</li>
</ul>
依據 "橘子" 測試 ID 定位項目，然後點擊它。
await page.getByTestId('orange').click();
依第 n 個項目取得
如果您有一個相同的元素清單，並且區分它們的唯一方法是順序，則可以使用 locator.first()、locator.last() 或 locator.nth() 從清單中選擇特定元素。
const banana = await page.getByRole('listitem').nth(1);
但是，請謹慎使用此方法。通常，頁面可能會變更，並且定位器將指向與您預期完全不同的元素。相反地，嘗試提出一個唯一的定位器，該定位器將通過嚴格模式標準。
串聯篩選器
當您擁有具有各種相似性的元素時，可以使用 locator.filter() 方法選取正確的元素。您也可以串聯多個篩選器來縮小選取範圍。
例如，考慮以下 DOM 結構
- John
- Mary
- John
- Mary
<ul>
<li>
<div>John</div>
<div><button>Say hello</button></div>
</li>
<li>
<div>Mary</div>
<div><button>Say hello</button></div>
</li>
<li>
<div>John</div>
<div><button>Say goodbye</button></div>
</li>
<li>
<div>Mary</div>
<div><button>Say goodbye</button></div>
</li>
</ul>
擷取包含 "Mary" 和 "說再見" 的列的螢幕截圖
const rowLocator = page.getByRole('listitem');
await rowLocator
.filter({ hasText: 'Mary' })
.filter({ has: page.getByRole('button', { name: 'Say goodbye' }) })
.screenshot({ path: 'screenshot.png' });
您現在應該在專案的根目錄中找到 "screenshot.png" 檔案。
罕見的使用案例
對清單中的每個元素執行某些操作
迭代元素
for (const row of await page.getByRole('listitem').all())
console.log(await row.textContent());
使用常規 for 迴圈迭代
const rows = page.getByRole('listitem');
const count = await rows.count();
for (let i = 0; i < count; ++i)
console.log(await rows.nth(i).textContent());
在頁面中評估
locator.evaluateAll() 內部的程式碼在頁面中執行，您可以在其中呼叫任何 DOM API。
const rows = page.getByRole('listitem');
const texts = await rows.evaluateAll(
list => list.map(element => element.textContent));
嚴格模式
定位器是嚴格的。這表示如果有多個元素符合條件，則定位器上所有暗示某些目標 DOM 元素的操作都會拋出例外。例如，如果 DOM 中有多個按鈕，則以下呼叫會拋出例外
如果有多個則拋出錯誤
await page.getByRole('button').click();
另一方面，Playwright 了解您何時執行多元素操作，因此當定位器解析為多個元素時，以下呼叫可以正常運作。
多個元素也能正常運作
await page.getByRole('button').count();
您可以透過告知 Playwright 在有多個元素符合條件時要使用哪個元素，透過 locator.first()、locator.last() 和 locator.nth()，明確選擇退出嚴格模式檢查。不建議使用這些方法，因為當您的頁面變更時，Playwright 可能會點擊您不打算點擊的元素。相反地，請遵循上述最佳實務來建立唯一識別目標元素的定位器。
更多定位器
對於較不常用的定位器，請參閱其他定位器指南。