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​

此方法将Playwright附加到通过Node.js中的BrowserType.launchServer创建的现有浏览器实例。

用法

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​

此方法使用Chrome开发者工具协议将Playwright附加到现有的浏览器实例上。

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

用法

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#

可执行路径​

Playwright预期查找捆绑浏览器可执行文件的路径。

用法

BrowserType.ExecutablePath

返回

• string#

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? (optional)

  • 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用户首选项。了解更多关于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 代理? (可选)#

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

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

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

用法

await BrowserType.LaunchPersistentContextAsync(userDataDir, options);

参数

• userDataDir string#

  用户数据目录路径，用于存储浏览器会话数据，如cookies和本地存储。更多详情请参考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，同时考虑基础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。

  • 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? (可选) 添加于: 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属性应提供与证书适用的请求来源完全匹配的值。

    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。了解更多关于使用设备缩放比例模拟设备的信息。

  • 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用户偏好设置。了解更多关于Firefox用户偏好的信息，请访问about:config。

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

  • 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中不受支持。了解更多关于mobile emulation的信息。

  • JavaScriptEnabled bool? (可选)#

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

  • Locale string? (可选)#

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

  • Offline bool? (可选)#

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

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

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

  • 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路由所必需的信息。这会省略大小、时间、页面、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 的注册。

  • SlowMo [float]? (可选)#

    将Playwright操作速度减慢指定的毫秒数。这样您就可以看清发生了什么。

  • StrictSelectors bool? (可选)#

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

  • Timeout [float]? (可选)#

    等待浏览器实例启动的最大毫秒数。默认为 30000 (30秒)。传入 0 表示禁用超时。

  • TimezoneId string? (可选)#

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

  • TracesDir string? (可选)#

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

  • UserAgent string? (可选)#

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

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

    • Width int

      页面宽度，单位为像素。

    • Height int

      页面高度，单位为像素。

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

    note

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

返回

• BrowserContext#

名称​

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

用法

BrowserType.Name

返回

• string#