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");
        // 其他操作
        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>" 暴露本地主机网络。
  3. "*.test.internal-domain,*.staging.internal-domain,<loopback>" 暴露测试/预发布部署和本地主机。
- 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 协议将 Playwright 附加到现有浏览器实例。

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

备注

仅基于 Chromium 的浏览器支持通过 Chrome DevTools 协议进行连接。

备注

与通过 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 时关闭浏览器进程。默认为 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 中显示的 “配置文件路径” 的父目录。

请注意，浏览器不允许使用相同的用户数据目录启动多个实例。
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。默认未设置。示例：
  - 基本 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?（可选）#
  
  切换是否绕过页面的内容安全策略。默认值为 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
    
    证书适用的精确源。源包括 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。了解更多关于使用设备缩放因子模拟设备的信息。
- 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 时关闭浏览器进程。默认值为 true。
- HandleSIGTERM bool?（可选）#
  
  在接收到 SIGTERM 信号时关闭浏览器进程。默认值为 true。
- HasTouch bool?（可选）#
  
  指定视口是否支持触摸事件。默认值为 false。了解更多关于移动设备模拟的信息。
- Headless bool?（可选）#
  
  是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。除非 Devtools 选项为 true，否则默认值为 true。
- HttpCredentials HttpCredentials?（可选）#
  - Username string
  - `

返回值

BrowserContext #

Name

在 v1.9 之前添加

browserType.Name

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

用法

BrowserType.Name

返回值

string #

方法​

ConnectAsync​

ConnectOverCDPAsync​

参数​

返回值​

ExecutablePath​

LaunchAsync​

用法​

LaunchPersistentContextAsync​

参数​

Name​

方法

ConnectAsync

ConnectOverCDPAsync

参数

返回值

ExecutablePath

LaunchAsync

用法

LaunchPersistentContextAsync

参数

Name