Browser
浏览器是通过 BrowserType.LaunchAsync() 创建的。使用 Browser 创建 Page 的示例
using Microsoft.Playwright;
using var playwright = await Playwright.CreateAsync();
var firefox = playwright.Firefox;
var browser = await firefox.LaunchAsync(new() { Headless = false });
var page = await browser.NewPageAsync();
await page.GotoAsync("https://www.bing.com");
await browser.CloseAsync();
方法
BrowserType
添加于:v1.23获取浏览器所属的浏览器类型(chromium、firefox 或 webkit)。
用法
Browser.BrowserType
返回
CloseAsync
v1.9 之前添加如果此浏览器是使用 BrowserType.LaunchAsync() 获取的,则关闭浏览器及其所有页面(如果已打开)。
如果此浏览器已连接,则清除属于此浏览器的所有已创建的上下文并断开与浏览器服务器的连接。
这类似于强制退出浏览器。要优雅地关闭页面并确保收到页面关闭事件,请在调用 Browser.CloseAsync() **之前**,对您之前使用 Browser.NewContextAsync() 显式创建的任何 BrowserContext 实例调用 BrowserContext.CloseAsync()。
Browser 对象本身被认为是已释放的,不能再使用。
用法
await Browser.CloseAsync(options);
参数
返回
Contexts
v1.9 之前添加返回所有打开的浏览器上下文的数组。在新建的浏览器中,这将返回零个浏览器上下文。
用法
using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Webkit.LaunchAsync();
System.Console.WriteLine(browser.Contexts.Count); // prints "0"
var context = await browser.NewContextAsync();
System.Console.WriteLine(browser.Contexts.Count); // prints "1"
返回
IsConnected
v1.9 之前添加指示浏览器是否已连接。
用法
Browser.IsConnected
返回
NewBrowserCDPSessionAsync
添加于:v1.11CDP 会话仅在基于 Chromium 的浏览器上受支持。
返回新创建的浏览器会话。
用法
await Browser.NewBrowserCDPSessionAsync();
返回
NewContextAsync
v1.9 之前添加创建一个新的浏览器上下文。它不会与其他浏览器上下文共享 cookie/缓存。
如果直接使用此方法创建 BrowserContext,最佳实践是在代码完成 BrowserContext 的使用后,以及在调用 Browser.CloseAsync() 之前,通过 BrowserContext.CloseAsync() 显式关闭返回的上下文。这将确保 context
优雅关闭,并且所有工件(如 HAR 文件和视频)都被完全刷新和保存。
用法
using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Firefox.LaunchAsync();
// Create a new incognito browser context.
var context = await browser.NewContextAsync();
// Create a new page in a pristine context.
var page = await context.NewPageAsync(); ;
await page.GotoAsync("https://www.bing.com");
// Gracefully close up everything
await context.CloseAsync();
await browser.CloseAsync();
参数
options
BrowserNewContextOptions?
(可选)-
是否自动下载所有附件。默认为
true
,即接受所有下载。 -
当使用 Page.GotoAsync()、Page.RouteAsync()、Page.WaitForURLAsync()、Page.RunAndWaitForRequestAsync() 或 Page.RunAndWaitForResponseAsync() 时,它会通过使用
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
。 -
ClientCertificates
IEnumerable?<ClientCertificates> (可选)添加于: 1.46#-
Origin
string证书有效的精确源。源包括
https
协议、主机名和可选的端口。 -
CertPath
string? (可选)PEM 格式证书文件的路径。
-
Cert
byte[]? (可选)PEM 格式证书的直接值。
-
KeyPath
string? (可选)PEM 格式私钥文件的路径。
-
Key
byte[]? (可选)PEM 格式私钥的直接值。
-
PfxPath
string? (可选)PFX 或 PKCS12 编码的私钥和证书链文件的路径。
-
Pfx
byte[]? (可选)PFX 或 PKCS12 编码的私钥和证书链的直接值。
-
Passphrase
string? (可选)私钥(PEM 或 PFX)的密码。
TLS 客户端认证允许服务器请求并验证客户端证书。
详情
要使用的客户端证书数组。每个证书对象必须同时具有 `certPath` 和 `keyPath`,或单个 `pfxPath`,或其相应的直接值等价物(`cert` 和 `key`,或 `pfx`)。如果证书已加密,则可选提供 `passphrase` 属性。`origin` 属性应提供与证书有效的请求源完全匹配的值。
客户端证书认证仅在至少提供一个客户端证书时才有效。如果您想拒绝服务器发送的所有客户端证书,您需要提供一个 `origin` 与您计划访问的任何域都不匹配的客户端证书。
注意在 macOS 上使用 WebKit 时,访问
localhost
将不会选取客户端证书。您可以通过将localhost
替换为local.playwright
来使其工作。 -
-
ColorScheme
enum ColorScheme { Light, Dark, NoPreference, Null }?
(可选)#模拟 prefers-colors-scheme 媒体特性,支持的值为
'light'
和'dark'
。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'
将模拟重置为系统默认值。默认为'light'
。 -
Contrast
enum Contrast { NoPreference, More, Null }?
(可选)#模拟
'prefers-contrast'
媒体特性,支持的值为'no-preference'
、'more'
。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'
将模拟重置为系统默认值。默认为'no-preference'
。 -
DeviceScaleFactor
[float]? (可选)#指定设备缩放因子(可视为dpr)。默认为
1
。了解更多关于使用设备缩放因子模拟设备的信息。 -
ExtraHTTPHeaders
IDictionary?<string, string> (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
ForcedColors
enum ForcedColors { Active, None, Null }?
(可选)#模拟
'forced-colors'
媒体特性,支持的值为'active'
、'none'
。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'
将模拟重置为系统默认值。默认为'none'
。 -
Geolocation
Geolocation? (可选)#-
Latitude
[浮点数]纬度,介于 -90 和 90 之间。
-
Longitude
[浮点数]经度,介于 -180 和 180 之间。
-
Accuracy
[浮点数]? (可选)非负精度值。默认为
0
。
-
-
指定视口是否支持触摸事件。默认为 false。了解更多关于移动设备模拟的信息。
-
HttpCredentials
HttpCredentials? (可选)#-
Username
string -
Password
string -
Origin
string? (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
Send
enum HttpCredentialsSend { Unauthorized, Always }?
(可选)此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。
'always'
- 每次 API 请求都会发送带有基本身份验证凭据的Authorization
标头。'unauthorized'
- 仅当收到带有WWW-Authenticate
标头的 401(未授权)响应时才发送凭据。默认为'unauthorized'
。
HTTP 认证的凭据。如果未指定来源,则用户名和密码将在未经授权的响应时发送到任何服务器。
-
-
发送网络请求时是否忽略 HTTPS 错误。默认为
false
。 -
是否考虑
meta viewport
标签并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为false
,Firefox 不支持。了解更多关于移动设备模拟的信息。 -
是否在上下文中启用 JavaScript。默认为
true
。了解更多关于禁用 JavaScript 的信息。 -
指定用户区域设置,例如
en-GB
,de-DE
等。区域设置将影响navigator.language
值、Accept-Language
请求头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的模拟指南中了解更多关于模拟的信息。 -
是否模拟网络离线。默认为
false
。了解更多关于网络模拟的信息。 -
Permissions
IEnumerable?<string> (可选)#要授予此上下文中所有页面的权限列表。有关更多详细信息,请参阅 BrowserContext.GrantPermissionsAsync()。默认为无。
-
Proxy
Proxy? (可选)#-
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 代理需要身份验证,则使用的可选密码。
用于此上下文的网络代理设置。默认为无。
-
-
RecordHarContent
enum HarContentPolicy { Omit, Embed, Attach }?
(可选)#用于控制资源内容管理的设置(可选)。如果指定 `omit`,则内容不会持久化。如果指定 `attach`,则资源作为单独的文件持久化,并且所有这些文件都与 HAR 文件一起归档。默认为 `embed`,它根据 HAR 规范将内容内联存储在 HAR 文件中。
-
RecordHarMode
enum HarMode { Full, Minimal }?
(可选)#设置为
minimal
时,仅记录从 HAR 路由所需的信息。这会省略 HAR 的大小、时间、页面、Cookie、安全性和其他类型的 HAR 信息,这些信息在从 HAR 重放时不使用。默认为full
。 -
RecordHarOmitContent
bool? (可选)#控制是否从 HAR 中省略请求内容的可选设置。默认为
false
。 -
为所有页面启用 HAR 记录到文件系统上指定的 HAR 文件中。如果未指定,则不记录 HAR。请务必调用 BrowserContext.CloseAsync() 以保存 HAR 文件。
-
RecordHarUrlFilter|RecordHarUrlFilterRegex
string? | Regex? (可选)# -
启用所有页面录制视频到指定目录。如果未指定,则不录制视频。请务必调用 BrowserContext.CloseAsync() 以保存视频。
-
RecordVideoSize
RecordVideoSize? (可选)#录制视频的尺寸。如果未指定,大小将等于缩放后适合 800x800 的
viewport
。如果未明确配置viewport
,则视频大小默认为 800x450。每个页面的实际图像将根据需要缩小以适应指定的大小。 -
ReducedMotion
enum ReducedMotion { Reduce, NoPreference, Null }?
(可选)#模拟
'prefers-reduced-motion'
媒体特性,支持的值为'reduce'
、'no-preference'
。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'
将模拟重置为系统默认值。默认为'no-preference'
。 -
ScreenSize
ScreenSize? (可选)#通过
window.screen
模拟网页中一致的窗口屏幕尺寸。仅当设置了 ViewportSize 时才使用。 -
ServiceWorkers
enum ServiceWorkerPolicy { Allow, Block }?
(可选)#是否允许站点注册 Service Workers。默认为
'allow'
。'allow'
: Service Workers 可以注册。'block'
: Playwright 将阻止所有 Service Workers 的注册。
-
使用给定存储状态填充上下文。此选项可用于使用通过 BrowserContext.StorageStateAsync() 获取的登录信息初始化上下文。
-
StorageStatePath
string? (可选)添加于:v1.9#使用给定存储状态填充上下文。此选项可用于使用通过 BrowserContext.StorageStateAsync() 获取的登录信息初始化上下文。包含已保存存储状态的文件的路径。
-
如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,当有多个元素与选择器匹配时,所有涉及单个目标 DOM 元素的选择器操作都将抛出异常。此选项不影响任何 Locator API(Locators 始终是严格的)。默认为
false
。请参阅 Locator 以了解有关严格模式的更多信息。 -
更改上下文的时区。有关支持的时区 ID 列表,请参阅 ICU 的 metaZones.txt。默认为系统时区。
-
此上下文中使用的特定用户代理。
-
ViewportSize
ViewportSize? (可选)#为每个页面模拟一致的视口。默认为 1280x720 视口。使用
ViewportSize.NoViewport
禁用一致视口模拟。了解更多关于视口模拟的信息。注意ViewportSize.NoViewport
值选择退出默认预设,使视口取决于操作系统定义的主机窗口大小。这使得测试执行不确定。
-
返回
NewPageAsync
v1.9 之前添加在新的浏览器上下文中创建一个新页面。关闭此页面也会关闭上下文。
这是一个方便的 API,只应用于单页场景和短代码片段。生产代码和测试框架应显式创建 Browser.NewContextAsync(),然后创建 BrowserContext.NewPageAsync(),以控制其精确的生命周期。
用法
await Browser.NewPageAsync(options);
参数
options
BrowserNewPageOptions?
(可选)-
是否自动下载所有附件。默认为
true
,即接受所有下载。 -
当使用 Page.GotoAsync()、Page.RouteAsync()、Page.WaitForURLAsync()、Page.RunAndWaitForRequestAsync() 或 Page.RunAndWaitForResponseAsync() 时,它会通过使用
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
。 -
ClientCertificates
IEnumerable?<ClientCertificates> (可选)添加于: 1.46#-
Origin
string证书有效的精确源。源包括
https
协议、主机名和可选的端口。 -
CertPath
string? (可选)PEM 格式证书文件的路径。
-
Cert
byte[]? (可选)PEM 格式证书的直接值。
-
KeyPath
string? (可选)PEM 格式私钥文件的路径。
-
Key
byte[]? (可选)PEM 格式私钥的直接值。
-
PfxPath
string? (可选)PFX 或 PKCS12 编码的私钥和证书链文件的路径。
-
Pfx
byte[]? (可选)PFX 或 PKCS12 编码的私钥和证书链的直接值。
-
Passphrase
string? (可选)私钥(PEM 或 PFX)的密码。
TLS 客户端认证允许服务器请求并验证客户端证书。
详情
要使用的客户端证书数组。每个证书对象必须同时具有 `certPath` 和 `keyPath`,或单个 `pfxPath`,或其相应的直接值等价物(`cert` 和 `key`,或 `pfx`)。如果证书已加密,则可选提供 `passphrase` 属性。`origin` 属性应提供与证书有效的请求源完全匹配的值。
客户端证书认证仅在至少提供一个客户端证书时才有效。如果您想拒绝服务器发送的所有客户端证书,您需要提供一个 `origin` 与您计划访问的任何域都不匹配的客户端证书。
注意在 macOS 上使用 WebKit 时,访问
localhost
将不会选取客户端证书。您可以通过将localhost
替换为local.playwright
来使其工作。 -
-
ColorScheme
enum ColorScheme { Light, Dark, NoPreference, Null }?
(可选)#模拟 prefers-colors-scheme 媒体特性,支持的值为
'light'
和'dark'
。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'
将模拟重置为系统默认值。默认为'light'
。 -
Contrast
enum Contrast { NoPreference, More, Null }?
(可选)#模拟
'prefers-contrast'
媒体特性,支持的值为'no-preference'
、'more'
。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'
将模拟重置为系统默认值。默认为'no-preference'
。 -
DeviceScaleFactor
[float]? (可选)#指定设备缩放因子(可视为dpr)。默认为
1
。了解更多关于使用设备缩放因子模拟设备的信息。 -
ExtraHTTPHeaders
IDictionary?<string, string> (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
ForcedColors
enum ForcedColors { Active, None, Null }?
(可选)#模拟
'forced-colors'
媒体特性,支持的值为'active'
、'none'
。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'
将模拟重置为系统默认值。默认为'none'
。 -
Geolocation
Geolocation? (可选)#-
Latitude
[浮点数]纬度,介于 -90 和 90 之间。
-
Longitude
[浮点数]经度,介于 -180 和 180 之间。
-
Accuracy
[浮点数]? (可选)非负精度值。默认为
0
。
-
-
指定视口是否支持触摸事件。默认为 false。了解更多关于移动设备模拟的信息。
-
HttpCredentials
HttpCredentials? (可选)#-
Username
string -
Password
string -
Origin
string? (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
Send
enum HttpCredentialsSend { Unauthorized, Always }?
(可选)此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。
'always'
- 每次 API 请求都会发送带有基本身份验证凭据的Authorization
标头。'unauthorized'
- 仅当收到带有WWW-Authenticate
标头的 401(未授权)响应时才发送凭据。默认为'unauthorized'
。
HTTP 认证的凭据。如果未指定来源,则用户名和密码将在未经授权的响应时发送到任何服务器。
-
-
发送网络请求时是否忽略 HTTPS 错误。默认为
false
。 -
是否考虑
meta viewport
标签并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为false
,Firefox 不支持。了解更多关于移动设备模拟的信息。 -
是否在上下文中启用 JavaScript。默认为
true
。了解更多关于禁用 JavaScript 的信息。 -
指定用户区域设置,例如
en-GB
,de-DE
等。区域设置将影响navigator.language
值、Accept-Language
请求头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的模拟指南中了解更多关于模拟的信息。 -
是否模拟网络离线。默认为
false
。了解更多关于网络模拟的信息。 -
Permissions
IEnumerable?<string> (可选)#要授予此上下文中所有页面的权限列表。有关更多详细信息,请参阅 BrowserContext.GrantPermissionsAsync()。默认为无。
-
Proxy
Proxy? (可选)#-
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 代理需要身份验证,则使用的可选密码。
用于此上下文的网络代理设置。默认为无。
-
-
RecordHarContent
enum HarContentPolicy { Omit, Embed, Attach }?
(可选)#用于控制资源内容管理的设置(可选)。如果指定 `omit`,则内容不会持久化。如果指定 `attach`,则资源作为单独的文件持久化,并且所有这些文件都与 HAR 文件一起归档。默认为 `embed`,它根据 HAR 规范将内容内联存储在 HAR 文件中。
-
RecordHarMode
enum HarMode { Full, Minimal }?
(可选)#设置为
minimal
时,仅记录从 HAR 路由所需的信息。这会省略 HAR 的大小、时间、页面、Cookie、安全性和其他类型的 HAR 信息,这些信息在从 HAR 重放时不使用。默认为full
。 -
RecordHarOmitContent
bool? (可选)#控制是否从 HAR 中省略请求内容的可选设置。默认为
false
。 -
为所有页面启用 HAR 记录到文件系统上指定的 HAR 文件中。如果未指定,则不记录 HAR。请务必调用 BrowserContext.CloseAsync() 以保存 HAR 文件。
-
RecordHarUrlFilter|RecordHarUrlFilterRegex
string? | Regex? (可选)# -
启用所有页面录制视频到指定目录。如果未指定,则不录制视频。请务必调用 BrowserContext.CloseAsync() 以保存视频。
-
RecordVideoSize
RecordVideoSize? (可选)#录制视频的尺寸。如果未指定,大小将等于缩放后适合 800x800 的
viewport
。如果未明确配置viewport
,则视频大小默认为 800x450。每个页面的实际图像将根据需要缩小以适应指定的大小。 -
ReducedMotion
enum ReducedMotion { Reduce, NoPreference, Null }?
(可选)#模拟
'prefers-reduced-motion'
媒体特性,支持的值为'reduce'
、'no-preference'
。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'
将模拟重置为系统默认值。默认为'no-preference'
。 -
ScreenSize
ScreenSize? (可选)#通过
window.screen
模拟网页中一致的窗口屏幕尺寸。仅当设置了 ViewportSize 时才使用。 -
ServiceWorkers
enum ServiceWorkerPolicy { Allow, Block }?
(可选)#是否允许站点注册 Service Workers。默认为
'allow'
。'allow'
: Service Workers 可以注册。'block'
: Playwright 将阻止所有 Service Workers 的注册。
-
使用给定存储状态填充上下文。此选项可用于使用通过 BrowserContext.StorageStateAsync() 获取的登录信息初始化上下文。
-
StorageStatePath
string? (可选)添加于:v1.9#使用给定存储状态填充上下文。此选项可用于使用通过 BrowserContext.StorageStateAsync() 获取的登录信息初始化上下文。包含已保存存储状态的文件的路径。
-
如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,当有多个元素与选择器匹配时,所有涉及单个目标 DOM 元素的选择器操作都将抛出异常。此选项不影响任何 Locator API(Locators 始终是严格的)。默认为
false
。请参阅 Locator 以了解有关严格模式的更多信息。 -
更改上下文的时区。有关支持的时区 ID 列表,请参阅 ICU 的 metaZones.txt。默认为系统时区。
-
此上下文中使用的特定用户代理。
-
ViewportSize
ViewportSize? (可选)#为每个页面模拟一致的视口。默认为 1280x720 视口。使用
ViewportSize.NoViewport
禁用一致视口模拟。了解更多关于视口模拟的信息。注意ViewportSize.NoViewport
值选择退出默认预设,使视口取决于操作系统定义的主机窗口大小。这使得测试执行不确定。
-
返回
Version
v1.9 之前添加返回浏览器版本。
用法
Browser.Version
返回
事件
event Disconnected
v1.9 之前添加浏览器与浏览器应用程序断开连接时触发。这可能是由于以下原因之一:
- 浏览器应用程序已关闭或崩溃。
- 已调用 Browser.CloseAsync() 方法。
用法
Browser.Disconnected += async (_, browser) => {};
事件数据