Browser
通过 BrowserType.LaunchAsync() 创建 Browser。使用 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 对象将被视为已处理(disposed)且不能再使用。
用法
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();
参数
optionsBrowserNewContextOptions?(可选)-
是否自动下载所有附件。默认为
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。 -
ClientCertificatesIEnumerable?<ClientCertificates> (可选)添加于: 1.46#-
Originstring证书有效的精确源。源包括
https协议、主机名和可选的端口。 -
CertPathstring? (可选)PEM 格式证书文件的路径。
-
Certbyte[]? (可选)PEM 格式证书的直接值。
-
KeyPathstring? (可选)PEM 格式私钥文件的路径。
-
Keybyte[]? (可选)PEM 格式私钥的直接值。
-
PfxPathstring? (可选)PFX 或 PKCS12 编码的私钥和证书链文件的路径。
-
Pfxbyte[]? (可选)PFX 或 PKCS12 编码的私钥和证书链的直接值。
-
Passphrasestring? (可选)私钥(PEM 或 PFX)的密码。
TLS 客户端认证允许服务器请求并验证客户端证书。
详情
要使用的客户端证书数组。每个证书对象必须同时包含
certPath和keyPath,单个pfxPath,或其相应的直接值(cert和key,或pfx)。如果证书已加密,可以选择提供passphrase属性。origin属性应提供与证书有效的请求源的确切匹配。仅当提供至少一个客户端证书时,客户端证书身份验证才处于活动状态。如果您想拒绝服务器发送的所有客户端证书,您需要提供一个
origin与您计划访问的任何域都不匹配的客户端证书。注意在 macOS 上使用 WebKit 时,访问
localhost将不会选取客户端证书。您可以通过将localhost替换为local.playwright来使其工作。 -
-
ColorSchemeenum ColorScheme { Light, Dark, NoPreference, Null }?(可选)#模拟 prefers-colors-scheme 媒体特性,支持的值为
'light'和'dark'。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'会将模拟重置为系统默认值。默认为'light'。 -
Contrastenum Contrast { NoPreference, More, Null }?(可选)#模拟
'prefers-contrast'媒体特性,支持的值为'no-preference','more'。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'会将模拟重置为系统默认值。默认为'no-preference'。 -
DeviceScaleFactor[float]? (可选)#指定设备缩放因子(可视为 dpr)。默认为
1。了解有关使用设备缩放因子 模拟设备的更多信息。 -
ExtraHTTPHeadersIDictionary?<string, string> (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
ForcedColorsenum ForcedColors { Active, None, Null }?(可选)#模拟
'forced-colors'媒体特性,支持的值为'active','none'。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'会将模拟重置为系统默认值。默认为'none'。 -
GeolocationGeolocation? (可选)#-
Latitude[浮点数]纬度,介于 -90 和 90 之间。
-
Longitude[浮点数]经度,介于 -180 和 180 之间。
-
Accuracy[浮点数]? (可选)非负精度值。默认为
0。
-
-
指定视口是否支持触摸事件。默认为 false。了解有关 移动设备模拟的更多信息。
-
HttpCredentialsHttpCredentials? (可选)#-
Usernamestring -
Passwordstring -
Originstring? (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
Sendenum HttpCredentialsSend { Unauthorized, Always }?(可选)此选项仅适用于从相应 APIRequestContext 发送的请求,不影响从浏览器发送的请求。
'always'- 带有基本身份验证凭据的Authorization标头将随每个 API 请求发送。'unauthorized- 仅在收到带有WWW-Authenticate标头的 401 (Unauthorized) 响应时才发送凭据。默认为'unauthorized'。
用于 HTTP 身份验证的凭据。如果未指定源,则在未经授权的响应时将用户名和密码发送到任何服务器。
-
-
发送网络请求时是否忽略 HTTPS 错误。默认为
false。 -
是否考虑
meta viewport标签并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为false,Firefox 不支持此选项。了解有关 移动设备模拟的更多信息。 -
是否在上下文中启用 JavaScript。默认为
true。了解有关 禁用 JavaScript 的更多信息。 -
指定用户区域设置,例如
en-GB,de-DE等。区域设置会影响navigator.language的值、Accept-Language请求头的值以及数字和日期格式化规则。默认为系统默认区域设置。了解有关我们模拟指南中模拟的更多信息。 -
是否模拟网络离线状态。默认为
false。了解有关 网络模拟的更多信息。 -
PermissionsIEnumerable?<string> (可选)#要授予此上下文中所有页面的权限列表。有关更多详细信息,请参阅 BrowserContext.GrantPermissionsAsync()。默认为无。
-
ProxyProxy? (可选)#-
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 代理需要身份验证,则使用的可选密码。
用于此上下文的网络代理设置。默认为无。
-
-
RecordHarContentenum HarContentPolicy { Omit, Embed, Attach }?(可选)#可选设置,用于控制资源内容管理。如果指定了
omit,则不持久化内容。如果指定了attach,则资源将作为单独的文件持久化,并且所有这些文件将与 HAR 文件一起存档。默认为embed,它将内容内联存储在 HAR 文件中,符合 HAR 规范。 -
RecordHarModeenum HarMode { Full, Minimal }?(可选)#设置为
minimal时,仅记录从 HAR 路由所需的信息。这会省略 HAR 的大小、时间、页面、Cookie、安全性和其他类型的 HAR 信息,这些信息在从 HAR 重放时不使用。默认为full。 -
RecordHarOmitContentbool? (可选)#控制是否从 HAR 中省略请求内容的可选设置。默认为
false。 -
在文件系统中为所有页面启用 HAR 记录到指定的 HAR 文件中。如果未指定,则不记录 HAR。请确保调用 BrowserContext.CloseAsync() 以便保存 HAR。
-
RecordHarUrlFilter|RecordHarUrlFilterRegexstring? | Regex? (可选)# -
启用到指定目录中所有页面的视频录制。如果未指定,则不录制视频。请确保调用 BrowserContext.CloseAsync() 以便保存视频。
-
RecordVideoSizeRecordVideoSize? (可选)#录制视频的尺寸。如果未指定,尺寸将等于
viewport按比例缩小以适应 800x800。如果未明确配置viewport,视频尺寸默认为 800x450。如果需要,每个页面的实际图像将按比例缩小以适应指定的尺寸。 -
ReducedMotionenum ReducedMotion { Reduce, NoPreference, Null }?(可选)#模拟
'prefers-reduced-motion'媒体特性,支持的值为'reduce','no-preference'。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'会将模拟重置为系统默认值。默认为'no-preference'。 -
ScreenSizeScreenSize? (可选)#模拟在 Web 页面中可通过
window.screen访问的统一窗口屏幕大小。仅在设置了 ViewportSize 时使用。 -
ServiceWorkersenum ServiceWorkerPolicy { Allow, Block }?(可选)#是否允许站点注册 Service Workers。默认为
'allow'。'allow': Service Workers 可以注册。'block': Playwright 将阻止所有 Service Workers 的注册。
-
使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.StorageStateAsync() 获取的登录信息来初始化上下文。
-
StorageStatePathstring? (可选)添加于:v1.9#使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.StorageStateAsync() 获取的登录信息来初始化上下文。保存存储状态的文件的路径。
-
如果设置为 true,则为当前上下文启用严格选择器模式。在严格选择器模式下,所有对暗示单个目标 DOM 元素的(基于选择器的)操作,如果匹配到多个元素,将抛出异常。此选项不影响任何定位器 API(定位器始终是严格的)。默认为
false。了解有关严格模式的更多信息,请参阅 Locator。 -
更改上下文的时区。支持的时区 ID 列表,请参阅ICU 的 metaZones.txt。默认为系统时区。
-
此上下文中使用的特定用户代理。
-
ViewportSizeViewportSize? (可选)#为每个页面模拟一致的视口。默认为 1280x720 视口。使用
ViewportSize.NoViewport禁用一致的视口模拟。了解有关 视口模拟的更多信息。注意ViewportSize.NoViewport值选择退出默认预设,使视口取决于操作系统定义的宿主窗口大小。这会使测试执行不确定。
-
返回
NewPageAsync
v1.9 之前添加在新的浏览器上下文中创建一个新页面。关闭此页面也会关闭上下文。
这是一个方便的 API,仅应用于单页面场景和简短代码片段。生产代码和测试框架应显式创建 Browser.NewContextAsync(),然后创建 BrowserContext.NewPageAsync() 以控制其确切的生命周期。
用法
await Browser.NewPageAsync(options);
参数
optionsBrowserNewPageOptions?(可选)-
是否自动下载所有附件。默认为
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。 -
ClientCertificatesIEnumerable?<ClientCertificates> (可选)添加于: 1.46#-
Originstring证书有效的精确源。源包括
https协议、主机名和可选的端口。 -
CertPathstring? (可选)PEM 格式证书文件的路径。
-
Certbyte[]? (可选)PEM 格式证书的直接值。
-
KeyPathstring? (可选)PEM 格式私钥文件的路径。
-
Keybyte[]? (可选)PEM 格式私钥的直接值。
-
PfxPathstring? (可选)PFX 或 PKCS12 编码的私钥和证书链文件的路径。
-
Pfxbyte[]? (可选)PFX 或 PKCS12 编码的私钥和证书链的直接值。
-
Passphrasestring? (可选)私钥(PEM 或 PFX)的密码。
TLS 客户端认证允许服务器请求并验证客户端证书。
详情
要使用的客户端证书数组。每个证书对象必须同时包含
certPath和keyPath,单个pfxPath,或其相应的直接值(cert和key,或pfx)。如果证书已加密,可以选择提供passphrase属性。origin属性应提供与证书有效的请求源的确切匹配。仅当提供至少一个客户端证书时,客户端证书身份验证才处于活动状态。如果您想拒绝服务器发送的所有客户端证书,您需要提供一个
origin与您计划访问的任何域都不匹配的客户端证书。注意在 macOS 上使用 WebKit 时,访问
localhost将不会选取客户端证书。您可以通过将localhost替换为local.playwright来使其工作。 -
-
ColorSchemeenum ColorScheme { Light, Dark, NoPreference, Null }?(可选)#模拟 prefers-colors-scheme 媒体特性,支持的值为
'light'和'dark'。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'会将模拟重置为系统默认值。默认为'light'。 -
Contrastenum Contrast { NoPreference, More, Null }?(可选)#模拟
'prefers-contrast'媒体特性,支持的值为'no-preference','more'。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'会将模拟重置为系统默认值。默认为'no-preference'。 -
DeviceScaleFactor[float]? (可选)#指定设备缩放因子(可视为 dpr)。默认为
1。了解有关使用设备缩放因子 模拟设备的更多信息。 -
ExtraHTTPHeadersIDictionary?<string, string> (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
ForcedColorsenum ForcedColors { Active, None, Null }?(可选)#模拟
'forced-colors'媒体特性,支持的值为'active','none'。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'会将模拟重置为系统默认值。默认为'none'。 -
GeolocationGeolocation? (可选)#-
Latitude[浮点数]纬度,介于 -90 和 90 之间。
-
Longitude[浮点数]经度,介于 -180 和 180 之间。
-
Accuracy[浮点数]? (可选)非负精度值。默认为
0。
-
-
指定视口是否支持触摸事件。默认为 false。了解有关 移动设备模拟的更多信息。
-
HttpCredentialsHttpCredentials? (可选)#-
Usernamestring -
Passwordstring -
Originstring? (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
Sendenum HttpCredentialsSend { Unauthorized, Always }?(可选)此选项仅适用于从相应 APIRequestContext 发送的请求,不影响从浏览器发送的请求。
'always'- 带有基本身份验证凭据的Authorization标头将随每个 API 请求发送。'unauthorized- 仅在收到带有WWW-Authenticate标头的 401 (Unauthorized) 响应时才发送凭据。默认为'unauthorized'。
用于 HTTP 身份验证的凭据。如果未指定源,则在未经授权的响应时将用户名和密码发送到任何服务器。
-
-
发送网络请求时是否忽略 HTTPS 错误。默认为
false。 -
是否考虑
meta viewport标签并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为false,Firefox 不支持此选项。了解有关 移动设备模拟的更多信息。 -
是否在上下文中启用 JavaScript。默认为
true。了解有关 禁用 JavaScript 的更多信息。 -
指定用户区域设置,例如
en-GB,de-DE等。区域设置会影响navigator.language的值、Accept-Language请求头的值以及数字和日期格式化规则。默认为系统默认区域设置。了解有关我们模拟指南中模拟的更多信息。 -
是否模拟网络离线状态。默认为
false。了解有关 网络模拟的更多信息。 -
PermissionsIEnumerable?<string> (可选)#要授予此上下文中所有页面的权限列表。有关更多详细信息,请参阅 BrowserContext.GrantPermissionsAsync()。默认为无。
-
ProxyProxy? (可选)#-
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 代理需要身份验证,则使用的可选密码。
用于此上下文的网络代理设置。默认为无。
-
-
RecordHarContentenum HarContentPolicy { Omit, Embed, Attach }?(可选)#可选设置,用于控制资源内容管理。如果指定了
omit,则不持久化内容。如果指定了attach,则资源将作为单独的文件持久化,并且所有这些文件将与 HAR 文件一起存档。默认为embed,它将内容内联存储在 HAR 文件中,符合 HAR 规范。 -
RecordHarModeenum HarMode { Full, Minimal }?(可选)#设置为
minimal时,仅记录从 HAR 路由所需的信息。这会省略 HAR 的大小、时间、页面、Cookie、安全性和其他类型的 HAR 信息,这些信息在从 HAR 重放时不使用。默认为full。 -
RecordHarOmitContentbool? (可选)#控制是否从 HAR 中省略请求内容的可选设置。默认为
false。 -
在文件系统中为所有页面启用 HAR 记录到指定的 HAR 文件中。如果未指定,则不记录 HAR。请确保调用 BrowserContext.CloseAsync() 以便保存 HAR。
-
RecordHarUrlFilter|RecordHarUrlFilterRegexstring? | Regex? (可选)# -
启用到指定目录中所有页面的视频录制。如果未指定,则不录制视频。请确保调用 BrowserContext.CloseAsync() 以便保存视频。
-
RecordVideoSizeRecordVideoSize? (可选)#录制视频的尺寸。如果未指定,尺寸将等于
viewport按比例缩小以适应 800x800。如果未明确配置viewport,视频尺寸默认为 800x450。如果需要,每个页面的实际图像将按比例缩小以适应指定的尺寸。 -
ReducedMotionenum ReducedMotion { Reduce, NoPreference, Null }?(可选)#模拟
'prefers-reduced-motion'媒体特性,支持的值为'reduce','no-preference'。有关更多详细信息,请参阅 Page.EmulateMediaAsync()。传递'null'会将模拟重置为系统默认值。默认为'no-preference'。 -
ScreenSizeScreenSize? (可选)#模拟在 Web 页面中可通过
window.screen访问的统一窗口屏幕大小。仅在设置了 ViewportSize 时使用。 -
ServiceWorkersenum ServiceWorkerPolicy { Allow, Block }?(可选)#是否允许站点注册 Service Workers。默认为
'allow'。'allow': Service Workers 可以注册。'block': Playwright 将阻止所有 Service Workers 的注册。
-
使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.StorageStateAsync() 获取的登录信息来初始化上下文。
-
StorageStatePathstring? (可选)添加于:v1.9#使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.StorageStateAsync() 获取的登录信息来初始化上下文。保存存储状态的文件的路径。
-
如果设置为 true,则为当前上下文启用严格选择器模式。在严格选择器模式下,所有对暗示单个目标 DOM 元素的(基于选择器的)操作,如果匹配到多个元素,将抛出异常。此选项不影响任何定位器 API(定位器始终是严格的)。默认为
false。了解有关严格模式的更多信息,请参阅 Locator。 -
更改上下文的时区。支持的时区 ID 列表,请参阅ICU 的 metaZones.txt。默认为系统时区。
-
此上下文中使用的特定用户代理。
-
ViewportSizeViewportSize? (可选)#为每个页面模拟一致的视口。默认为 1280x720 视口。使用
ViewportSize.NoViewport禁用一致的视口模拟。了解有关 视口模拟的更多信息。注意ViewportSize.NoViewport值选择退出默认预设,使视口取决于操作系统定义的宿主窗口大小。这会使测试执行不确定。
-
返回
Version
v1.9 之前添加返回浏览器版本。
用法
Browser.Version
返回
事件
event Disconnected
v1.9 之前添加浏览器与浏览器应用程序断开连接时触发。这可能是由于以下原因之一:
- 浏览器应用程序已关闭或崩溃。
- 调用了 Browser.CloseAsync() 方法。
用法
Browser.Disconnected += async (_, browser) => {};
事件数据