BrowserType

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 附加到通过 Node.js 中的 BrowserType.launchServer 创建的现有浏览器实例。

注意

连接的 Playwright 实例的主版本和次版本需要与启动浏览器的 Playwright 版本匹配 (1.2.3 → 与 1.2.x 兼容)。

用法

await BrowserType.ConnectAsync(wsEndpoint, options);

参数

wsEndpoint string添加于: v1.10#

Playwright 浏览器 WebSocket 端点用于连接。您可以通过 BrowserServer.wsEndpoint 获取此端点。
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（无超时）。

返回值

Browser #

ConnectOverCDPAsync

添加于: v1.9

browserType.ConnectOverCDPAsync

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

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

注意

仅支持基于 Chromium 的浏览器使用 Chrome DevTools Protocol 进行连接。

注意

此连接的保真度远低于通过 BrowserType.ConnectAsync() 进行的 Playwright 协议连接。如果您遇到问题或尝试使用高级功能，建议您使用 BrowserType.ConnectAsync()。

用法

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

参数

endpointURL string添加于: v1.11#

CDP WebSocket 端点或用于连接的 HTTP URL。例如 http://localhost: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 可禁用超时。

返回值

Browser #

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 或 Dev Channel 版本。

像 Google Chrome 和 Microsoft Edge 这样的标准浏览器适用于需要专有媒体编解码器进行视频播放的测试。请参阅这篇文章了解 Chromium 和 Chrome 之间的其他区别。这篇文章描述了一些针对 Linux 用户的区别。

参数

options BrowserTypeLaunchOptions? (可选)
- Args IEnumerable?<string> (可选)#
  
  警告
  使用自定义浏览器参数需自行承担风险，因为其中一些参数可能会破坏 Playwright 的功能。
  
  传递给浏览器实例的额外参数。Chromium 标志列表可在此处找到：此处。
- Channel string? (可选)#
  
  浏览器分发渠道。
  
  使用 "chromium" 选择使用新的无头模式。
  
  使用 "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 用户首选项。通过 about:config 了解更多关于 Firefox 用户首选项的信息。
- HandleSIGHUP bool? (可选)#
  
  在接收到 SIGHUP 信号时关闭浏览器进程。默认为 true。
- HandleSIGINT bool? (可选)#
  
  在接收到 Ctrl-C (SIGINT) 信号时关闭浏览器进程。默认为 true。
- HandleSIGTERM bool? (可选)#
  
  在接收到 SIGTERM 信号时关闭浏览器进程。默认为 true。
- Headless bool? (可选)#
  
  是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。除非 Devtools 选项为 true，否则默认为 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 中显示的 "Profile Path" 的父目录。

请注意，浏览器不允许使用相同的用户数据目录启动多个实例。
options BrowserTypeLaunchPersistentContextOptions? (可选)
- AcceptDownloads bool? (可选)#
  
  是否自动下载所有附件。默认为 true，此时所有下载都将被接受。
- Args IEnumerable?<string> (可选)#
  
  警告
  使用自定义浏览器参数需自行承担风险，因为其中一些参数可能会破坏 Playwright 的功能。
  
  传递给浏览器实例的额外参数。Chromium 标志列表可在此处找到：此处。
- BaseURL string? (可选)#
  
  使用 Page.GotoAsync()、Page.RouteAsync()、Page.WaitForURLAsync()、Page.RunAndWaitForRequestAsync() 或 Page.RunAndWaitForResponseAsync() 时，它会使用 URL() 构造函数来构建相应的 URL，并考虑 baseURL。默认未设置。示例
  - 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。
- Channel string? (可选)#
  
  浏览器分发渠道。
  
  使用 "chromium" 选择使用新的无头模式。
  
  使用 "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
    
    证书有效的确切 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 客户端认证允许服务器请求客户端证书并进行验证。
  
  详情
  
  要使用的客户端证书数组。每个证书对象必须同时具有 certPath 和 keyPath，或单独的 pfxPath，或其对应的直接值（cert 和 key，或 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。详细了解如何通过设备比例因子模拟设备。
- Devtools bool? (可选)#
  
  已弃用
  请改用调试工具。
  
  仅限于 Chromium 是否为每个标签页自动打开开发者工具面板。如果此选项为 true，则 Headless 选项将设置为 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 用户首选项。通过 about:config 了解更多关于 Firefox 用户首选项的信息。
- 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 (SIGINT) 信号时关闭浏览器进程。默认为 true。
- HandleSIGTERM bool? （可选）#
  
  在接收到 SIGTERM 信号时关闭浏览器进程。默认为 true。
- HasTouch bool? （可选）#
  
  指定视口是否支持触摸事件。默认为 false。了解更多关于移动设备模拟的信息。
- Headless bool? （可选）#
  
  是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。除非 Devtools 选项为 true，否则默认为 true。
- 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，用户名和密码将发送到任何未经授权响应的服务器。
- IgnoreAllDefaultArgs bool? (可选)添加于: v1.9#
  
  如果为 true，Playwright 将不传递其自己的配置 args，仅使用来自 Args 的配置。危险选项；请谨慎使用。默认为 false。
- IgnoreDefaultArgs IEnumerable?<string> （可选）#
  
  如果为 true，Playwright 将不传递其自身的配置参数，而只使用 Args 中的参数。危险选项；请谨慎使用。
- IgnoreHTTPSErrors bool? （可选）#
  
  发送网络请求时是否忽略 HTTPS 错误。默认为 false。
- IsMobile bool? （可选）#
  
  是否考虑 meta viewport 标签并启用触摸事件。isMobile 是 device 的一部分，所以实际上无需手动设置。默认为 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 Worker 可以注册。
  - 'block'：Playwright 将阻止所有 Service Worker 的注册。
- SlowMo [float]? （可选）#
  
  按照指定的毫秒数减慢 Playwright 操作。有助于您观察正在发生的事情。
- StrictSelectors bool? （可选）#
  
  如果设置为 true，则为此上下文启用严格选择器模式。在严格选择器模式下，当选择器匹配到多个元素时，对那些隐含单个目标 DOM 元素的选择器的所有操作都将抛出异常。此选项不影响任何 Locator API（Locator 始终是严格的）。默认为 false。请参阅 Locator 以了解更多关于严格模式的信息。
- Timeout [float]? （可选）#
  
  等待浏览器实例启动的最大毫秒数。默认为 30000 (30 秒)。传递 0 可禁用超时。
- TimezoneId string? （可选）#
  
  更改上下文的时区。请参阅 ICU 的 metaZones.txt 获取支持的时区 ID 列表。默认为系统时区。
- 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 #

方法​

ConnectAsync​

ConnectOverCDPAsync​

ExecutablePath​

LaunchAsync​

LaunchPersistentContextAsync​

名称​

方法

ConnectAsync

ConnectOverCDPAsync

ExecutablePath

LaunchAsync

LaunchPersistentContextAsync

名称