跳至主要内容

浏览器

浏览器是通过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

Added in: v1.23 browser.BrowserType

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

用法

Browser.BrowserType

返回


CloseAsync

Added before v1.9 browser.CloseAsync

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

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

note

这类似于强制退出浏览器。要优雅地关闭页面并确保接收到页面关闭事件,请在任何显式创建的BrowserContext实例上调用BrowserContext.CloseAsync()(这些实例是通过Browser.NewContextAsync()创建的),然后再调用Browser.CloseAsync()

Browser对象本身被视为已释放,无法再使用。

用法

await Browser.CloseAsync(options);

参数

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

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

返回


上下文

Added before 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"

返回


是否已连接

Added before v1.9 browser.IsConnected

表示浏览器已连接。

用法

Browser.IsConnected

返回


NewBrowserCDPSessionAsync

Added in: v1.11 browser.NewBrowserCDPSessionAsync
note

CDP会话仅在基于Chromium的浏览器上受支持。

返回新创建的浏览器会话。

用法

await Browser.NewBrowserCDPSessionAsync();

返回


NewContextAsync

Added before v1.9 browser.NewContextAsync

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

note

如果直接使用此方法创建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? (optional)
    • AcceptDownloads bool? (可选)#

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

    • BaseURL string? (可选)#

      在使用Page.GotoAsync()Page.RouteAsync()Page.WaitForURLAsync()Page.RunAndWaitForRequestAsync()Page.RunAndWaitForResponseAsync()时,会通过使用URL()构造函数来构建相应的URL,同时考虑基础URL。默认情况下未设置。示例:

      • baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
      • baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
      • baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html
    • BypassCSP bool? (可选)#

      切换是否绕过页面的内容安全策略。默认为 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客户端认证允许服务器请求客户端证书并进行验证。

      详情

      要使用的客户端证书数组。每个证书对象必须包含certPathkeyPath两者,或者单独的pfxPath,或者它们对应的直接值等价物(certkey,或者pfx)。如果证书已加密,可以选择提供passphrase属性。origin属性应提供与证书适用的请求来源完全匹配的值。

      note

      在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 地理位置? (可选)#

      • Latitude [float]

        纬度值介于-90到90之间。

      • Longitude [float]

        介于-180到180之间的经度值。

      • Accuracy [float]? (可选)

        非负精度值。默认为 0

    • HasTouch bool? (可选)#

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

    • HttpCredentials HttpCredentials? (可选)#

      • Username string

      • Password string

      • Origin string? (可选)

        限制在特定来源(scheme://host:port)上发送HTTP凭据。

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

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

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

    • IgnoreHTTPSErrors bool? (可选)#

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

    • IsMobile bool? (可选)#

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

    • JavaScriptEnabled bool? (可选)#

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

    • Locale string? (可选)#

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

    • Offline bool? (可选)#

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

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

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

    • 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代理需要认证时可选的密码。

      与此上下文一起使用的网络代理设置。默认为无。

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

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

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

      当设置为minimal时,仅记录从HAR路由所必需的信息。这会省略大小、时间、页面、cookies、安全和其他类型的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

        视频帧高度。

      录制视频的尺寸。如果未指定,大小将等于viewport按比例缩小以适应800x800。如果未明确配置viewport,视频尺寸默认为800x450。每个页面的实际画面将根据需要按比例缩小以适应指定尺寸。

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

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

    • ScreenSize 屏幕尺寸? (可选)#

      • Width int

        页面宽度,单位为像素。

      • Height int

        页面高度,单位为像素。

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

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

      是否允许网站注册Service workers。默认为'allow'

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

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

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

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

    • StrictSelectors bool? (可选)#

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

    • TimezoneId string? (可选)#

      更改上下文的时区。支持的时区ID列表请参见ICU's metaZones.txt。默认为系统时区。

    • UserAgent string? (可选)#

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

    • ViewportSize 视口大小? (可选)#

      • Width int

        页面宽度,单位为像素。

      • Height int

        页面高度,单位为像素。

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

      note

      ViewportSize.NoViewport 值将不采用默认预设,使视口大小取决于操作系统定义的主机窗口尺寸。这会导致测试执行变得不可确定。

返回


NewPageAsync

Added before v1.9 browser.NewPageAsync

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

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

用法

await Browser.NewPageAsync(options);

参数

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

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

    • BaseURL string? (可选)#

      在使用Page.GotoAsync()Page.RouteAsync()Page.WaitForURLAsync()Page.RunAndWaitForRequestAsync()Page.RunAndWaitForResponseAsync()时,会通过使用URL()构造函数来构建相应的URL,同时考虑基础URL。默认情况下未设置。示例:

      • baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
      • baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
      • baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html
    • BypassCSP bool? (可选)#

      切换是否绕过页面的内容安全策略。默认为 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客户端认证允许服务器请求客户端证书并进行验证。

      详情

      要使用的客户端证书数组。每个证书对象必须包含certPathkeyPath两者,或者单独的pfxPath,或者它们对应的直接值等价物(certkey,或者pfx)。如果证书已加密,可以选择提供passphrase属性。origin属性应提供与证书适用的请求来源完全匹配的值。

      note

      在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 地理位置? (可选)#

      • Latitude [float]

        纬度值介于-90到90之间。

      • Longitude [float]

        介于-180到180之间的经度值。

      • Accuracy [float]? (可选)

        非负精度值。默认为 0

    • HasTouch bool? (可选)#

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

    • HttpCredentials HttpCredentials? (可选)#

      • Username string

      • Password string

      • Origin string? (可选)

        限制在特定来源(scheme://host:port)上发送HTTP凭据。

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

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

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

    • IgnoreHTTPSErrors bool? (可选)#

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

    • IsMobile bool? (可选)#

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

    • JavaScriptEnabled bool? (可选)#

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

    • Locale string? (可选)#

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

    • Offline bool? (可选)#

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

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

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

    • 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代理需要认证时可选的密码。

      与此上下文一起使用的网络代理设置。默认为无。

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

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

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

      当设置为minimal时,仅记录从HAR路由所必需的信息。这会省略大小、时间、页面、cookies、安全和其他类型的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

        视频帧高度。

      录制视频的尺寸。如果未指定,大小将等于viewport按比例缩小以适应800x800。如果未明确配置viewport,视频尺寸默认为800x450。每个页面的实际画面将根据需要按比例缩小以适应指定尺寸。

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

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

    • ScreenSize 屏幕尺寸? (可选)#

      • Width int

        页面宽度,单位为像素。

      • Height int

        页面高度,单位为像素。

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

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

      是否允许网站注册Service workers。默认为'allow'

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

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

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

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

    • StrictSelectors bool? (可选)#

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

    • TimezoneId string? (可选)#

      更改上下文的时区。支持的时区ID列表请参见ICU's metaZones.txt。默认为系统时区。

    • UserAgent string? (可选)#

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

    • ViewportSize 视口大小? (可选)#

      • Width int

        页面宽度,单位为像素。

      • Height int

        页面高度,单位为像素。

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

      note

      ViewportSize.NoViewport 值将不采用默认预设,使视口大小取决于操作系统定义的主机窗口尺寸。这会导致测试执行变得不可确定。

返回


版本

Added before v1.9 browser.Version

返回浏览器版本。

用法

Browser.Version

返回


事件

事件 已断开连接

Added before v1.9 browser.event Disconnected

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

用法

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

事件数据