定位器
简介
Locator是 Playwright 自动等待和重试功能的核心部分。简而言之，定位器代表了一种在任何时刻查找页面上元素（或元素组）的方法。
快速指南
以下是一些推荐的内置定位器。
- Page.getByRole() 用于根据显式和隐式可访问性属性进行定位。
- Page.getByText() 用于根据文本内容进行定位。
- Page.getByLabel() 用于根据关联标签的文本定位表单控件。
- Page.getByPlaceholder() 用于根据占位符定位输入框。
- Page.getByAltText() 用于根据替代文本定位元素，通常是图像。
- Page.getByTitle() 用于根据 title 属性定位元素。
- Page.getByTestId() 用于根据元素的
data-testid属性进行定位（可以配置其他属性）。
page.getByLabel("User Name").fill("John");
page.getByLabel("Password").fill("secret-password");
page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Sign in"))
.click();
assertThat(page.getByText("Welcome, John!")).isVisible();
定位元素
Playwright 提供了多种内置定位器。为了使测试更具弹性，我们建议优先使用面向用户的属性和显式约定，例如 Page.getByRole()。
例如，考虑以下 DOM 结构。
<button>Sign in</button>
根据名为“登录”的 button 的角色定位元素。
page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Sign in"))
.click();
使用 代码生成器 生成定位器，然后根据需要进行编辑。
每次使用定位器执行操作时，都会在页面中找到最新的 DOM 元素。在下面的代码片段中，底层 DOM 元素将被定位两次，每次操作前各一次。这意味着如果由于重新渲染导致 DOM 在调用之间发生更改，则将使用与定位器对应的新的元素。
Locator locator = page.getByRole(AriaRole.BUTTON,
new Page.GetByRoleOptions().setName("Sign in"))
locator.hover();
locator.click();
请注意，所有创建定位器的方法（例如 Page.getByLabel()）在 Locator 和 FrameLocator 类中也可用，因此您可以将它们链接起来并迭代地缩小定位器的范围。
Locator locator = page
.frameLocator("#my-frame")
.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Sign in"));
locator.click();
按角色定位
Page.getByRole() 定位器反映了用户和辅助技术如何感知页面，例如某个元素是按钮还是复选框。当按角色定位时，通常也应传递可访问名称，以便定位器能够精确定位元素。
例如，考虑以下 DOM 结构。
注册
<h3>Sign up</h3>
<label>
<input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>
您可以根据每个元素的隐式角色对其进行定位
assertThat(page
.getByRole(AriaRole.HEADING,
new Page.GetByRoleOptions().setName("Sign up")))
.isVisible();
page.getByRole(AriaRole.CHECKBOX,
new Page.GetByRoleOptions().setName("Subscribe"))
.check();
page.getByRole(AriaRole.BUTTON,
new Page.GetByRoleOptions().setName(
Pattern.compile("submit", Pattern.CASE_INSENSITIVE)))
.click();
角色定位器包括 按钮、复选框、标题、链接、列表、表格等等，并遵循 W3C 关于 ARIA 角色、ARIA 属性 和 可访问名称 的规范。请注意，许多 HTML 元素（如 <button>）具有 隐式定义的角色，角色定位器可以识别这些角色。
请注意，角色定位器**不能替代**可访问性审计和一致性测试，而只是提供了关于 ARIA 指南的早期反馈。
我们建议优先使用角色定位器来定位元素，因为这是最接近用户和辅助技术感知页面方式的方法。
按标签定位
大多数表单控件通常都有专用的标签，可以方便地用于与表单交互。在这种情况下，您可以使用 Page.getByLabel() 根据其关联标签来定位控件。
例如，考虑以下 DOM 结构。
<label>Password <input type="password" /></label>
您可以根据标签文本定位输入框后填充它
page.getByLabel("Password").fill("secret");
在定位表单字段时使用此定位器。
按占位符定位
输入框可能具有占位符属性，以提示用户应输入什么值。您可以使用 Page.getByPlaceholder() 定位此类输入框。
例如，考虑以下 DOM 结构。
<input type="email" placeholder="[email protected]" />
您可以根据占位符文本定位输入框后填充它
page.getByPlaceholder("[email protected]").fill("[email protected]");
在定位没有标签但有占位符文本的表单元素时使用此定位器。
按文本定位
根据元素包含的文本查找元素。使用 Page.getByText() 时，您可以根据子字符串、精确字符串或正则表达式进行匹配。
例如，考虑以下 DOM 结构。
<span>Welcome, John</span>
您可以根据元素包含的文本对其进行定位
assertThat(page.getByText("Welcome, John")).isVisible();
设置精确匹配
assertThat(page
.getByText("Welcome, John", new Page.GetByTextOptions().setExact(true)))
.isVisible();
使用正则表达式匹配
assertThat(page
.getByText(Pattern.compile("welcome, john$", Pattern.CASE_INSENSITIVE)))
.isVisible();
按文本匹配始终会规范化空格，即使使用精确匹配也是如此。例如，它会将多个空格转换为一个空格，将换行符转换为空格，并忽略前导和尾随空格。
我们建议使用文本定位器查找非交互式元素，例如 div、span、p 等。对于交互式元素（如 button、a、input 等），请使用 角色定位器。
您还可以 按文本过滤，这在尝试查找列表中的特定项目时非常有用。
按替代文本定位
所有图像都应具有描述图像的 alt 属性。您可以使用 Page.getByAltText() 根据替代文本定位图像。
例如，考虑以下 DOM 结构。
<img alt="playwright logo" src="/img/playwright-logo.svg" width="100" />
您可以根据替代文本定位图像后单击它
page.getByAltText("playwright logo").click();
在元素支持替代文本（例如 img 和 area 元素）时使用此定位器。
按标题定位
使用 Page.getByTitle() 定位具有匹配 title 属性的元素。
例如，考虑以下 DOM 结构。
<span title='Issues count'>25 issues</span>
您可以根据标题文本定位后检查问题数量
assertThat(page.getByTitle("Issues count")).hasText("25 issues");
在元素具有 title 属性时使用此定位器。
按测试 ID 定位
通过测试 ID 进行测试是最可靠的测试方式，即使您的文本或属性的角色发生变化，测试仍然会通过。QA 和开发人员应该定义明确的测试 ID，并使用 Page.getByTestId() 查询它们。但是，通过测试 ID 进行测试不面向用户。如果角色或文本值对您很重要，请考虑使用面向用户的定位器，例如 角色 和 文本定位器。
例如，考虑以下 DOM 结构。
<button data-testid="directions">Itinéraire</button>
您可以通过其测试 ID 定位元素
page.getByTestId("directions").click();
设置自定义测试 ID 属性
默认情况下，Page.getByTestId() 将根据 data-testid 属性定位元素，但您可以在测试配置中或通过调用 Selectors.setTestIdAttribute() 来配置它。
将测试 ID 设置为使用自定义数据属性进行测试。
playwright.selectors().setTestIdAttribute("data-pw");
在您的 HTML 中，您现在可以使用 data-pw 作为您的测试 ID，而不是默认的 data-testid。
<button data-pw="directions">Itinéraire</button>
然后像往常一样定位元素
page.getByTestId("directions").click();
通过 CSS 或 XPath 定位
如果您必须使用 CSS 或 XPath 定位器，可以使用 Page.locator() 创建一个定位器，该定位器采用一个选择器来描述如何在页面中查找元素。Playwright 支持 CSS 和 XPath 选择器，如果您省略 css= 或 xpath= 前缀，它会自动检测它们。
page.locator("css=button").click();
page.locator("xpath=//button").click();
page.locator("button").click();
page.locator("//button").click();
XPath 和 CSS 选择器可以绑定到 DOM 结构或实现。当 DOM 结构发生变化时，这些选择器可能会失效。以下较长的 CSS 或 XPath 链是导致测试不稳定的不良实践示例
page.locator(
"#tsf > div:nth-child(2) > div.A8SBwf > div.RNNXgb > div > div.a4bIc > input"
).click();
page.locator("//*[@id='tsf']/div[2]/div[1]/div[1]/div/div[2]/input").click();
在 Shadow DOM 中定位
Playwright 中的所有定位器默认情况下都适用于 Shadow DOM 中的元素。例外情况是
- 通过 XPath 定位不会穿透阴影根。
- 封闭模式阴影根 不受支持。
考虑以下使用自定义 Web 组件的示例
<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 根不存在一样进行定位。
要点击 <div>Details</div>
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>
page.locator("x-details", new Page.LocatorOptions().setHasText("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”
assertThat(page.locator("x-details")).containsText("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() 方法按文本筛选定位器。它将在元素内部（可能在后代元素中）搜索特定的字符串，不区分大小写。您还可以传递正则表达式。
page.getByRole(AriaRole.LISTITEM)
.filter(new Locator.FilterOptions().setHasText("Product 2"))
.getByRole(AriaRole.BUTTON,
new Page.GetByRoleOptions().setName("Add to cart"))
.click();
使用正则表达式
page.getByRole(AriaRole.LISTITEM)
.filter(new Locator.FilterOptions()
.setHasText(Pattern.compile("Product 2")))
.getByRole(AriaRole.BUTTON,
new Page.GetByRoleOptions().setName("Add to cart"))
.click();
按不包含文本筛选
或者，按不包含文本筛选
// 5 in-stock items
assertThat(page.getByRole(AriaRole.LISTITEM)
.filter(new Locator.FilterOptions().setHasNotText("Out of stock")))
.hasCount(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>
page.getByRole(AriaRole.LISTITEM)
.filter(new Locator.FilterOptions()
.setHas(page.GetByRole(AriaRole.HEADING, new Page.GetByRoleOptions()
.setName("Product 2"))))
.getByRole(AriaRole.BUTTON,
new Page.GetByRoleOptions().setName("Add to cart"))
.click()
我们还可以断言产品卡片以确保只有一个
assertThat(page
.getByRole(AriaRole.LISTITEM)
.filter(new Locator.FilterOptions()
.setHas(page.GetByRole(AriaRole.HEADING,
new Page.GetByRoleOptions().setName("Product 2"))))
.hasCount(1);
筛选定位器必须相对于原始定位器，并且从原始定位器匹配开始查询，而不是从文档根开始查询。因此，以下方法将不起作用，因为筛选定位器从 <ul> 列表元素（位于原始定位器匹配的 <li> 列表项外部）开始匹配
// ✖ WRONG
assertThat(page
.getByRole(AriaRole.LISTITEM)
.filter(new Locator.FilterOptions()
.setHas(page.GetByRole(AriaRole.LIST)
.GetByRole(AriaRole.HEADING,
new Page.GetByRoleOptions().setName("Product 2"))))
.hasCount(1);
按不包含子元素/后代元素筛选
我们还可以按不包含匹配元素进行筛选。
assertThat(page
.getByRole(AriaRole.LISTITEM)
.filter(new Locator.FilterOptions().setHasNot(page.getByText("Product 2")))
.hasCount(1);
请注意，内部定位器是从外部定位器开始匹配，而不是从文档根开始匹配。
定位器运算符
在定位器内匹配
您可以将创建定位器的方法（如 Page.getByText() 或 Locator.getByRole()）链接起来，以缩小对页面特定部分的搜索范围。
在此示例中，我们首先通过定位其 listitem 角色创建一个名为 product 的定位器。然后按文本筛选。我们可以再次使用 product 定位器按按钮角色获取并单击它，然后使用断言来确保只有一个文本为“产品 2”的产品。
Locator product = page
.getByRole(AriaRole.LISTITEM)
.filter(new Locator.FilterOptions().setHasText("Product 2"));
product
.getByRole(AriaRole.BUTTON,
new Locator.GetByRoleOptions().setName("Add to cart"))
.click();
您还可以将两个定位器链接在一起，例如在特定对话框中查找“保存”按钮
Locator saveButton = page.getByRole(AriaRole.BUTTON,
new Page.GetByRoleOptions().setName("Save"));
// ...
Locator dialog = page.getByTestId("settings-dialog");
dialog.locator(saveButton).click();
同时匹配两个定位器
方法 Locator.and() 通过匹配附加定位器来缩小现有定位器的范围。例如，您可以将 Page.getByRole() 和 Page.getByTitle() 组合起来，以同时按角色和标题进行匹配。
Locator button = page.getByRole(AriaRole.BUTTON).and(page.getByTitle("Subscribe"));
匹配两个备选定位器中的一个
如果您想定位两个或多个元素中的一个，并且不知道将是哪一个，请使用 Locator.or() 创建一个匹配所有备选方案的定位器。
例如，考虑一个您想点击“新邮件”按钮的场景，但有时会显示安全设置对话框。在这种情况下，您可以等待“新邮件”按钮或对话框，然后相应地采取措施。
如果“新邮件”按钮和安全对话框都显示在屏幕上，“或”定位器将同时匹配两者，可能会抛出 “严格模式违规”错误。在这种情况下，您可以使用 Locator.first() 仅匹配其中一个。
Locator newEmail = page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("New"));
Locator dialog = page.getByText("Confirm security settings");
assertThat(newEmail.or(dialog).first()).isVisible();
if (dialog.isVisible())
page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Dismiss")).click();
newEmail.click();
仅匹配可见元素
通常最好找到一种 更可靠的方法 来唯一标识元素，而不是检查可见性。
考虑一个有两个按钮的页面，第一个不可见，第二个 可见。
<button style='display: none'>Invisible</button>
<button>Visible</button>
-
这将找到这两个按钮并抛出 严格模式 违规错误
page.locator("button").click(); -
这将只找到第二个按钮，因为它可见，然后单击它。
page.locator("button").locator("visible=true").click();
列表
计算列表中的项目数
您可以断言定位器以计算列表中的项目数。
例如，考虑以下 DOM 结构
- 苹果
- 香蕉
- 橙子
<ul>
<li>apple</li>
<li>banana</li>
<li>orange</li>
</ul>
使用计数断言确保列表中有 3 个项目。
assertThat(page.getByRole(AriaRole.LISTITEM).hasCount(3);
断言列表中的所有文本
您可以断言定位器以查找列表中的所有文本。
例如，考虑以下 DOM 结构
- 苹果
- 香蕉
- 橙子
<ul>
<li>apple</li>
<li>banana</li>
<li>orange</li>
</ul>
使用 assertThat(locator).hasText() 确保列表包含文本“苹果”、“香蕉”和“橙子”。
assertThat(page
.getByRole(AriaRole.LISTITEM))
.hasText(new String[] { "apple", "banana", "orange" });
获取特定项目
有很多方法可以获取列表中的特定项目。
按文本获取
使用 Page.getByText() 方法按其文本内容在列表中定位元素，然后单击它。
例如，考虑以下 DOM 结构
- 苹果
- 香蕉
- 橙子
<ul>
<li>apple</li>
<li>banana</li>
<li>orange</li>
</ul>
按其文本内容定位项目并单击它。
page.getByText("orange").click();
按文本筛选
使用 Locator.filter() 在列表中定位特定项目。
例如，考虑以下 DOM 结构
- 苹果
- 香蕉
- 橙子
<ul>
<li>apple</li>
<li>banana</li>
<li>orange</li>
</ul>
按“列表项”角色定位项目，然后按“橙子”文本筛选，然后单击它。
page.getByRole(AriaRole.LISTITEM)
.filter(new Locator.FilterOptions().setHasText("orange"))
.click();
按测试 ID 获取
使用 Page.getByTestId() 方法在列表中定位元素。如果还没有测试 ID，则可能需要修改 HTML 并添加测试 ID。
例如，考虑以下 DOM 结构
- 苹果
- 香蕉
- 橙子
<ul>
<li data-testid='apple'>apple</li>
<li data-testid='banana'>banana</li>
<li data-testid='orange'>orange</li>
</ul>
按其“橙子”测试 ID 定位项目，然后单击它。
page.getByTestId("orange").click();
按第 n 个项目获取
如果有一系列完全相同的元素，并且唯一区分它们的方法是顺序，则可以使用Locator.first()、Locator.last()或Locator.nth()从列表中选择特定元素。
Locator banana = page.getByRole(AriaRole.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”和“Say goodbye”的行屏幕截图
Locator rowLocator = page.getByRole(AriaRole.LISTITEM);
rowLocator
.filter(new Locator.FilterOptions().setHasText("Mary"))
.filter(new Locator.FilterOptions()
.setHas(page.getByRole(
AriaRole.BUTTON,
new Page.GetByRoleOptions().setName("Say goodbye"))))
.screenshot(new Page.ScreenshotOptions().setPath("screenshot.png"));
您现在应该在项目的根目录中有一个“screenshot.png”文件。
罕见用例
对列表中的每个元素执行操作
迭代元素
for (Locator row : page.getByRole(AriaRole.LISTITEM).all())
System.out.println(row.textContent());
使用常规for循环迭代
Locator rows = page.getByRole(AriaRole.LISTITEM);
int count = rows.count();
for (int i = 0; i < count; ++i)
System.out.println(rows.nth(i).textContent());
在页面中评估
Locator.evaluateAll()内部的代码在页面中运行，您可以在其中调用任何DOM API。
Locator rows = page.getByRole(AriaRole.LISTITEM);
Object texts = rows.evaluateAll(
"list => list.map(element => element.textContent)");
严格性
定位器是严格的。这意味着对定位器执行的所有暗示某些目标DOM元素的操作，如果有多个元素匹配，则会抛出异常。例如，如果DOM中有多个按钮，则以下调用将抛出异常
如果有多个则抛出错误
page.getByRole(AriaRole.BUTTON).click();
另一方面，Playwright 了解您何时执行多元素操作，因此当定位器解析为多个元素时，以下调用可以完美运行。
可以与多个元素一起正常使用
page.getByRole(AriaRole.BUTTON).count();
您可以通过Locator.first()、Locator.last()和Locator.nth()明确选择退出严格性检查，告诉 Playwright 当多个元素匹配时使用哪个元素。不建议使用这些方法，因为当您的页面发生更改时，Playwright 可能会单击您未打算单击的元素。相反，请遵循以上最佳实践创建唯一标识目标元素的定位器。
更多定位器
有关不太常用的定位器，请参阅其他定位器指南。