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