跳到主要内容

Browser

一个 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 browser.BrowserType

获取浏览器所属的浏览器类型(chromium、firefox 或 webkit)。

用法

Browser.BrowserType

返回


CloseAsync

添加早于: v1.9 browser.CloseAsync

如果此浏览器是通过 BrowserType.LaunchAsync() 获取的,则关闭浏览器及其所有页面(如果已打开)。

如果此浏览器已连接,则清除属于此浏览器的所有已创建上下文并断开与浏览器服务器的连接。

注意

这类似于强制退出浏览器。要优雅地关闭页面并确保您收到页面关闭事件,请在调用 Browser.CloseAsync() **之前**,对您之前使用 Browser.NewContextAsync() 显式创建的任何 BrowserContext 实例调用 BrowserContext.CloseAsync()

Browser 对象本身被认为是已处置的,不能再使用。

用法

await Browser.CloseAsync(options);

参数

  • options BrowserCloseOptions? (可选)
    • Reason string? (可选)添加于: v1.40#

      报告给因浏览器关闭而中断的操作的原因。

返回


Contexts

添加早于: v1.9 browser.Contexts

返回所有已打开的浏览器上下文数组。在新创建的浏览器中,这将返回零个浏览器上下文。

用法

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

指示浏览器是否已连接。

用法

Browser.IsConnected

返回


NewBrowserCDPSessionAsync

添加于: v1.11 browser.NewBrowserCDPSessionAsync
注意

CDP Session 仅在基于 Chromium 的浏览器上支持。

返回新创建的浏览器 Session。

用法

await Browser.NewBrowserCDPSessionAsync();

返回


NewContextAsync

添加早于: v1.9 browser.NewContextAsync

创建一个新的浏览器上下文。它不会与其他浏览器上下文共享 cookie/缓存。

注意

如果直接使用此方法创建 BrowserContext,最佳实践是在代码完成对 BrowserContext 的操作后,并在调用 Browser.CloseAsync() 之前,通过 BrowserContext.CloseAsync() 显式关闭返回的上下文。这将确保上下文优雅地关闭,并且所有工件(如 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? (可选)
    • AcceptDownloads bool? (可选)#

      是否自动下载所有附件。默认为 true,即接受所有下载。

    • BaseURL string? (可选)#

      使用 Page.GotoAsync()Page.RouteAsync()Page.WaitForURLAsync()Page.RunAndWaitForRequestAsync()Page.RunAndWaitForResponseAsync() 时,它会使用 URL() 构造函数构建相应的 URL,从而考虑基础 URL。默认未设置。示例:

      • baseURL: http://localhost:3000 导航到 /bar.html,结果为 http://localhost:3000/bar.html
      • baseURL: http://localhost:3000/foo/ 导航到 ./bar.html,结果为 http://localhost:3000/foo/bar.html
      • baseURL: http://localhost:3000/foo (无斜杠结尾) 导航到 ./bar.html,结果为 http://localhost:3000/bar.html
    • BypassCSP bool? (可选)#

      切换是否绕过页面的 Content-Security-Policy。默认为 false。

    • ClientCertificates IEnumerable?<ClientCertificates> (可选)添加于: 1.46#

      • Origin string

        证书有效的精确 Origin。Origin 包括 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 客户端认证允许服务器请求并验证客户端证书。

      详情

      要使用的客户端证书数组。每个证书对象必须同时包含 certPathkeyPath,或单独的 pfxPath,或其对应的直接值(certkey,或 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 头的对象。默认为 none。

    • ForcedColors enum ForcedColors { Active, None, Null }? (可选)#

      模拟 'forced-colors' 媒体特性,支持的值为 'active''none'。详情请参阅 Page.EmulateMediaAsync()。传递 'null' 会将模拟重置为系统默认值。默认为 'none'

    • Geolocation Geolocation? (可选)#

      • Latitude [float]

        纬度,介于 -90 和 90 之间。

      • Longitude [float]

        经度,介于 -180 和 180 之间。

      • Accuracy [float]? (可选)

        非负精度值。默认为 0。

    • HasTouch bool? (可选)#

      指定视口是否支持触摸事件。默认为 false。了解更多关于移动设备模拟的信息。

    • HttpCredentials HttpCredentials? (可选)#

      • Username string

      • Password string

      • Origin string? (可选)

        限制在特定 origin (scheme://host:port).

      • Send enum HttpCredentialsSend { Unauthorized, Always }? (可选)

        此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。'always' - 包含基本认证凭据的 Authorization 头将随每个 API 请求发送。'unauthorized - 仅当收到带有 WWW-Authenticate 头的 401 (Unauthorized) 响应时才发送凭据。默认为 'unauthorized'

      用于 HTTP 认证的凭据。如果未指定 origin,则在收到未经授权的响应时,用户名和密码会发送到任何服务器。

    • IgnoreHTTPSErrors bool? (可选)#

      发送网络请求时是否忽略 HTTPS 错误。默认为 false。

    • IsMobile bool? (可选)#

      是否考虑 meta viewport 标签并启用触摸事件。isMobile 是设备的一部分,所以实际上您不需要手动设置它。默认为 false,并且在 Firefox 中不受支持。了解更多关于移动设备模拟的信息。

    • JavaScriptEnabled bool? (可选)#

      是否在上下文中启用 JavaScript。默认为 true。了解更多关于禁用 JavaScript 的信息。

    • Locale string? (可选)#

      指定用户区域设置,例如 en-GBde-DE 等。Locale 会影响 navigator.language 值、Accept-Language 请求头值以及数字和日期格式化规则。默认为系统默认区域设置。在我们的模拟指南中了解更多关于模拟的信息。

    • Offline bool? (可选)#

      是否模拟网络离线。默认为 false。了解更多关于网络模拟的信息。

    • Permissions IEnumerable?<string> (可选)#

      要授予此上下文中所有页面的权限列表。详情请参阅 BrowserContext.GrantPermissionsAsync()。默认为 none。

    • Proxy Proxy? (可选)#

      • Server string

        用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如 http://myproxy.com:3128socks5://myproxy.com:3128。短格式 myproxy.com:3128 被视为 HTTP 代理。

      • Bypass string? (可选)

        可选的逗号分隔域,用于绕过代理,例如 ".com, chromium.org, .domain.com"

      • Username string? (可选)

        如果 HTTP 代理需要认证,使用的可选用户名。

      • Password string? (可选)

        如果 HTTP 代理需要认证,使用的可选密码。

      用于此上下文的网络代理设置。默认为 none。

    • RecordHarContent enum HarContentPolicy { Omit, Embed, Attach }? (可选)#

      控制资源内容管理的选项设置。如果指定 omit,则不持久化内容。如果指定 attach,则资源作为单独的文件持久化,并且所有这些文件都与 HAR 文件一起归档。默认为 embed,它根据 HAR 规范将内容内嵌存储在 HAR 文件中。

    • RecordHarMode enum HarMode { Full, Minimal }? (可选)#

      设置为 minimal 时,仅记录从 HAR 进行路由所需的信息。这将忽略大小、时序、页面、cookie、安全性和其他在从 HAR 回放时未使用的 HAR 信息类型。默认为 full

    • RecordHarOmitContent bool? (可选)#

      控制是否从 HAR 中忽略请求内容的选项设置。默认为 false。

    • RecordHarPath string? (可选)#

      在文件系统上启用将所有页面的 HAR 记录到指定的 HAR 文件中。如果未指定,则不记录 HAR。请务必调用 BrowserContext.CloseAsync() 以保存 HAR。

    • RecordHarUrlFilter|RecordHarUrlFilterRegex string? | Regex? (可选)#

    • RecordVideoDir string? (可选)#

      启用将所有页面的视频记录到指定目录。如果未指定,则不记录视频。请务必调用 BrowserContext.CloseAsync() 以保存视频。

    • RecordVideoSize RecordVideoSize? (可选)#

      • Width int

        视频帧宽度。

      • Height int

        视频帧高度。

      录制视频的尺寸。如果未指定,尺寸将等于缩放至适应 800x800 的视口尺寸。如果未显式配置视口,视频尺寸默认为 800x450。必要时,每页的实际画面将按比例缩小以适应指定尺寸。

    • ReducedMotion enum ReducedMotion { Reduce, NoPreference, Null }? (可选)#

      模拟 'prefers-reduced-motion' 媒体特性,支持的值为 'reduce''no-preference'。详情请参阅 Page.EmulateMediaAsync()。传递 'null' 会将模拟重置为系统默认值。默认为 'no-preference'

    • ScreenSize ScreenSize? (可选)#

      • Width int

        页面宽度(像素)。

      • Height int

        页面高度(像素)。

      通过 window.screen 模拟网页内可用的统一窗口屏幕尺寸。仅当设置了 ViewportSize 时使用。

    • ServiceWorkers enum ServiceWorkerPolicy { Allow, Block }? (可选)#

      是否允许站点注册 Service Worker。默认为 'allow'

      • 'allow': Service Worker 可以被注册。
      • 'block': Playwright 将阻止所有 Service Worker 的注册。
    • StorageState string? (可选)#

      使用给定的存储状态填充上下文。此选项可用于通过 BrowserContext.StorageStateAsync() 获取的登录信息初始化上下文。

    • StorageStatePath string? (可选)添加于: v1.9#

      使用给定的存储状态填充上下文。此选项可用于通过 BrowserContext.StorageStateAsync() 获取的登录信息初始化上下文。保存的存储状态文件的路径。

    • StrictSelectors bool? (可选)#

      如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,对暗示单一目标 DOM 元素的选择器的所有操作,在匹配的选择器元素多于一个时将抛出异常。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为 false。参阅 Locator 了解更多关于严格模式的信息。

    • TimezoneId string? (可选)#

      更改上下文的时区。参阅 ICU 的 metaZones.txt 获取支持的时区 ID 列表。默认为系统时区。

    • UserAgent string? (可选)#

      在此上下文中使用的特定用户代理。

    • ViewportSize ViewportSize? (可选)#

      • Width int

        页面宽度(像素)。

      • Height int

        页面高度(像素)。

      为每个页面模拟统一视口。默认为 1280x720 视口。使用 ViewportSize.NoViewport 禁用统一视口模拟。了解更多关于视口模拟的信息。

      注意

      ViewportSize.NoViewport 值退出默认预设,使视口取决于操作系统定义的主机窗口大小。这使得测试的执行变得不确定。

返回


NewPageAsync

添加早于: v1.9 browser.NewPageAsync

在新的浏览器上下文中创建一个新页面。关闭此页面也会关闭此上下文。

这是一个便利 API,仅应应用于单页场景和简短代码片段。生产代码和测试框架应显式创建 Browser.NewContextAsync(),然后调用 BrowserContext.NewPageAsync() 来控制其精确生命周期。

用法

await Browser.NewPageAsync(options);

参数

  • options BrowserNewPageOptions? (可选)
    • AcceptDownloads bool? (可选)#

      是否自动下载所有附件。默认为 true,即接受所有下载。

    • BaseURL string? (可选)#

      使用 Page.GotoAsync()Page.RouteAsync()Page.WaitForURLAsync()Page.RunAndWaitForRequestAsync()Page.RunAndWaitForResponseAsync() 时,它会使用 URL() 构造函数构建相应的 URL,从而考虑基础 URL。默认未设置。示例:

      • baseURL: http://localhost:3000 导航到 /bar.html,结果为 http://localhost:3000/bar.html
      • baseURL: http://localhost:3000/foo/ 导航到 ./bar.html,结果为 http://localhost:3000/foo/bar.html
      • baseURL: http://localhost:3000/foo (无斜杠结尾) 导航到 ./bar.html,结果为 http://localhost:3000/bar.html
    • BypassCSP bool? (可选)#

      切换是否绕过页面的 Content-Security-Policy。默认为 false。

    • ClientCertificates IEnumerable?<ClientCertificates> (可选)添加于: 1.46#

      • Origin string

        证书有效的精确 Origin。Origin 包括 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 客户端认证允许服务器请求并验证客户端证书。

      详情

      要使用的客户端证书数组。每个证书对象必须同时包含 certPathkeyPath,或单独的 pfxPath,或其对应的直接值(certkey,或 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 头的对象。默认为 none。

    • ForcedColors enum ForcedColors { Active, None, Null }? (可选)#

      模拟 'forced-colors' 媒体特性,支持的值为 'active''none'。详情请参阅 Page.EmulateMediaAsync()。传递 'null' 会将模拟重置为系统默认值。默认为 'none'

    • Geolocation Geolocation? (可选)#

      • Latitude [float]

        纬度,介于 -90 和 90 之间。

      • Longitude [float]

        经度,介于 -180 和 180 之间。

      • Accuracy [float]? (可选)

        非负精度值。默认为 0。

    • HasTouch bool? (可选)#

      指定视口是否支持触摸事件。默认为 false。了解更多关于移动设备模拟的信息。

    • HttpCredentials HttpCredentials? (可选)#

      • Username string

      • Password string

      • Origin string? (可选)

        限制在特定 origin (scheme://host:port).

      • Send enum HttpCredentialsSend { Unauthorized, Always }? (可选)

        此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。'always' - 包含基本认证凭据的 Authorization 头将随每个 API 请求发送。'unauthorized - 仅当收到带有 WWW-Authenticate 头的 401 (Unauthorized) 响应时才发送凭据。默认为 'unauthorized'

      用于 HTTP 认证的凭据。如果未指定 origin,则在收到未经授权的响应时,用户名和密码会发送到任何服务器。

    • IgnoreHTTPSErrors bool? (可选)#

      发送网络请求时是否忽略 HTTPS 错误。默认为 false。

    • IsMobile bool? (可选)#

      是否考虑 meta viewport 标签并启用触摸事件。isMobile 是设备的一部分,所以实际上您不需要手动设置它。默认为 false,并且在 Firefox 中不受支持。了解更多关于移动设备模拟的信息。

    • JavaScriptEnabled bool? (可选)#

      是否在上下文中启用 JavaScript。默认为 true。了解更多关于禁用 JavaScript 的信息。

    • Locale string? (可选)#

      指定用户区域设置,例如 en-GBde-DE 等。Locale 会影响 navigator.language 值、Accept-Language 请求头值以及数字和日期格式化规则。默认为系统默认区域设置。在我们的模拟指南中了解更多关于模拟的信息。

    • Offline bool? (可选)#

      是否模拟网络离线。默认为 false。了解更多关于网络模拟的信息。

    • Permissions IEnumerable?<string> (可选)#

      要授予此上下文中所有页面的权限列表。详情请参阅 BrowserContext.GrantPermissionsAsync()。默认为 none。

    • Proxy Proxy? (可选)#

      • Server string

        用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如 http://myproxy.com:3128socks5://myproxy.com:3128。短格式 myproxy.com:3128 被视为 HTTP 代理。

      • Bypass string? (可选)

        可选的逗号分隔域,用于绕过代理,例如 ".com, chromium.org, .domain.com"

      • Username string? (可选)

        如果 HTTP 代理需要认证,使用的可选用户名。

      • Password string? (可选)

        如果 HTTP 代理需要认证,使用的可选密码。

      用于此上下文的网络代理设置。默认为 none。

    • RecordHarContent enum HarContentPolicy { Omit, Embed, Attach }? (可选)#

      控制资源内容管理的选项设置。如果指定 omit,则不持久化内容。如果指定 attach,则资源作为单独的文件持久化,并且所有这些文件都与 HAR 文件一起归档。默认为 embed,它根据 HAR 规范将内容内嵌存储在 HAR 文件中。

    • RecordHarMode enum HarMode { Full, Minimal }? (可选)#

      设置为 minimal 时,仅记录从 HAR 进行路由所需的信息。这将忽略大小、时序、页面、cookie、安全性和其他在从 HAR 回放时未使用的 HAR 信息类型。默认为 full

    • RecordHarOmitContent bool? (可选)#

      控制是否从 HAR 中忽略请求内容的选项设置。默认为 false。

    • RecordHarPath string? (可选)#

      在文件系统上启用将所有页面的 HAR 记录到指定的 HAR 文件中。如果未指定,则不记录 HAR。请务必调用 BrowserContext.CloseAsync() 以保存 HAR。

    • RecordHarUrlFilter|RecordHarUrlFilterRegex string? | Regex? (可选)#

    • RecordVideoDir string? (可选)#

      启用将所有页面的视频记录到指定目录。如果未指定,则不记录视频。请务必调用 BrowserContext.CloseAsync() 以保存视频。

    • RecordVideoSize RecordVideoSize? (可选)#

      • Width int

        视频帧宽度。

      • Height int

        视频帧高度。

      录制视频的尺寸。如果未指定,尺寸将等于缩放至适应 800x800 的视口尺寸。如果未显式配置视口,视频尺寸默认为 800x450。必要时,每页的实际画面将按比例缩小以适应指定尺寸。

    • ReducedMotion enum ReducedMotion { Reduce, NoPreference, Null }? (可选)#

      模拟 'prefers-reduced-motion' 媒体特性,支持的值为 'reduce''no-preference'。详情请参阅 Page.EmulateMediaAsync()。传递 'null' 会将模拟重置为系统默认值。默认为 'no-preference'

    • ScreenSize ScreenSize? (可选)#

      • Width int

        页面宽度(像素)。

      • Height int

        页面高度(像素)。

      模拟通过 window.screen 在网页内部可用的窗口屏幕一致大小。仅当设置了 ViewportSize 时使用。

    • ServiceWorkers enum ServiceWorkerPolicy { Allow, Block }? (可选)#

      是否允许站点注册 Service Worker。默认为 'allow'

      • 'allow': Service Worker 可以被注册。
      • 'block': Playwright 将阻止所有 Service Worker 的注册。
    • StorageState string? (可选)#

      使用给定的存储状态填充上下文。此选项可用于通过 BrowserContext.StorageStateAsync() 获取的登录信息初始化上下文。

    • StorageStatePath string? (可选)添加于: v1.9#

      使用给定的存储状态填充上下文。此选项可用于通过 BrowserContext.StorageStateAsync() 获取的登录信息初始化上下文。保存的存储状态文件的路径。

    • StrictSelectors bool? (可选)#

      如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,对暗示单一目标 DOM 元素的选择器的所有操作,在匹配的选择器元素多于一个时将抛出异常。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为 false。参阅 Locator 了解更多关于严格模式的信息。

    • TimezoneId string? (可选)#

      更改上下文的时区。参阅 ICU 的 metaZones.txt 获取支持的时区 ID 列表。默认为系统时区。

    • UserAgent string? (可选)#

      在此上下文中使用的特定用户代理。

    • ViewportSize ViewportSize? (可选)#

      • Width int

        页面宽度(像素)。

      • Height int

        页面高度(像素)。

      为每个页面模拟统一视口。默认为 1280x720 视口。使用 ViewportSize.NoViewport 禁用统一视口模拟。了解更多关于视口模拟的信息。

      注意

      ViewportSize.NoViewport 值退出默认预设,使视口取决于操作系统定义的主机窗口大小。这使得测试的执行变得不确定。

返回


版本

添加早于: v1.9 browser.Version

返回浏览器版本。

用法

Browser.Version

返回


事件

事件 Disconnected

添加早于: v1.9 browser.event Disconnected

当浏览器与浏览器应用程序断开连接时触发。这可能由于以下原因之一发生:

用法

Browser.Disconnected += async (_, browser) => {};

事件数据