浏览器类型
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` 启动的另一个浏览器时,主版本和次版本需要与客户端版本匹配(1.2.3 → 与 1.2.x 兼容)。
用法
await browserType.connect(wsEndpoint);
await browserType.connect(wsEndpoint, options);
参数
-
要连接到的浏览器 websocket 端点。
-
options
对象 (可选)-
exposeNetwork
字符串 (可选)在 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>"
暴露 localhost 网络。"*.test.internal-domain,*.staging.internal-domain,<loopback>"
暴露测试/暂存部署和 localhost。
-
headers
对象<字符串, 字符串> (可选)在 v1.11 中添加#要与 websocket 连接请求一起发送的附加 HTTP 标头。可选的。
-
Playwright 日志记录的记录器接收器。可选的。
-
将 Playwright 操作速度降低指定的毫秒数。这在您需要查看正在发生的事情时很有用。默认为 0。
-
以毫秒为单位的最大等待连接建立的时间。默认为 `0`(无超时)。
-
返回值
connectOverCDP
在 v1.9 中添加此方法使用 Chrome DevTools 协议将 Playwright 附加到现有浏览器实例。
默认浏览器上下文可以通过 browser.contexts() 访问。
通过 Chrome DevTools 协议连接仅受 Chromium 浏览器支持。
用法
const browser = await playwright.chromium.connectOverCDP('https://127.0.0.1:9222');
const defaultContext = browser.contexts()[0];
const page = defaultContext.pages()[0];
参数
-
要连接到的 CDP websocket 端点或 http url。例如 `https://127.0.0.1:9222/` 或 `ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4`。
-
options
对象 (可选)
返回值
可执行路径
在 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 浏览器,但它与捆绑的 Chromium 版本配合使用效果最佳。不能保证它能与任何其他版本一起使用。请谨慎使用 executablePath 选项。
如果首选 Google Chrome(而不是 Chromium),建议使用 Chrome Canary 或 开发频道 版本。
像 Google Chrome 和 Microsoft Edge 这样的标准浏览器适合需要专有媒体编解码器进行视频播放的测试。查看 这篇文章 以了解 Chromium 和 Chrome 之间的其他区别。 这篇文章 描述了适用于 Linux 用户的一些区别。
参数
options
对象 (可选)-
警告
请谨慎使用自定义浏览器参数,因为其中一些参数可能会破坏 Playwright 功能。
要传递给浏览器实例的附加参数。Chromium 标志列表可以在 此处 找到。
-
浏览器分发渠道。支持的值为 "chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev"、"msedge-canary"。详细了解如何使用 Google Chrome 和 Microsoft Edge。
-
启用 Chromium 沙箱。默认为 `false`。
-
已弃用
改用 调试工具。
Chromium 专用 是否为每个标签自动打开开发者工具面板。如果此选项为
true
,则 headless 选项将设置为false
。 -
如果指定,接受的下载将下载到此目录。否则,将创建临时目录,并在浏览器关闭时删除。在任何一种情况下,当创建它们的浏览器上下文关闭时,下载都会被删除。
-
env
对象<字符串, 字符串 | 数字 | 布尔值> (可选)#指定浏览器可见的环境变量。默认为
process.env
。 -
要运行的浏览器可执行文件的路径,而不是捆绑的路径。如果 executablePath 是一个相对路径,那么它将相对于当前工作目录解析。请注意,Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit,请自行承担风险使用。
-
firefoxUserPrefs
对象<字符串, 字符串 | 数字 | 布尔值> (可选)#Firefox 用户首选项。在
about:config
中了解有关 Firefox 用户首选项的更多信息。 -
在 SIGHUP 上关闭浏览器进程。默认为
true
。 -
在 Ctrl-C 上关闭浏览器进程。默认为
true
。 -
在 SIGTERM 上关闭浏览器进程。默认为
true
。 -
是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。默认为
true
,除非 devtools 选项为true
。 -
ignoreDefaultArgs
布尔值 | 数组<字符串> (可选)#如果为
true
,Playwright 不会传递自己的配置参数,而只使用来自 args 的参数。如果给出了一个数组,那么它会过滤掉给定的默认参数。危险选项;谨慎使用。默认为false
。 -
Playwright 日志的记录器接收器。
-
-
server
字符串将用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128
或socks5://myproxy.com:3128
。简短形式myproxy.com:3128
被认为是 HTTP 代理。 -
bypass
字符串 (可选)可选的逗号分隔的域,以绕过代理,例如
".com, chromium.org, .domain.com"
。 -
username
字符串 (可选)如果 HTTP 代理需要身份验证,则使用可选的用户名。
-
password
字符串 (可选)如果 HTTP 代理需要身份验证,则使用可选的密码。
网络代理设置。
-
-
将 Playwright 操作速度降低指定的毫秒数。这很有用,以便您可以看到正在发生的事情。
-
等待浏览器实例启动的最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。 -
如果指定,则跟踪将保存到此目录。
-
返回值
launchPersistentContext
在 v1.9 之前添加返回持久浏览器上下文实例。
启动使用位于 userDataDir 的持久存储的浏览器,并返回唯一上下文。关闭此上下文将自动关闭浏览器。
用法
await browserType.launchPersistentContext(userDataDir);
await browserType.launchPersistentContext(userDataDir, options);
参数
-
指向用户数据目录的路径,该目录存储浏览器会话数据,如 Cookie 和本地存储。有关 Chromium 和 Firefox 的更多详细信息。请注意,Chromium 的用户数据目录是
chrome://version
中看到的“配置文件路径”的父目录。传递空字符串以使用临时目录。 -
options
对象 (可选)-
是否自动下载所有附件。默认为
true
,所有下载都将被接受。 -
警告
请谨慎使用自定义浏览器参数,因为其中一些参数可能会破坏 Playwright 功能。
要传递给浏览器实例的附加参数。Chromium 标志列表可以在 此处 找到。
-
在使用 page.goto()、page.route()、page.waitForURL()、page.waitForRequest() 或 page.waitForResponse() 时,它会通过使用
URL()
构造函数构建相应的 URL 来考虑基本 URL。默认情况下未设置。示例- baseURL:
https://127.0.0.1:3000
并导航到/bar.html
会导致https://127.0.0.1:3000/bar.html
- baseURL:
https://127.0.0.1:3000/foo/
并导航到./bar.html
会导致https://127.0.0.1:3000/foo/bar.html
- baseURL:
https://127.0.0.1:3000/foo
(没有尾部斜杠)并导航到./bar.html
会导致https://127.0.0.1:3000/bar.html
- baseURL:
-
切换绕过页面的内容安全策略。默认为
false
。 -
浏览器分发渠道。支持的值为 "chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev"、"msedge-canary"。详细了解如何使用 Google Chrome 和 Microsoft Edge。
-
启用 Chromium 沙箱。默认为 `false`。
-
clientCertificates
数组<对象> (可选)新增于:1.46#-
origin
字符串证书有效的精确来源。来源包括
https
协议、主机名和可选端口。 -
certPath
字符串 (可选)包含证书的文件路径(PEM 格式)。
-
cert
缓冲区 (可选)证书的直接值,以 PEM 格式。
-
keyPath
字符串 (可选)包含 PEM 格式私钥的文件路径。
-
key
缓冲区 (可选)私钥的直接值,以 PEM 格式。
-
pfxPath
字符串 (可选)PFX 或 PKCS12 编码的私钥和证书链的路径。
-
pfx
缓冲区 (可选)PFX 或 PKCS12 编码的私钥和证书链的直接值。
-
passphrase
字符串 (可选)私钥(PEM 或 PFX)的密码。
TLS 客户端身份验证允许服务器请求客户端证书并对其进行验证。
详情
要使用的客户端证书数组。每个证书对象都必须同时具有
certPath
和keyPath
,或者单个pfxPath
,或者它们相应的直接值等价物 (cert
和key
,或pfx
)。可选地,如果证书已加密,则应提供passphrase
属性。应提供origin
属性,并与证书有效的请求来源完全匹配。注意在 macOS 上使用 WebKit 时,访问
localhost
不会拾取客户端证书。可以通过将localhost
替换为local.playwright
来使其正常工作。 -
-
colorScheme
空 | "light" | "dark" | "no-preference" (可选)#模拟
'prefers-colors-scheme'
媒体功能,支持的值为'light'
、'dark'
、'no-preference'
。有关更多详细信息,请参阅 page.emulateMedia()。传递null
会将模拟重置为系统默认值。默认为'light'
。 -
指定设备缩放比例 (可以理解为 dpr)。默认为
1
。详细了解 使用设备缩放比例模拟设备。 -
已弃用
改用 调试工具。
仅限 Chromium 是否为每个选项卡自动打开开发者工具面板。如果此选项为
true
,则 headless 选项将设置为false
。 -
如果指定,接受的下载将下载到此目录。否则,将创建临时目录,并在浏览器关闭时删除。在任何一种情况下,当创建它们的浏览器上下文关闭时,下载都会被删除。
-
env
对象<字符串, 字符串 | 数字 | 布尔值> (可选)#指定浏览器可见的环境变量。默认为
process.env
。 -
要运行的浏览器可执行文件的路径,而不是捆绑的可执行文件。如果 executablePath 是相对路径,则它将相对于当前工作目录解析。请注意,Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit,使用风险自负。
-
extraHTTPHeaders
对象<字符串, 字符串> (可选)#包含与每个请求一起发送的其他 HTTP 标头的对象。默认为无。
-
firefoxUserPrefs
对象<字符串, 字符串 | 数字 | 布尔值> (可选)添加于:v1.40#Firefox 用户首选项。在
about:config
中了解有关 Firefox 用户首选项的更多信息。 -
forcedColors
空 | "active" | "none" (可选)#模拟
'forced-colors'
媒体功能,支持的值为'active'
、'none'
。有关更多详细信息,请参阅 page.emulateMedia()。传递null
会将模拟重置为系统默认值。默认为'none'
。 -
在 SIGHUP 上关闭浏览器进程。默认为
true
。 -
在 Ctrl-C 上关闭浏览器进程。默认为
true
。 -
在 SIGTERM 上关闭浏览器进程。默认为
true
。 -
指定视窗是否支持触摸事件。默认为 false。详细了解 移动设备模拟。
-
是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。默认为
true
,除非 devtools 选项为true
。 -
-
username
字符串 -
password
字符串 -
origin
字符串 (可选)限制在特定来源 (scheme://host:port).
-
send
"unauthorized" | "always" (可选)此选项仅适用于从相应的 APIRequestContext 发送的请求,不会影响从浏览器发送的请求。
'always'
-Authorization
标头将使用基本身份验证凭据发送到每个 API 请求。'unauthorized
- 仅在收到带有WWW-Authenticate
标头的 401 (未授权) 响应时才会发送凭据。默认为'unauthorized'
。
用于 HTTP 身份验证 的凭据。如果没有指定来源,则在收到未授权的响应时,用户名和密码将发送到任何服务器。
-
-
ignoreDefaultArgs
布尔值 | 数组<字符串> (可选)#如果为
true
,Playwright 不会传递自己的配置参数,而仅使用 args 中的参数。如果给出一个数组,则会过滤掉给定的默认参数。危险选项;谨慎使用。默认为false
。 -
发送网络请求时是否忽略 HTTPS 错误。默认为
false
。 -
是否考虑
meta viewport
标签并启用触摸事件。isMobile是设备的一部分,因此您实际上不需要手动设置它。默认值为false
,并且在 Firefox 中不支持。了解有关移动模拟的更多信息。 -
是否在上下文中启用 JavaScript。默认为
true
。了解有关禁用 JavaScript的更多信息。 -
指定用户区域设置,例如
en-GB
、de-DE
等。区域设置将影响navigator.language
值、Accept-Language
请求标头值以及数字和日期格式规则。默认为系统默认区域设置。了解有关我们模拟指南中的模拟的更多信息。 -
Playwright 日志的记录器接收器。
-
是否模拟网络脱机。默认为
false
。了解有关网络模拟的更多信息。 -
要授予此上下文中的所有页面的权限列表。有关更多详细信息,请参阅browserContext.grantPermissions()。默认为无。
-
-
server
字符串将用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128
或socks5://myproxy.com:3128
。简短形式myproxy.com:3128
被认为是 HTTP 代理。 -
bypass
字符串 (可选)可选的逗号分隔的域,以绕过代理,例如
".com, chromium.org, .domain.com"
。 -
username
字符串 (可选)如果 HTTP 代理需要身份验证,则使用可选的用户名。
-
password
字符串 (可选)如果 HTTP 代理需要身份验证,则使用可选的密码。
网络代理设置。
-
-
-
omitContent
布尔值 (可选)可选设置,用于控制是否从 HAR 中省略请求内容。默认为
false
。已弃用,请使用content
策略代替。 -
content
"omit" | "embed" | "attach" (可选)可选设置,用于控制资源内容管理。如果指定了
omit
,则不会保留内容。如果指定了attach
,则资源将作为单独的文件或 ZIP 存档中的条目保留。如果指定了embed
,则内容将根据 HAR 规范内联存储在 HAR 文件中。对于.zip
输出文件,默认为attach
,对于所有其他文件扩展名,默认为embed
。 -
path
字符串文件系统上要写入 HAR 文件的路径。如果文件名以
.zip
结尾,则默认情况下使用content: 'attach'
。 -
mode
"full" | "minimal" (可选)设置为
minimal
时,仅记录从 HAR 进行路由所需的必要信息。这省略了大小、计时、页面、cookie、安全和其他类型的 HAR 信息,这些信息在从 HAR 播放时不会使用。默认为full
。 -
一个 glob 或正则表达式模式,用于过滤存储在 HAR 中的请求。当通过上下文选项提供了baseURL并且传递的 URL 是一个路径时,它会通过
new URL()
构造函数进行合并。默认为无。
为所有页面启用HAR录制到
recordHar.path
文件中。如果未指定,则不会记录 HAR。确保等待browserContext.close()以保存 HAR。 -
-
-
dir
字符串放置视频的目录的路径。
-
size
对象 (可选)录制视频的可选尺寸。如果未指定,则大小将等于
viewport
,缩放到适合 800x800。如果未明确配置viewport
,则视频大小默认为 800x450。如果需要,每个页面的实际图片将缩放到适合指定的尺寸。
为所有页面启用视频录制到
recordVideo.dir
目录中。如果未指定,则不会录制视频。确保等待browserContext.close()以保存视频。 -
-
reducedMotion
空 | "reduce" | "no-preference" (可选)#模拟
'prefers-reduced-motion'
媒体功能,支持的值为'reduce'
、'no-preference'
。有关更多详细信息,请参阅page.emulateMedia()。传递null
会将模拟重置为系统默认值。默认为'no-preference'
。 -
模拟通过
window.screen
在网页内部可用的始终如一的窗口屏幕大小。仅在viewport设置时使用。 -
serviceWorkers
"allow" | "block" (可选)#是否允许站点注册服务工作者。默认为
'allow'
。'allow'
: 可以注册服务工作者。'block'
: Playwright 将阻止所有服务工作者的注册。
-
将 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();
})();
参数
options
对象 (可选)-
警告
请谨慎使用自定义浏览器参数,因为其中一些参数可能会破坏 Playwright 功能。
要传递给浏览器实例的附加参数。Chromium 标志列表可以在 此处 找到。
-
浏览器分发渠道。支持的值为 "chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev"、"msedge-canary"。详细了解如何使用 Google Chrome 和 Microsoft Edge。
-
启用 Chromium 沙箱。默认为 `false`。
-
已弃用
改用 调试工具。
仅适用于 Chromium 是否为每个选项卡自动打开开发者工具面板。如果此选项为
true
,则 headless 选项将被设置为false
。 -
如果指定,接受的下载将下载到此目录。否则,将创建临时目录,并在浏览器关闭时删除。在任何一种情况下,当创建它们的浏览器上下文关闭时,下载都会被删除。
-
env
对象<字符串, 字符串 | 数字 | 布尔值> (可选)#指定浏览器可见的环境变量。默认为
process.env
。 -
运行浏览器的可执行文件路径,而不是捆绑的可执行文件。如果 executablePath 是相对路径,则它相对于当前工作目录解析。请注意,Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit,使用风险自负。
-
firefoxUserPrefs
对象<字符串, 字符串 | 数字 | 布尔值> (可选)#Firefox 用户首选项。在
about:config
中了解有关 Firefox 用户首选项的更多信息。 -
在 SIGHUP 上关闭浏览器进程。默认为
true
。 -
在 Ctrl-C 上关闭浏览器进程。默认为
true
。 -
在 SIGTERM 上关闭浏览器进程。默认为
true
。 -
是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。默认为
true
,除非 devtools 选项为true
。 -
用于 Web 套接字的主机。它是可选的,如果省略,服务器将接受连接到未指定的 IPv6 地址 (::)(如果 IPv6 可用),或未指定的 IPv4 地址 (0.0.0.0)(否则)。考虑通过选择特定接口来强化它。
-
ignoreDefaultArgs
布尔值 | 数组<字符串> (可选)#如果为
true
,Playwright 不会传递它自己的配置参数,只使用来自 args 的参数。如果给出数组,则会过滤掉给定的默认参数。危险选项;谨慎使用。默认为false
。 -
Playwright 日志的记录器接收器。
-
用于 Web 套接字的端口。默认为 0,它会选择任何可用的端口。
-
-
server
字符串将用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128
或socks5://myproxy.com:3128
。简短形式myproxy.com:3128
被认为是 HTTP 代理。 -
bypass
字符串 (可选)可选的逗号分隔的域,以绕过代理,例如
".com, chromium.org, .domain.com"
。 -
username
字符串 (可选)如果 HTTP 代理需要身份验证,则使用可选的用户名。
-
password
字符串 (可选)如果 HTTP 代理需要身份验证,则使用可选的密码。
网络代理设置。
-
-
等待浏览器实例启动的最大时间(毫秒)。默认为
30000
(30 秒)。传递0
以禁用超时。 -
如果指定,则跟踪将保存到此目录。
-
提供浏览器服务器的路径。出于安全考虑,这默认为不可猜测的字符串。
警告任何了解
wsPath
的进程或网页(包括在 Playwright 中运行的进程或网页)都可以控制 OS 用户。出于这个原因,在使用此选项时,应使用不可猜测的令牌。
-
返回值
name
在 v1.9 之前添加返回浏览器名称。例如:'chromium'
、'webkit'
或 'firefox'
。
用法
browserType.name();
返回值