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();
})();
方法
连接
Added before 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
获取此端点。 -
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>"
用于暴露本地主机网络。"*.test.internal-domain,*.staging.internal-domain,<loopback>"
用于暴露测试/预发布部署环境和本地主机。
- 主机名模式,例如:
-
headers
Object<string, string> (可选) 添加于: v1.11#用于随WebSocket连接请求发送的额外HTTP头信息。可选。
-
logger
Logger (可选) 添加于: v1.14#用于Playwright日志记录的日志接收器。可选。
-
slowMo
number (可选) 添加于: v1.10#通过指定的毫秒数减慢Playwright操作速度。有助于观察操作过程。默认为0。
-
timeout
number (可选) 添加于: v1.10#等待连接建立的最长时间,以毫秒为单位。默认为
0
(无超时)。
-
返回
connectOverCDP
Added in: v1.9此方法使用Chrome开发者工具协议将Playwright附加到现有的浏览器实例上。
默认浏览器上下文可以通过browser.contexts()访问。
通过Chrome DevTools协议连接仅支持基于Chromium的浏览器。
此连接的保真度明显低于通过browserType.connect()建立的Playwright协议连接。如果您遇到问题或尝试使用高级功能,您可能需要使用browserType.connect()。
用法
const browser = await playwright.chromium.connectOverCDP('http://localhost:9222');
const defaultContext = browser.contexts()[0];
const page = defaultContext.pages()[0];
参数
-
endpointURL
string 添加于: v1.11#用于连接的CDP websocket端点或http URL。例如
http://localhost:9222/
或ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4
。 -
options
Object (可选)-
endpointURL
string (可选) 添加于: v1.14#已弃用,请改用第一个参数。可选。
-
headers
Object<string, string> (可选) 添加于: v1.11#随连接请求一起发送的额外HTTP头信息。可选。
-
logger
Logger (可选) 添加于: v1.14#用于Playwright日志记录的日志接收器。可选。
-
slowMo
number (可选) 添加于: v1.11#将Playwright操作速度减慢指定的毫秒数。有助于观察操作过程。默认为0。
-
timeout
number (可选) 添加于: v1.11#等待连接建立的最大毫秒数。默认为
30000
(30秒)。传递0
表示禁用超时。
-
返回
executablePath
Added before v1.9Playwright预期查找捆绑浏览器可执行文件的路径。
用法
browserType.executablePath();
返回
启动
Added before 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 (optional)-
警告
使用自定义浏览器参数需自行承担风险,因为其中某些参数可能会破坏Playwright的功能。
传递给浏览器实例的额外参数。Chromium标志列表可以在这里找到。
-
浏览器发行渠道。
使用"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
Object<string, string | number | boolean> (可选)#指定对浏览器可见的环境变量。默认为
process.env
。 -
要运行的浏览器可执行文件路径,用于替代捆绑的浏览器。如果executablePath是相对路径,则会相对于当前工作目录进行解析。请注意,Playwright仅适用于捆绑的Chromium、Firefox或WebKit,使用时需自行承担风险。
-
firefoxUserPrefs
Object<string, string | number | boolean> (可选)#Firefox用户首选项。了解更多关于Firefox用户首选项的信息,请访问
about:config
。 -
在SIGHUP信号时关闭浏览器进程。默认为
true
。 -
在Ctrl-C时关闭浏览器进程。默认为
true
。 -
handleSIGTERM
boolean (optional)#在SIGTERM信号时关闭浏览器进程。默认为
true
。 -
是否以无头模式运行浏览器。关于Chromium和Firefox的更多细节。默认为
true
,除非devtools选项为true
。 -
ignoreDefaultArgs
boolean | Array<string> (可选)#如果设为
true
,Playwright不会传递自身的配置参数,仅使用args中的参数。如果传入数组,则会过滤掉指定的默认参数。此为危险选项,请谨慎使用。默认为false
。 -
用于Playwright日志记录的日志接收器。
-
-
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
Added before v1.9返回持久化的浏览器上下文实例。
启动使用位于userDataDir的持久存储的浏览器,并返回唯一的上下文。关闭此上下文将自动关闭浏览器。
用法
await browserType.launchPersistentContext(userDataDir);
await browserType.launchPersistentContext(userDataDir, options);
参数
-
用户数据目录路径,用于存储浏览器会话数据,如cookies和本地存储。更多详情请参考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:
http://localhost:3000
and navigating to/bar.html
results inhttp://localhost:3000/bar.html
- baseURL:
http://localhost:3000/foo/
and navigating to./bar.html
results inhttp://localhost:3000/foo/bar.html
- baseURL:
http://localhost:3000/foo
(without trailing slash) and navigating to./bar.html
results inhttp://localhost:3000/bar.html
- baseURL:
-
切换绕过页面的内容安全策略。默认为
false
。 -
浏览器发行渠道。
使用"chromium"可选择加入新的无头模式。
使用"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
属性应提供与证书适用的请求来源完全匹配的值。note在macOS上使用WebKit时,访问
localhost
将无法获取客户端证书。您可以通过将localhost
替换为local.playwright
来解决此问题。 -
-
colorScheme
null | "light" | "dark" | "no-preference" (可选)#模拟prefers-colors-scheme媒体特性,支持的值有
'light'
和'dark'
。更多详情请参阅page.emulateMedia()。传入null
会将模拟重置为系统默认值。默认为'light'
。 -
contrast
null | "no-preference" | "more" (可选)#模拟
'prefers-contrast'
媒体特性,支持的值为'no-preference'
、'more'
。详情请参阅page.emulateMedia()。传入null
会将模拟重置为系统默认值。默认为'no-preference'
。 -
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用户偏好设置。了解更多关于Firefox用户偏好的信息,请访问
about:config
。 -
forcedColors
null | "active" | "none" (可选)#模拟
'forced-colors'
媒体特性,支持的值为'active'
、'none'
。详情请参阅page.emulateMedia()。传入null
会将模拟重置为系统默认值。默认为'none'
。 -
在SIGHUP信号时关闭浏览器进程。默认为
true
。 -
在Ctrl-C时关闭浏览器进程。默认为
true
。 -
handleSIGTERM
boolean (optional)#在SIGTERM信号时关闭浏览器进程。默认为
true
。 -
指定视口是否支持触摸事件。默认为false。了解更多关于mobile emulation的信息。
-
是否以无头模式运行浏览器。关于Chromium和Firefox的更多细节。默认为
true
,除非devtools选项为true
。 -
-
username
string -
password
string -
origin
string (可选)限制在特定来源(scheme://host:port)上发送HTTP凭据。
-
send
"unauthorized" | "always" (可选)此选项仅适用于从对应APIRequestContext发送的请求,不会影响从浏览器发送的请求。
'always'
- 每个API请求都会附带包含基本认证凭据的Authorization
头部。'unauthorized
- 仅当收到带有WWW-Authenticate
头部的401(未授权)响应时才发送凭据。默认为'unauthorized'
。
HTTP认证的凭据。如果未指定来源,则在收到未经授权的响应时,用户名和密码将被发送到任何服务器。
-
-
ignoreDefaultArgs
boolean | Array<string> (可选)#如果设为
true
,Playwright不会传递自身的配置参数,仅使用args中的参数。如果传入数组,则会过滤掉指定的默认参数。此为危险选项,请谨慎使用。默认为false
。 -
ignoreHTTPSErrors
boolean (可选)#发送网络请求时是否忽略HTTPS错误。默认为
false
。 -
是否考虑
meta viewport
标签并启用触摸事件。isMobile是设备属性的一部分,因此实际上不需要手动设置。默认为false
且在Firefox中不受支持。了解更多关于mobile emulation的信息。 -
javaScriptEnabled
boolean (可选)#是否在上下文中启用JavaScript。默认为
true
。了解更多关于禁用JavaScript的信息。 -
指定用户区域设置,例如
en-GB
,de-DE
等。区域设置会影响navigator.language
值、Accept-Language
请求头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的模拟指南中了解更多关于模拟的信息。 -
用于Playwright日志记录的日志接收器。
-
是否模拟网络离线状态。默认为
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路由所必需的信息。这会省略大小、时间、页面、cookies、安全和其他类型的HAR信息,这些信息在从HAR回放时不会被使用。默认为full
。 -
urlFilter
string | RegExp (可选)用于过滤存储在HAR中的请求的全局模式或正则表达式模式。当通过上下文选项提供了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 workers。默认为
'allow'
。'allow'
: 可以注册Service Workers。'block'
: Playwright 将阻止所有 Service Workers 的注册。
-
将Playwright操作速度减慢指定的毫秒数。这样您就可以看清发生了什么,非常实用。
-
如果设置为true,将为此上下文启用严格选择器模式。在严格选择器模式下,所有针对选择器的操作如果匹配到多个DOM元素时都会抛出异常。此选项不会影响任何Locator API(Locator始终是严格的)。默认为
false
。有关严格模式的更多信息,请参阅Locator。 -
等待浏览器实例启动的最大毫秒数。默认为
30000
(30秒)。传入0
表示禁用超时。 -
更改上下文的时区。支持的时区ID列表请参见ICU's metaZones.txt。默认为系统时区。
-
如果指定此参数,跟踪记录将保存到此目录中。
-
在此上下文中使用的特定用户代理。
-
Deprecated
请改用recordVideo。
-
已弃用
请改用 recordVideo。
-
为每个页面模拟一致的视口。默认视口尺寸为1280x720。使用
null
可禁用一致的视口模拟。了解更多关于视口模拟的信息。notenull
值表示不使用默认预设,使视口大小取决于操作系统定义的主机窗口尺寸。这会导致测试执行变得非确定性。
-
返回
launchServer
Added before 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 (optional)-
警告
使用自定义浏览器参数需自行承担风险,因为其中某些参数可能会破坏Playwright的功能。
传递给浏览器实例的额外参数。Chromium标志列表可以在这里找到。
-
浏览器发行渠道。
使用"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
Object<string, string | number | boolean> (可选)#指定对浏览器可见的环境变量。默认为
process.env
。 -
要运行的浏览器可执行文件路径,用于替代捆绑的浏览器。如果executablePath是相对路径,则会相对于当前工作目录进行解析。请注意,Playwright仅适用于捆绑的Chromium、Firefox或WebKit,使用时需自行承担风险。
-
firefoxUserPrefs
Object<string, string | number | boolean> (可选)#Firefox用户首选项。了解更多关于Firefox用户首选项的信息,请访问
about:config
。 -
在SIGHUP信号时关闭浏览器进程。默认为
true
。 -
在Ctrl-C时关闭浏览器进程。默认为
true
。 -
handleSIGTERM
boolean (optional)#在SIGTERM信号时关闭浏览器进程。默认为
true
。 -
是否以无头模式运行浏览器。关于Chromium和Firefox的更多细节。默认为
true
,除非devtools选项为true
。 -
用于WebSocket的主机地址。该参数是可选的,如果省略,服务器将在IPv6可用时接受未指定的IPv6地址(::)连接,否则接受未指定的IPv4地址(0.0.0.0)连接。建议通过选择特定网络接口来加强安全性。
-
ignoreDefaultArgs
boolean | Array<string> (可选)#如果设为
true
,Playwright不会传递自身的配置参数,仅使用args中的参数。如果传入数组,则会过滤掉指定的默认参数。此为危险选项,请谨慎使用。默认为false
。 -
用于Playwright日志记录的日志接收器。
-
用于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
string (可选) 添加于: v1.15#浏览器服务器监听的路径。出于安全考虑,默认值为不可猜测的随机字符串。
警告任何知晓
wsPath
的进程或网页(包括在Playwright中运行的)都可能控制操作系统用户。因此,使用此选项时应设置不可猜测的令牌。
-
返回
名称
Added before v1.9返回浏览器名称。例如:'chromium'
、'webkit'
或 'firefox'
。
用法
browserType.name();
返回