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

返回值

• 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#

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

返回值

• void#

---

Contexts

在 v1.9 之前添加 browser.Contexts

返回所有打开的浏览器上下文的数组。在新创建的浏览器中，此方法将返回零个浏览器上下文。

使用方法

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Webkit.LaunchAsync();
System.Console.WriteLine(browser.Contexts.Count); // 输出 "0"
var context = await browser.NewContextAsync();
System.Console.WriteLine(browser.Contexts.Count); // 输出 "1"

返回值

• IReadOnlyList<BrowserContext>#

---

IsConnected

在 v1.9 之前添加 browser.IsConnected

指示浏览器是否已连接。

使用方法

Browser.IsConnected

返回值

• bool#

---

NewBrowserCDPSessionAsync

新增于：v1.11 browser.NewBrowserCDPSessionAsync

备注

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

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

用法

await Browser.NewBrowserCDPSessionAsync();

返回值

• CDPSession#

---

NewContextAsync

在 v1.9 之前添加 browser.NewContextAsync

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

备注

如果直接使用此方法创建 BrowserContext，最佳做法是在代码使用完 BrowserContext 后，且在调用 Browser.CloseAsync() 之前，通过 BrowserContext.CloseAsync() 显式关闭返回的上下文。这将确保 context 正常关闭，并且任何工件（如 HAR 和视频）都能完全刷新并保存。

用法

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Firefox.LaunchAsync();
// 创建一个新的无痕浏览器上下文。
var context = await browser.NewContextAsync();
// 在全新的上下文中创建一个新页面。
var page = await context.NewPageAsync(); ;
await page.GotoAsync("https://www.bing.com");

// 正常关闭所有内容
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。默认未设置。示例：

    • 基本 URL：http://localhost:3000，导航到 /bar.html，结果为 http://localhost:3000/bar.html
    • 基本 URL：http://localhost:3000/foo/，导航到 ./bar.html，结果为 http://localhost:3000/foo/bar.html
    • 基本 URL：http://localhost:3000/foo（无尾部斜杠），导航到 ./bar.html，结果为 http://localhost:3000/bar.html

  • BypassCSP bool?（可选）#

    切换是否绕过页面的内容安全策略（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 属性，且其值应与证书适用的请求源完全匹配。

    备注

    在 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 [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' - 每个 API 请求都将发送带有基本身份验证凭据的 Authorization 标头。'unauthorized - 仅在收到带有 WWW-Authenticate 标头的 401（未授权）响应时才发送凭据。默认为 'unauthorized'。

    HTTP 身份验证 的凭据。如果未指定源，则在收到未授权响应时，用户名和密码将发送到任何服务器。

  • IgnoreHTTPSErrors bool?（可选）#

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

  • IsMobile bool?（可选）#

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

  • JavaScriptEnabled bool?（可选）#

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

  • Locale string?（可选）#

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

  • Offline bool?（可选）#

    是否模拟网络离线。默认为 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 路由所需的信息。这将省略大小、时间、页面、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

      视频帧高度。

    录制视频的尺寸。如果未指定，尺寸将等于 viewport 缩放以适应 800x800。如果未显式配置 viewport，则视频尺寸默认为 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 Workers。
    • '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? (可选)#

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

  • UserAgent string? (可选)#

    在此上下文中使用的特定 User-Agent。

  • ViewportSize ViewportSize? (可选)#

    • Width int

      页面宽度（像素）。

    • Height int

      页面高度（像素）。

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

    备注

    ViewportSize.NoViewport 值会跳过默认预设，使视口依赖于操作系统定义的主机窗口大小。这会导致测试执行变得不确定。

返回值

• BrowserContext#

---

NewPageAsync

在 v1.9 之前添加 browser.NewPageAsync

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

这是一个便捷 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

      证书适用的精确源。源包括 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 属性，且其值应与证书适用的请求源完全匹配。

    备注

    在 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 [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 中不受支持。了解更多关于 移动设备模拟 的信息。

  • JavaScriptEnabled bool?（可选）#

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

  • Locale string?（可选）#

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

  • Offline bool?（可选）#

    是否模拟网络离线。默认值为 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 进行路由所需的信息。这将省略大小、时间、页面、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

      视频帧高度。

    录制视频的尺寸。如果未指定，尺寸将等于 viewport 缩小到适合 800x800 的大小。如果未

返回值

• Page#

---

Version

在 v1.9 之前添加 browser.Version

返回浏览器版本。

用法

Browser.Version

返回值

• string#

---

事件

事件 Disconnected

在 v1.9 之前添加 browser.event Disconnected

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

• 浏览器应用程序关闭或崩溃。
• 调用了 Browser.CloseAsync() 方法。

用法

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

事件数据

• Browser