浏览器类型

BrowserType 提供方法来启动特定浏览器实例或连接到现有实例。以下是用 Playwright 驱动自动化的典型示例

using Microsoft.Playwright;
using System.Threading.Tasks;

class BrowserTypeExamples
{
    public static async Task Run()
    {
        using var playwright = await Playwright.CreateAsync();
        var chromium = playwright.Chromium;
        var browser = await chromium.LaunchAsync();
        var page = await browser.NewPageAsync();
        await page.GotoAsync("https://www.bing.com");
        // other actions
        await browser.CloseAsync();
    }
}

---

方法

ConnectAsync

在 v1.9 之前添加 browserType.ConnectAsync

此方法将 Playwright 附加到现有浏览器实例。当连接到通过 BrowserType.launchServer 在 Node.js 中启动的另一个浏览器时，主版本和次版本需要与客户端版本匹配（1.2.3 → 与 1.2.x 兼容）。

用法

await BrowserType.ConnectAsync(wsEndpoint, options);

参数

• wsEndpoint string在 v1.10 中添加#

  要连接到的浏览器 websocket 端点。

• options BrowserTypeConnectOptions? （可选）

  • ExposeNetwork string? （可选）在 v1.37 中添加#

    此选项将连接客户端上可用的网络公开给要连接到的浏览器。由逗号分隔的规则列表组成。

    可用规则

    1. 主机名模式，例如：example.com、*.org:99、x.*.y.com、*foo.org。
    2. IP 字面量，例如：127.0.0.1、0.0.0.0:99、[::1]、[0:0::1]:99。
    3. <loopback> 匹配本地环回接口：localhost、*.localhost、127.0.0.1、[::1]。

    一些常见示例

    1. "*" 公开所有网络。
    2. "<loopback>" 公开 localhost 网络。
    3. "*.test.internal-domain,*.staging.internal-domain,<loopback>" 公开测试/暂存部署和 localhost。

  • Headers IDictionary?<string, string> （可选）在 v1.11 中添加#

    与 websocket 连接请求一起发送的其他 HTTP 标头。可选。

  • SlowMo [float]? （可选）在 v1.10 中添加#

    以指定的毫秒数减慢 Playwright 操作速度。这很有用，这样你就可以看到发生了什么。默认为 0。

  • Timeout [float]? （可选）在 v1.10 中添加#

    以毫秒为单位等待连接建立的最大时间。默认为 0（无超时）。

返回

• 浏览器#

---

ConnectOverCDPAsync

在 v1.9 中添加 browserType.ConnectOverCDPAsync

此方法使用 Chrome DevTools 协议将 Playwright 附加到现有浏览器实例。

默认浏览器上下文可以通过 Browser.Contexts 访问。

注意

仅 Chrome DevTools 协议支持连接到基于 Chromium 的浏览器。

用法

var browser = await playwright.Chromium.ConnectOverCDPAsync("https://127.0.0.1:9222");
var defaultContext = browser.Contexts[0];
var page = defaultContext.Pages[0];

参数

• endpointURL string在 v1.11 中添加#

  要连接到的 CDP websocket 端点或 http URL。例如 https://127.0.0.1:9222/ 或 ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4。

• options BrowserTypeConnectOverCDPOptions? （可选）

  • Headers IDictionary?<string, string> （可选）在 v1.11 中添加#

    与连接请求一起发送的其他 HTTP 标头。可选。

  • SlowMo [float]? （可选）在 v1.11 中添加#

    以指定的毫秒数减慢 Playwright 操作速度。这很有用，这样你就可以看到发生了什么。默认为 0。

  • Timeout [float]? （可选）在 v1.11 中添加#

    以毫秒为单位等待连接建立的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。

返回

• 浏览器#

---

ExecutablePath

在 v1.9 之前添加 browserType.ExecutablePath

Playwright 预计在其中找到捆绑的浏览器可执行文件的路径。

用法

BrowserType.ExecutablePath

返回

• string#

---

LaunchAsync

在 v1.9 之前添加 browserType.LaunchAsync

返回浏览器实例。

用法

您可以使用 IgnoreDefaultArgs 从默认参数中过滤掉 --mute-audio。

var browser = await playwright.Chromium.LaunchAsync(new() {
    IgnoreDefaultArgs = new[] { "--mute-audio" }
});

仅限 Chromium Playwright 也可以用于控制 Google Chrome 或 Microsoft Edge 浏览器，但它最适合与其捆绑的 Chromium 版本一起使用。无法保证它适用于任何其他版本。请谨慎使用 ExecutablePath 选项。

如果首选 Google Chrome（而不是 Chromium），建议使用 Chrome Canary 或 开发渠道 构建。

像 Google Chrome 和 Microsoft Edge 这样的库存浏览器适合需要专有媒体编解码器进行视频播放的测试。有关 Chromium 和 Chrome 之间其他差异，请参阅 本文。本文 为 Linux 用户描述了一些差异。

参数

• options BrowserTypeLaunchOptions? （可选）

  • Args IEnumerable?<string> （可选）#

    警告

    自行承担使用自定义浏览器参数的风险，因为其中一些参数可能会破坏 Playwright 功能。

    要传递给浏览器实例的其他参数。Chromium 标志列表可以在 此处 找到。

  • Channel string? （可选）#

    浏览器分发渠道。支持的值为“chrome”、“chrome-beta”、“chrome-dev”、“chrome-canary”、“msedge”、“msedge-beta”、“msedge-dev”、“msedge-canary”。详细了解如何使用 Google Chrome 和 Microsoft Edge。

  • ChromiumSandbox bool? （可选）#

    启用 Chromium 沙盒。默认为 false。

  • Devtools bool? （可选）#

    已弃用

    改用 调试工具。

    仅限 Chromium 是否为每个选项卡自动打开“开发人员工具”面板。如果此选项为 true，则 Headless 选项将设置为 false。

  • DownloadsPath string? （可选）#

    如果指定，接受的下载将下载到此目录中。否则，将创建临时目录，并在关闭浏览器时将其删除。无论哪种情况，在关闭创建它们的浏览器上下文时，下载都会被删除。

  • Env IDictionary?<string, string> （可选）#

    指定浏览器可见的环境变量。默认为 process.env。

  • ExecutablePath string? （可选）#

    要运行的浏览器可执行文件的路径，而不是捆绑的可执行文件。如果 ExecutablePath 是相对路径，则它相对于当前工作目录解析。请注意，Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit，请自行承担风险使用。

  • FirefoxUserPrefs IDictionary?<string, [object]> (可选)#

    Firefox 用户偏好设置。 了解更多关于 Firefox 用户偏好设置的信息，请访问 about:config.

  • HandleSIGHUP bool? (可选)#

    在 SIGHUP 时关闭浏览器进程。 默认值为 true。

  • HandleSIGINT bool? (可选)#

    在 Ctrl-C 时关闭浏览器进程。 默认值为 true。

  • HandleSIGTERM bool? (可选)#

    在 SIGTERM 时关闭浏览器进程。 默认值为 true。

  • Headless bool? (可选)#

    是否以无头模式运行浏览器。 更多关于 Chromium 和 Firefox 的细节。 默认值为 true，除非 Devtools 选项为 true。

  • IgnoreAllDefaultArgs bool? (可选)在 v1.9 中添加#

    如果为 true，Playwright 不会传递它自己的配置参数，而只使用来自 Args 的参数。 危险选项；谨慎使用。 默认值为 false。

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

    如果为 true，Playwright 不会传递它自己的配置参数，而只使用来自 Args 的参数。 危险选项；谨慎使用。

  • 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 代理需要身份验证。

    网络代理设置。

  • SlowMo [float]? (可选)#

    以指定的毫秒数减慢 Playwright 操作。 有助于您查看正在发生的事情。

  • Timeout [float]? (可选)#

    浏览器实例启动等待的最大时间（毫秒）。 默认值为 30000（30 秒）。 传递 0 来禁用超时。

  • TracesDir string? (可选)#

    如果指定，跟踪将保存到此目录中。

返回

• Browser#

---

LaunchPersistentContextAsync

在 v1.9 之前添加 browserType.LaunchPersistentContextAsync

返回持久浏览器上下文实例。

启动使用位于 userDataDir 的持久存储的浏览器，并返回唯一的上下文。 关闭此上下文将自动关闭浏览器。

用法

await BrowserType.LaunchPersistentContextAsync(userDataDir, options);

参数

• userDataDir string#

  用户数据目录的路径，用于存储浏览器会话数据，例如 Cookie 和本地存储。 更多关于 Chromium 和 Firefox 的细节。 请注意，Chromium 的用户数据目录是 chrome://version 中显示的“配置文件路径”的**父**目录。 传递空字符串以使用临时目录。

• options BrowserTypeLaunchPersistentContextOptions? (可选)

  • AcceptDownloads bool? (可选)#

    是否自动下载所有附件。 默认值为 true，所有下载都被接受。

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

    警告

    自行承担使用自定义浏览器参数的风险，因为其中一些参数可能会破坏 Playwright 功能。

    要传递给浏览器实例的其他参数。Chromium 标志列表可以在 此处 找到。

  • BaseURL string? (可选)#

    使用 Page.GotoAsync()、Page.RouteAsync()、Page.WaitForURLAsync()、Page.RunAndWaitForRequestAsync() 或 Page.RunAndWaitForResponseAsync() 时，它会考虑基本 URL，使用 URL() 构造函数来构建相应的 URL。 默认情况下未设置。 示例

    • baseURL: https://127.0.0.1:3000 并且导航到 /bar.html 将导致 https://127.0.0.1:3000/bar.html
    • baseURL: https://127.0.0.1:3000/foo/ 并且导航到 ./bar.html 将导致 https://127.0.0.1:3000/foo/bar.html
    • baseURL: https://127.0.0.1:3000/foo（没有尾部斜杠）并且导航到 ./bar.html 将导致 https://127.0.0.1:3000/bar.html

  • BypassCSP bool? (可选)#

    切换是否绕过页面的内容安全策略。 默认值为 false。

  • Channel string? (可选)#

    浏览器分发渠道。支持的值为“chrome”、“chrome-beta”、“chrome-dev”、“chrome-canary”、“msedge”、“msedge-beta”、“msedge-dev”、“msedge-canary”。详细了解如何使用 Google Chrome 和 Microsoft Edge。

  • ChromiumSandbox bool? (可选)#

    启用 Chromium 沙盒。默认为 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'、'no-preference'。 有关更多详细信息，请参阅 Page.EmulateMediaAsync()。 传递 'null' 将模拟重置为系统默认值。 默认值为 'light'。

  • DeviceScaleFactor [float]? (可选)#

    指定设备缩放因子（可以认为是 dpr）。 默认值为 1。 了解更多关于 使用设备缩放因子模拟设备 的信息。

  • Devtools bool? (可选)#

    已弃用

    改用 调试工具。

    仅限 Chromium 是否为每个标签自动打开开发者工具面板。如果此选项为 true，则 无头 选项将设置为 false。

  • DownloadsPath string? (可选)#

    如果指定，接受的下载将下载到此目录中。否则，将创建临时目录，并在关闭浏览器时将其删除。无论哪种情况，在关闭创建它们的浏览器上下文时，下载都会被删除。

  • Env IDictionary?<string, string> (可选)#

    指定浏览器可见的环境变量。默认为 process.env。

  • ExecutablePath string? (可选)#

    浏览器可执行文件路径，用于运行而不是捆绑的浏览器。如果 ExecutablePath 是相对路径，则它相对于当前工作目录解析。请注意，Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit，自行使用风险自负。

  • ExtraHTTPHeaders IDictionary?<string, string> (可选)#

    包含要与每个请求一起发送的附加 HTTP 标头的对象。默认为无。

  • FirefoxUserPrefs IDictionary?<string, [object]> (可选)添加于：v1.40#

    Firefox 用户偏好设置。 了解更多关于 Firefox 用户偏好设置的信息，请访问 about:config.

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

  • HandleSIGHUP bool? (可选)#

    在 SIGHUP 时关闭浏览器进程。 默认值为 true。

  • HandleSIGINT bool? (可选)#

    在 Ctrl-C 时关闭浏览器进程。 默认值为 true。

  • HandleSIGTERM bool? (可选)#

    在 SIGTERM 时关闭浏览器进程。 默认值为 true。

  • HasTouch bool? (可选)#

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

  • Headless bool? (可选)#

    是否以无头模式运行浏览器。 更多关于 Chromium 和 Firefox 的细节。 默认值为 true，除非 Devtools 选项为 true。

  • 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 身份验证 的凭据。如果未指定来源，则在未经授权的响应后，用户名和密码将发送到任何服务器。

  • IgnoreAllDefaultArgs bool? (可选)在 v1.9 中添加#

    如果为 true，Playwright 不会传递自己的配置参数，而只使用来自 Args 的参数。危险选项；谨慎使用。默认为 false。

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

    如果为 true，Playwright 不会传递自己的配置参数，而只使用来自 Args 的参数。危险选项；谨慎使用。

  • 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

      视频帧高度。

    录制视频的尺寸。如果未指定，则大小将等于缩放到 800x800 以内的 viewport。如果未明确配置 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 }? (可选)#

    是否允许站点注册服务工作者。默认为 'allow'。

    • 'allow': 可以注册 服务工作者。
    • 'block': Playwright 将阻止所有服务工作者的注册。

  • SlowMo [float]? (可选)#

    以指定的毫秒数减慢 Playwright 操作。 有助于您查看正在发生的事情。

  • StrictSelectors bool? (可选)#

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

  • Timeout [float]? (可选)#

    浏览器实例启动等待的最大时间（毫秒）。 默认值为 30000（30 秒）。 传递 0 来禁用超时。

  • TimezoneId string? (可选)#

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

  • TracesDir string? (可选)#

    如果指定，跟踪将保存到此目录中。

  • UserAgent string? (可选)#

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

  • ViewportSize ViewportSize? (可选)#

    • Width int

      页面宽度（以像素为单位）。

    • Height int

      页面高度（以像素为单位）。

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

    注意

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

返回

• BrowserContext#

---

名称

在 v1.9 之前添加 browserType.Name

返回浏览器名称。例如：'chromium'、'webkit' 或 'firefox'。

用法

BrowserType.Name

返回

• string#