BrowserType
BrowserType 提供方法来启动特定的浏览器实例或连接到现有实例。以下是使用 Playwright 驱动自动化的典型示例
const { chromium } = require('playwright'); // Or 'firefox' or 'webkit'.
(async () => {
const browser = await chromium.launch();
const page = await browser.newPage();
await page.goto('https://example.com');
// other actions...
await browser.close();
})();
方法
连接
v1.9 之前添加此方法将 Playwright 附加到通过 Node.js 中的 BrowserType.launchServer 创建的现有浏览器实例。
连接的 Playwright 实例的主版本和次版本需要与启动浏览器的 Playwright 版本匹配(1.2.3 → 兼容 1.2.x)。
用法
await browserType.connect(wsEndpoint);
await browserType.connect(wsEndpoint, options);
参数
-
要连接的 Playwright 浏览器 WebSocket 端点。您可以通过
BrowserServer.wsEndpoint获取此端点。 -
optionsObject (可选)-
exposeNetworkstring (可选)新增于:v1.37#此选项将连接客户端上可用的网络暴露给要连接的浏览器。由逗号分隔的规则列表组成。
可用规则
- 主机名模式,例如:
example.com、*.org:99、x.*.y.com、*foo.org。 - IP 字面量,例如:
127.0.0.1、0.0.0.0:99、[::1]、[0:0::1]:99。 <loopback>匹配本地回环接口:localhost、*.localhost、127.0.0.1、[::1]。
一些常见示例
"*"暴露所有网络。"<loopback>"暴露本地网络。"*.test.internal-domain,*.staging.internal-domain,<loopback>"暴露测试/预发布部署和本地主机。
- 主机名模式,例如:
-
headersObject<string, string> (可选)添加于:v1.11#要随 WebSocket 连接请求发送的额外 HTTP 头。可选。
-
已弃用
日志记录器收到的日志不完整。请改用跟踪。
Playwright 日志的日志接收器。可选。
-
将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。默认为 0。
-
等待连接建立的最大时间(毫秒)。默认为
0(无超时)。
-
返回
connectOverCDP
添加于:v1.9此方法使用 Chrome DevTools 协议将 Playwright 附加到现有浏览器实例。
默认浏览器上下文可通过 browser.contexts() 访问。
通过 Chrome DevTools 协议连接仅支持基于 Chromium 的浏览器。
此连接的保真度远低于通过 browserType.connect() 的 Playwright 协议连接。如果您遇到问题或尝试使用高级功能,您可能需要使用 browserType.connect()。
用法
const browser = await playwright.chromium.connectOverCDP('https://:9222');
const defaultContext = browser.contexts()[0];
const page = defaultContext.pages()[0];
参数
-
要连接的 CDP WebSocket 端点或 HTTP URL。例如
https://:9222/或ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4。 -
optionsObject (可选)-
endpointURLstring (可选)新增于:v1.14#已弃用请改用第一个参数。
-
headersObject<string, string> (可选)添加于:v1.11#要随连接请求发送的额外 HTTP 头。可选。
-
isLocalboolean (可选)添加于: v1.58#告诉 Playwright 它与 CDP 服务器运行在同一台主机上。它将启用某些依赖于 Playwright 和浏览器之间文件系统相同的优化。
-
已弃用
日志记录器收到的日志不完整。请改用跟踪。
Playwright 日志的日志接收器。可选。
-
将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。默认为 0。
-
等待连接建立的最大时间(毫秒)。默认为
30000(30 秒)。传递0禁用超时。
-
返回
executablePath
v1.9 之前添加Playwright 期望找到捆绑浏览器可执行文件的路径。
用法
browserType.executablePath();
返回
启动
v1.9 之前添加返回浏览器实例。
用法
您可以使用 ignoreDefaultArgs 来过滤掉默认参数中的 --mute-audio
const browser = await chromium.launch({ // Or 'firefox' or 'webkit'.
ignoreDefaultArgs: ['--mute-audio']
});
仅限 Chromium Playwright 也可用于控制 Google Chrome 或 Microsoft Edge 浏览器,但它与 Playwright 捆绑的 Chromium 版本配合效果最好。不能保证与其他版本一起正常工作。请谨慎使用 executablePath 选项。
如果首选 Google Chrome(而不是 Chromium),建议使用 Chrome Canary 或 Dev Channel 版本。
像 Google Chrome 和 Microsoft Edge 这样的普通浏览器适用于需要专有媒体编解码器进行视频播放的测试。有关 Chromium 和 Chrome 之间其他差异的更多信息,请参阅 本文。 本文 描述了 Linux 用户的一些差异。
参数
optionsObject (可选)-
警告
使用自定义浏览器参数需自行承担风险,因为其中一些参数可能会破坏 Playwright 的功能。
要传递给浏览器实例的附加参数。Chromium 标志列表可在 此处 找到。
-
浏览器分发渠道。
使用 "chromium" 选择加入新的无头模式。
使用 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", 或 "msedge-canary" 来使用品牌化的 Google Chrome 和 Microsoft Edge。
-
启用 Chromium 沙盒。默认为
false。 -
如果指定,接受的下载将下载到此目录。否则,将创建临时目录并在浏览器关闭时删除。在这两种情况下,下载将在创建它们的浏览器上下文关闭时删除。
-
要运行的浏览器可执行文件的路径,而不是捆绑的。如果 executablePath 是相对路径,则它相对于当前工作目录解析。请注意,Playwright 仅与捆绑的 Chromium、Firefox 或 WebKit 一起使用,使用风险自负。
-
firefoxUserPrefsObject<string, string | number | boolean> (可选)#Firefox 用户偏好设置。有关 Firefox 用户偏好设置的更多信息,请访问
about:config。您还可以通过
PLAYWRIGHT_FIREFOX_POLICIES_JSON环境变量提供自定义policies.json文件 的路径。 -
在收到 SIGHUP 信号时关闭浏览器进程。默认为
true。 -
在收到 Ctrl-C 信号时关闭浏览器进程。默认为
true。 -
在收到 SIGTERM 信号时关闭浏览器进程。默认为
true。 -
ignoreDefaultArgsboolean | Array<string> (可选)#如果为
true,Playwright 不会传递自己的配置参数,只使用 args 中的参数。如果给出数组,则会过滤掉给定的默认参数。危险选项;请谨慎使用。默认为false。 -
已弃用
日志记录器收到的日志不完整。请改用跟踪。
Playwright 日志记录的日志接收器。
-
-
serverstring用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128或socks5://myproxy.com:3128。简写形式myproxy.com:3128被视为 HTTP 代理。 -
bypassstring (可选)可选的逗号分隔的域以绕过代理,例如
".com, chromium.org, .domain.com"。 -
usernamestring (可选)如果 HTTP 代理需要身份验证,则使用的可选用户名。
-
passwordstring (可选)如果 HTTP 代理需要身份验证,则使用的可选密码。
网络代理设置。
-
-
将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。
-
等待浏览器实例启动的最大时间(毫秒)。默认为
30000(30 秒)。传递0禁用超时。 -
如果指定,追踪将保存到此目录。
-
返回
launchPersistentContext
v1.9 之前添加返回持久浏览器上下文实例。
启动使用位于 userDataDir 的持久化存储的浏览器,并返回唯一的上下文。关闭此上下文将自动关闭浏览器。
用法
await browserType.launchPersistentContext(userDataDir);
await browserType.launchPersistentContext(userDataDir, options);
参数
-
用户数据目录的路径,该目录存储浏览器会话数据,如 Cookie 和本地存储。传递空字符串以创建临时目录。
更多关于 Chromium 和 Firefox 的信息。Chromium 的用户数据目录是
chrome://version中看到的“配置文件路径”的父目录。请注意,浏览器不允许使用相同的用户数据目录启动多个实例。
警告Chromium/Chrome: 由于最近的 Chrome 政策更改,不支持自动化默认 Chrome 用户配置文件。将
userDataDir指向 Chrome 的主“用户数据”目录(用于您日常浏览的配置文件)可能会导致页面加载失败或浏览器退出。请创建一个单独的目录(例如,一个空文件夹)并将其用作自动化配置文件。有关详细信息,请参阅 https://developer.chrome.com/blog/remote-debugging-port。 -
optionsObject (可选)-
是否自动下载所有附件。默认为
true,即接受所有下载。 -
警告
使用自定义浏览器参数需自行承担风险,因为其中一些参数可能会破坏 Playwright 的功能。
要传递给浏览器实例的附加参数。Chromium 标志列表可在 此处 找到。
-
当使用 page.goto(), page.route(), page.waitForURL(), page.waitForRequest(), 或 page.waitForResponse() 时,它会通过使用
URL()构造函数来考虑基础 URL,以构建相应的 URL。默认未设置。示例- baseURL:
https://:3000,导航到/bar.html会得到https://:3000/bar.html - baseURL:
https://:3000/foo/,导航到./bar.html会得到https://:3000/foo/bar.html - baseURL:
https://:3000/foo(不带尾部斜杠),导航到./bar.html,结果为https://:3000/bar.html
- baseURL:
-
切换是否绕过页面的 Content-Security-Policy。默认为
false。 -
浏览器分发渠道。
使用 "chromium" 选择加入新的无头模式。
使用 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", 或 "msedge-canary" 来使用品牌化的 Google Chrome 和 Microsoft Edge。
-
启用 Chromium 沙盒。默认为
false。 -
clientCertificatesArray<Object> (可选)添加于: 1.46#-
originstring证书有效的精确源。源包括
https协议、主机名和可选的端口。 -
certPathstring (可选)PEM 格式证书文件的路径。
-
certBuffer (可选)PEM 格式证书的直接值。
-
keyPathstring (可选)PEM 格式私钥文件的路径。
-
keyBuffer (可选)PEM 格式私钥的直接值。
-
pfxPathstring (可选)PFX 或 PKCS12 编码的私钥和证书链文件的路径。
-
pfxBuffer (可选)PFX 或 PKCS12 编码的私钥和证书链的直接值。
-
passphrasestring (可选)私钥(PEM 或 PFX)的密码。
TLS 客户端认证允许服务器请求并验证客户端证书。
详情
要使用的客户端证书数组。每个证书对象必须同时包含
certPath和keyPath,单个pfxPath,或其相应的直接值(cert和key,或pfx)。如果证书已加密,可以选择提供passphrase属性。origin属性应提供与证书有效的请求源的确切匹配。仅当提供至少一个客户端证书时,客户端证书身份验证才处于活动状态。如果您想拒绝服务器发送的所有客户端证书,您需要提供一个
origin与您计划访问的任何域都不匹配的客户端证书。注意在 macOS 上使用 WebKit 时,访问
localhost将不会选取客户端证书。您可以通过将localhost替换为local.playwright来使其工作。 -
-
colorSchemenull | "light" | "dark" | "no-preference" (可选)#模拟 prefers-colors-scheme 媒体功能,支持的值为
'light'和'dark'。有关更多详细信息,请参阅 page.emulateMedia()。传递null会将仿真重置为系统默认值。默认为'light'。 -
contrastnull | "no-preference" | "more" (可选)#模拟
'prefers-contrast'媒体功能,支持的值为'no-preference','more'。有关更多详细信息,请参阅 page.emulateMedia()。传递null会将仿真重置为系统默认值。默认为'no-preference'。 -
deviceScaleFactornumber (可选)#指定设备比例因子(可视为 dpr)。默认为
1。了解更多关于 使用设备比例因子模拟设备。 -
如果指定,接受的下载将下载到此目录。否则,将创建临时目录并在浏览器关闭时删除。在这两种情况下,下载将在创建它们的浏览器上下文关闭时删除。
-
要运行的浏览器可执行文件的路径,而不是捆绑的。如果 executablePath 是相对路径,则它相对于当前工作目录解析。请注意,Playwright 仅与捆绑的 Chromium、Firefox 或 WebKit 一起使用,使用风险自负。
-
extraHTTPHeadersObject<string, string> (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
firefoxUserPrefsObject<string, string | number | boolean> (可选)添加于:v1.40#Firefox 用户偏好设置。有关 Firefox 用户偏好设置的更多信息,请访问
about:config。您还可以通过
PLAYWRIGHT_FIREFOX_POLICIES_JSON环境变量提供自定义policies.json文件 的路径。 -
forcedColorsnull | "active" | "none" (可选)#模拟
'forced-colors'媒体功能,支持的值为'active','none'。有关更多详细信息,请参阅 page.emulateMedia()。传递null会将仿真重置为系统默认值。默认为'none'。 -
在收到 SIGHUP 信号时关闭浏览器进程。默认为
true。 -
在收到 Ctrl-C 信号时关闭浏览器进程。默认为
true。 -
在收到 SIGTERM 信号时关闭浏览器进程。默认为
true。 -
指定视口是否支持触摸事件。默认为 false。了解更多关于 移动设备模拟。
-
-
usernamestring -
passwordstring -
originstring (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
send"unauthorized" | "always" (可选)此选项仅适用于来自相应 APIRequestContext 的请求,不会影响来自浏览器的请求。
'always'-Authorization头和基本身份验证凭据将与每个 API 请求一起发送。'unauthorized'- 仅在收到具有WWW-Authenticate头的 401(未经授权)响应时发送凭据。默认为'unauthorized'。
用于 HTTP 身份验证的凭据。如果未指定源,则在未经授权的响应时将用户名和密码发送到任何服务器。
-
-
ignoreDefaultArgsboolean | Array<string> (可选)#如果为
true,Playwright 不会传递自己的配置参数,只使用 args 中的参数。如果给出数组,则会过滤掉给定的默认参数。危险选项;请谨慎使用。默认为false。 -
ignoreHTTPSErrorsboolean (可选)#发送网络请求时是否忽略 HTTPS 错误。默认为
false。 -
是否考虑
meta viewport标签并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为false,在 Firefox 中不受支持。详细了解 移动仿真。 -
javaScriptEnabledboolean (可选)#是否在上下文中启用 JavaScript。默认为
true。了解更多关于 禁用 JavaScript。 -
指定用户区域设置,例如
en-GB,de-DE等。区域设置将影响navigator.language值、Accept-Language请求头值以及数字和日期格式规则。默认为系统默认区域设置。有关仿真的更多信息,请参阅我们的 仿真指南。 -
已弃用
日志记录器收到的日志不完整。请改用跟踪。
Playwright 日志记录的日志接收器。
-
是否模拟网络离线。默认为
false。了解更多关于 网络模拟。 -
permissionsArray<string> (可选)#要授予此上下文中所有页面的权限列表。有关详细信息,请参阅 browserContext.grantPermissions()。默认为无。
-
-
serverstring用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128或socks5://myproxy.com:3128。简写形式myproxy.com:3128被视为 HTTP 代理。 -
bypassstring (可选)可选的逗号分隔的域以绕过代理,例如
".com, chromium.org, .domain.com"。 -
usernamestring (可选)如果 HTTP 代理需要身份验证,则使用的可选用户名。
-
passwordstring (可选)如果 HTTP 代理需要身份验证,则使用的可选密码。
网络代理设置。
-
-
-
omitContentboolean (可选)控制是否从 HAR 中省略请求内容的设置。默认为
false。已弃用,请改用content策略。 -
content"omit" | "embed" | "attach" (可选)可选设置,用于控制资源内容管理。如果指定
omit,则不保留内容。如果指定attach,则资源将作为单独的文件或 ZIP 存档中的条目进行持久化。如果指定embed,则内容将内联存储在 HAR 文件中,符合 HAR 规范。对于.zip输出文件,默认为attach;对于所有其他文件扩展名,默认为embed。 -
pathstring将 HAR 文件写入的文件系统路径。如果文件名以
.zip结尾,则默认使用content: 'attach'。 -
mode"full" | "minimal" (可选)设置为
minimal时,仅记录从 HAR 路由所需的信息。这会省略 HAR 的大小、时间、页面、Cookie、安全性和其他类型的 HAR 信息,这些信息在从 HAR 重放时不使用。默认为full。 -
urlFilterstring | RegExp (可选)用于过滤存储在 HAR 中的请求的 glob 或正则表达式模式。当通过上下文选项提供了 baseURL 并且传入的 URL 是一个路径时,它将通过
new URL()构造函数进行合并。默认为无。
启用对所有页面到
recordHar.path文件的 HAR 记录。如果未指定,则不记录 HAR。请确保在保存 HAR 之前 await browserContext.close()。 -
-
-
dirstring用于存放视频的目录路径。
-
sizeObject (可选)已录制视频的可选尺寸。如果未指定,则尺寸将等于
viewport,并缩小以适应 800x800。如果未明确配置viewport,则视频尺寸默认为 800x450。每页的实际图像在必要时将缩小以适应指定的尺寸。
启用将所有页面视频录制到
recordVideo.dir目录。如果未指定,则不录制视频。请确保在调用browserContext.close()之前等待,以确保视频得以保存。 -
-
reducedMotionnull | "reduce" | "no-preference" (可选)#模拟
'prefers-reduced-motion'媒体特性,支持的值为'reduce'、'no-preference'。有关更多详细信息,请参阅page.emulateMedia()。传递null会将模拟重置为系统默认设置。默认为'no-preference'。 -
模拟通过
window.screen在网页中可用的固定窗口屏幕尺寸。仅在使用viewport设置时使用。 -
serviceWorkers"allow" | "block" (可选)#是否允许站点注册 Service Workers。默认为
'allow'。'allow': Service Workers 可以注册。'block': Playwright 将阻止所有 Service Workers 的注册。
-
将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。
-
如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,所有对隐式单个目标 DOM 元素的选择器的操作,当有多个元素匹配选择器时,都将抛出错误。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为
false。有关严格模式的详细信息,请参阅Locator。 -
等待浏览器实例启动的最大时间(毫秒)。默认为
30000(30 秒)。传递0禁用超时。 -
更改上下文的时区。支持的时区 ID 列表,请参阅ICU 的 metaZones.txt。默认为系统时区。
-
如果指定,追踪将保存到此目录。
-
此上下文中使用的特定用户代理。
-
已弃用
请使用recordVideo。
-
已弃用
请使用recordVideo。
-
为每个页面模拟一致的视口。默认为 1280x720 视口。使用
null禁用一致的视口模拟。了解更多关于 视口模拟。注意null值会取消默认预设,使视口取决于操作系统定义的主机窗口大小。这会使测试的执行不确定。
-
返回
launchServer
v1.9 之前添加返回浏览器应用程序实例。您可以通过browserType.connect()连接到它,这需要主/次客户端/服务器版本匹配(1.2.3 → 与 1.2.x 兼容)。
用法
启动客户端可以连接的浏览器服务器。启动浏览器可执行文件并在之后连接它的示例
const { chromium } = require('playwright'); // Or 'webkit' or 'firefox'.
(async () => {
const browserServer = await chromium.launchServer();
const wsEndpoint = browserServer.wsEndpoint();
// Use web socket endpoint later to establish a connection.
const browser = await chromium.connect(wsEndpoint);
// Close browser instance.
await browserServer.close();
})();
参数
optionsObject (可选)-
警告
使用自定义浏览器参数需自行承担风险,因为其中一些参数可能会破坏 Playwright 的功能。
要传递给浏览器实例的附加参数。Chromium 标志列表可在 此处 找到。
-
浏览器分发渠道。
使用 "chromium" 选择加入新的无头模式。
使用 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", 或 "msedge-canary" 来使用品牌化的 Google Chrome 和 Microsoft Edge。
-
启用 Chromium 沙盒。默认为
false。 -
如果指定,接受的下载将下载到此目录。否则,将创建临时目录并在浏览器关闭时删除。在这两种情况下,下载将在创建它们的浏览器上下文关闭时删除。
-
用于运行的浏览器可执行文件路径,而不是捆绑的浏览器。如果executablePath是相对路径,则它相对于当前工作目录进行解析。请注意,Playwright 仅支持捆绑的 Chromium、Firefox 或 WebKit,请自行承担风险使用。
-
firefoxUserPrefsObject<string, string | number | boolean> (可选)#Firefox 用户偏好设置。有关 Firefox 用户偏好设置的更多信息,请访问
about:config。您还可以通过
PLAYWRIGHT_FIREFOX_POLICIES_JSON环境变量提供自定义policies.json文件 的路径。 -
在收到 SIGHUP 信号时关闭浏览器进程。默认为
true。 -
在收到 Ctrl-C 信号时关闭浏览器进程。默认为
true。 -
在收到 SIGTERM 信号时关闭浏览器进程。默认为
true。 -
用于 WebSocket 的主机。它是可选的,如果省略,服务器将在 IPv6 可用时接受来自未指定 IPv6 地址 (::) 的连接,否则接受来自未指定 IPv4 地址 (0.0.0.0) 的连接。考虑使用特定接口进行加固。
-
ignoreDefaultArgsboolean | Array<string> (可选)#如果设置为
true,Playwright 不会传递自己的配置参数,只使用 args 中的参数。如果给出数组,则过滤掉给定的默认参数。这是一个危险的选项,请谨慎使用。默认为false。 -
已弃用
日志记录器收到的日志不完整。请改用跟踪。
Playwright 日志记录的日志接收器。
-
WebSocket 使用的端口。默认为 0,表示选择任何可用端口。
-
-
serverstring用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128或socks5://myproxy.com:3128。简写形式myproxy.com:3128被视为 HTTP 代理。 -
bypassstring (可选)可选的逗号分隔的域以绕过代理,例如
".com, chromium.org, .domain.com"。 -
usernamestring (可选)如果 HTTP 代理需要身份验证,则使用的可选用户名。
-
passwordstring (可选)如果 HTTP 代理需要身份验证,则使用的可选密码。
网络代理设置。
-
-
等待浏览器实例启动的最大时间(毫秒)。默认为
30000(30 秒)。传递0禁用超时。 -
如果指定,追踪将保存到此目录。
-
服务浏览器服务器的路径。为了安全起见,此选项默认为一个不可猜测的字符串。
警告任何知道
wsPath的进程或网页(包括在 Playwright 中运行的进程或网页)都可以控制操作系统用户。出于这个原因,在使用此选项时,您应该使用一个不可猜测的令牌。
-
返回
名称
v1.9 之前添加返回浏览器名称。例如:'chromium'、'webkit' 或 'firefox'。
用法
browserType.name();
返回