Browser
浏览器是通过 browserType.launch() 创建的。这是一个使用 Browser 对象创建 Page 对象的示例
const { firefox } = require('playwright'); // Or 'chromium' or 'webkit'.
(async () => {
const browser = await firefox.launch();
const page = await browser.newPage();
await page.goto('https://example.com');
await browser.close();
})();
方法
browserType
添加于:v1.23获取浏览器所属的浏览器类型(chromium、firefox 或 webkit)。
用法
browser.browserType();
返回
close
v1.9 之前添加如果此浏览器是使用 browserType.launch() 获取的,则会关闭浏览器及其所有页面(如果之前打开了任何页面)。
如果此浏览器已连接,则清除属于此浏览器的所有已创建的上下文并断开与浏览器服务器的连接。
这类似于强制退出浏览器。为了优雅地关闭页面并确保收到页面关闭事件,请在调用 browser.close() 之前,对任何先前使用 browser.newContext() 显式创建的 BrowserContext 实例调用 browserContext.close()。
Browser 对象本身被视为已处理,不能再使用。
用法
await browser.close();
await browser.close(options);
参数
返回
contexts
v1.9 之前添加返回所有打开的浏览器上下文的数组。在新建的浏览器中,这将返回零个浏览器上下文。
用法
const browser = await pw.webkit.launch();
console.log(browser.contexts().length); // prints `0`
const context = await browser.newContext();
console.log(browser.contexts().length); // prints `1`
返回
isConnected
v1.9 之前添加指示浏览器是否已连接。
用法
browser.isConnected();
返回
newBrowserCDPSession
添加于:v1.11CDP 会话仅在基于 Chromium 的浏览器上受支持。
返回新创建的浏览器会话。
用法
await browser.newBrowserCDPSession();
返回
newContext
v1.9 之前添加创建一个新的浏览器上下文。它不会与其他浏览器上下文共享 cookie/缓存。
如果直接使用此方法创建 BrowserContext,最佳做法是在代码完成使用 BrowserContext 后,并在调用 browser.close() 之前,通过 browserContext.close() 显式关闭返回的上下文。这将确保 context 被优雅地关闭,并且任何工件(如 HAR 和视频)都被完全刷新和保存。
用法
(async () => {
const browser = await playwright.firefox.launch(); // Or 'chromium' or 'webkit'.
// Create a new incognito browser context.
const context = await browser.newContext();
// Create a new page in a pristine context.
const page = await context.newPage();
await page.goto('https://example.com');
// Gracefully close up everything
await context.close();
await browser.close();
})();
参数
optionsObject (可选)-
是否自动下载所有附件。默认为
true,即接受所有下载。 -
当使用 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。 -
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。了解更多关于 使用设备比例因子模拟设备。 -
extraHTTPHeadersObject<string, string> (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
forcedColorsnull | "active" | "none" (可选)#模拟
'forced-colors'媒体功能,支持的值为'active','none'。有关更多详细信息,请参阅 page.emulateMedia()。传递null会将仿真重置为系统默认值。默认为'none'。 -
指定视口是否支持触摸事件。默认为 false。了解更多关于 移动设备模拟。
-
-
usernamestring -
passwordstring -
originstring (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
send"unauthorized" | "always" (可选)此选项仅适用于来自相应 APIRequestContext 的请求,不会影响来自浏览器的请求。
'always'-Authorization头和基本身份验证凭据将与每个 API 请求一起发送。'unauthorized'- 仅在收到具有WWW-Authenticate头的 401(未经授权)响应时发送凭据。默认为'unauthorized'。
用于 HTTP 身份验证的凭据。如果未指定源,则在未经授权的响应时将用户名和密码发送到任何服务器。
-
-
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 的注册。
-
storageStatestring | Object (可选)#-
-
namestring -
valuestring -
domainstring域名和路径是必需的。要使 cookie 也适用于所有子域,请在域名前面加上一个点,例如:".example.com"
-
pathstring域名和路径是必需的
-
expiresnumberUnix 时间戳,单位为秒。
-
httpOnlyboolean -
secureboolean -
sameSite"Strict" | "Lax" | "None"sameSite 标志
为上下文设置的 Cookie
-
了解有关 存储状态和身份验证的更多信息。
使用给定的存储状态填充上下文。此选项可用于初始化上下文,使其包含通过 browserContext.storageState() 获取的登录信息。
-
-
如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,所有对隐式单个目标 DOM 元素的选择器的操作,当有多个元素匹配选择器时,都将抛出错误。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为
false。有关严格模式的详细信息,请参阅Locator。 -
更改上下文的时区。支持的时区 ID 列表,请参阅ICU 的 metaZones.txt。默认为系统时区。
-
此上下文中使用的特定用户代理。
-
已弃用
请改用 recordVideo。
-
已弃用
请改用 recordVideo。
-
为每个页面模拟一致的视口。默认为 1280x720 视口。使用
null禁用一致的视口模拟。了解更多关于 视口模拟。注意null值会取消默认预设,使视口取决于操作系统定义的主机窗口大小。这会使测试的执行不确定。
-
返回
newPage
v1.9 之前添加在新的浏览器上下文中创建一个新页面。关闭此页面也会关闭上下文。
这是一个便捷的 API,仅应用于单页场景和简短的代码片段。生产代码和测试框架应显式创建 browser.newContext(),然后是 browserContext.newPage(),以控制它们的精确生命周期。
用法
await browser.newPage();
await browser.newPage(options);
参数
optionsObject (可选)-
是否自动下载所有附件。默认为
true,即接受所有下载。 -
当使用 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。 -
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。了解更多关于 使用设备比例因子模拟设备。 -
extraHTTPHeadersObject<string, string> (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
forcedColorsnull | "active" | "none" (可选)#模拟
'forced-colors'媒体功能,支持的值为'active','none'。有关更多详细信息,请参阅 page.emulateMedia()。传递null会将仿真重置为系统默认值。默认为'none'。 -
指定视口是否支持触摸事件。默认为 false。了解更多关于 移动设备模拟。
-
-
usernamestring -
passwordstring -
originstring (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
send"unauthorized" | "always" (可选)此选项仅适用于来自相应 APIRequestContext 的请求,不会影响来自浏览器的请求。
'always'-Authorization头和基本身份验证凭据将与每个 API 请求一起发送。'unauthorized'- 仅在收到具有WWW-Authenticate头的 401(未经授权)响应时发送凭据。默认为'unauthorized'。
用于 HTTP 身份验证的凭据。如果未指定源,则在未经授权的响应时将用户名和密码发送到任何服务器。
-
-
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 的注册。
-
storageStatestring | Object (可选)#-
-
namestring -
valuestring -
domainstring域名和路径是必需的。要使 cookie 也适用于所有子域,请在域名前面加上一个点,例如:".example.com"
-
pathstring域名和路径是必需的
-
expiresnumberUnix 时间戳,单位为秒。
-
httpOnlyboolean -
secureboolean -
sameSite"Strict" | "Lax" | "None"sameSite 标志
为上下文设置的 Cookie
-
了解有关 存储状态和身份验证的更多信息。
使用给定的存储状态填充上下文。此选项可用于初始化上下文,使其包含通过 browserContext.storageState() 获取的登录信息。
-
-
如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,所有对隐式单个目标 DOM 元素的选择器的操作,当有多个元素匹配选择器时,都将抛出错误。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为
false。有关严格模式的详细信息,请参阅Locator。 -
更改上下文的时区。支持的时区 ID 列表,请参阅ICU 的 metaZones.txt。默认为系统时区。
-
此上下文中使用的特定用户代理。
-
已弃用
请改用 recordVideo。
-
已弃用
请改用 recordVideo。
-
为每个页面模拟一致的视口。默认为 1280x720 视口。使用
null禁用一致的视口模拟。了解更多关于 视口模拟。注意null值会取消默认预设,使视口取决于操作系统定义的主机窗口大小。这会使测试的执行不确定。
-
返回
removeAllListeners
添加于:v1.47删除给定类型的所有侦听器(如果未给定类型,则删除所有已注册的侦听器)。允许等待异步侦听器完成或忽略这些侦听器随后的错误。
用法
await browser.removeAllListeners();
await browser.removeAllListeners(type, options);
参数
typestring (可选)#optionsObject (可选)-
behavior"wait" | "ignoreErrors" | "default" (可选)#指定是否等待已经运行的监听器以及如果它们抛出错误该怎么做
'default'- 不等待当前监听器调用(如果有的话)完成,如果监听器抛出错误,可能会导致未处理的错误'wait'- 等待当前监听器调用(如果有的话)完成'ignoreErrors'- 不等待当前监听器调用(如果有的话)完成,监听器在移除后抛出的所有错误都将被静默捕获
-
返回
startTracing
添加于:v1.11此 API 控制 Chromium 跟踪,这是一个底层的 Chromium 特定的调试工具。控制 Playwright 跟踪 的 API 可以在 此处找到。
您可以使用 browser.startTracing() 和 browser.stopTracing() 来创建一个可在 Chrome 开发者工具性能面板中打开的跟踪文件。
用法
await browser.startTracing(page, { path: 'trace.json' });
await page.goto('https://www.google.com');
await browser.stopTracing();
参数
-
可选,如果指定,跟踪将包含给定页面的屏幕截图。
-
optionsObject (可选)
返回
stopTracing
添加于:v1.11此 API 控制 Chromium 跟踪,这是一个底层的 Chromium 特定的调试工具。控制 Playwright 跟踪 的 API 可以在 此处找到。
返回包含跟踪数据的缓冲区。
用法
await browser.stopTracing();
返回
version
v1.9 之前添加返回浏览器版本。
用法
browser.version();
返回
事件
on('disconnected')
v1.9 之前添加浏览器与浏览器应用程序断开连接时触发。这可能是由于以下原因之一:
- 浏览器应用程序已关闭或崩溃。
- 调用了 browser.close() 方法。
用法
browser.on('disconnected', data => {});
事件数据