跳到主要内容

扩展性

自定义选择器引擎

Playwright 支持通过 Selectors.register() 注册的自定义选择器引擎。

选择器引擎应具备以下属性:

  • query 函数,用于查询相对于 root 匹配 selector 的首个元素。
  • queryAll 函数,用于查询相对于 root 匹配 selector 的所有元素。

默认情况下,该引擎直接在框架的 JavaScript 上下文中运行,例如,可以调用应用程序定义的函数。若要将引擎与框架中的任何 JavaScript 隔离开,但仍保留对 DOM 的访问权限,可以使用 {contentScript: true} 选项注册该引擎。内容脚本引擎更安全,因为它受到保护,不会受到全局对象的任何篡改,例如更改 Node.prototype 方法。所有内置选择器引擎都作为内容脚本运行。请注意,当该引擎与其他自定义引擎一起使用时,不能保证以内容脚本的方式运行。

选择器必须在创建页面之前注册。

以下是一个注册基于标签名查询元素的选择器引擎的示例:

// 必须是一个脚本,计算结果为一个选择器引擎实例。该脚本在页面上下文中计算。
String createTagNameEngine = "{\n" +
" // 返回根节点子树中与给定选择器匹配的首个元素。\n" +
" query(root, selector) {\n" +
" return root.querySelector(selector);\n" +
" },\n" +
"\n" +
" // 返回根节点子树中与给定选择器匹配的所有元素。\n" +
" queryAll(root, selector) {\n" +
" return Array.from(root.querySelectorAll(selector));\n" +
" }\n" +
"}";

// 注册该引擎。选择器将以 "tag=" 为前缀。
playwright.selectors().register("tag", createTagNameEngine);

// 现在我们可以使用 "tag=" 选择器。
Locator button = page.locator("tag=button");
button.click();

// 我们可以将其与内置定位器结合使用。
page.locator("tag=div").getByText("Click me").click();

// 我们可以在任何支持选择器的方法中使用它。
int buttonCount = (int) page.locator("tag=button").count();