BrowserType

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

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType chromium = playwright.chromium();
      Browser browser = chromium.launch();
      Page page = browser.newPage();
      page.navigate("https://example.com");
      // other actions...
      browser.close();
    }
  }
}

方法

连接

Added before v1.9

browserType.connect

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

note

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

用法

BrowserType.connect(wsEndpoint);
BrowserType.connect(wsEndpoint, options);

参数

wsEndpoint String 添加于: v1.10 #

用于连接的Playwright浏览器websocket端点。您可以通过BrowserServer.wsEndpoint获取此端点。
options BrowserType.ConnectOptions (可选)
- setExposeNetwork 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>" 用于暴露测试/预发布部署环境和本地主机。
- setHeaders Map<String, String> (可选) 添加于: v1.11 #
  
  与WebSocket连接请求一起发送的额外HTTP头信息。可选。
- setSlowMo double (可选) 添加于: v1.10 #
  
  将Playwright操作速度减慢指定的毫秒数。有助于观察操作过程。默认为0。
- setTimeout double (可选) v1.10版本新增 #
  
  等待连接建立的最大毫秒数。默认为0(无超时)。

Browser #

connectOverCDP

Added in: v1.9

browserType.connectOverCDP

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

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

note

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

note

此连接的保真度明显低于通过BrowserType.connect()建立的Playwright协议连接。如果您遇到问题或尝试使用高级功能，您可能需要使用BrowserType.connect()。

用法

Browser browser = playwright.chromium().connectOverCDP("http://localhost:9222");
BrowserContext defaultContext = browser.contexts().get(0);
Page page = defaultContext.pages().get(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 BrowserType.ConnectOverCDPOptions (可选)
- setHeaders Map<String, String> (可选) 添加于: v1.11 #
  
  随连接请求一起发送的额外HTTP头信息。可选。
- setSlowMo double (可选) 添加于: v1.11 #
  
  将Playwright操作速度减慢指定的毫秒数。这个功能很有用，可以让你看清发生了什么。默认为0。
- setTimeout double (可选) 添加于: v1.11 #
  
  等待连接建立的最大毫秒数。默认为30000(30秒)。传入0表示禁用超时。

Browser #

executablePath

Added before v1.9

browserType.executablePath

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

用法

BrowserType.executablePath();

String #

启动

Added before v1.9

browserType.launch

返回浏览器实例。

用法

你可以使用setIgnoreDefaultArgs来过滤掉默认参数中的--mute-audio：

// Or "firefox" or "webkit".
Browser browser = chromium.launch(new BrowserType.LaunchOptions()
  .setIgnoreDefaultArgs(Arrays.asList("--mute-audio")));

仅限Chromium Playwright 也可用于控制Google Chrome或Microsoft Edge浏览器，但它与捆绑的Chromium版本配合效果最佳。不保证能与其他版本兼容。请极其谨慎地使用setExecutablePath选项。

如果更倾向于使用Google Chrome（而非Chromium），建议使用Chrome Canary或Dev Channel版本。

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

参数

options BrowserType.LaunchOptions (optional)
- setArgs List<String> (可选)#
  
  警告
  使用自定义浏览器参数需自行承担风险，因为其中某些参数可能会破坏Playwright的功能。
  
  传递给浏览器实例的额外参数。Chromium标志列表可以在这里找到。
- setChannel String (可选)#
  
  浏览器分发渠道。
  
  使用"chromium"以选择加入新的无头模式。
  
  使用"chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev"或"msedge-canary"来使用品牌化的Google Chrome和Microsoft Edge。
- setChromiumSandbox boolean (可选)#
  
  启用Chromium沙箱功能。默认为false。
- setDevtools boolean (可选)#
  
  已弃用
  请改用 debugging tools。
  
  仅限Chromium 是否自动为每个标签页打开开发者工具面板。如果此选项设为true，则setHeadless选项将被设为false。
- setDownloadsPath Path (可选)#
  
  如果指定，已接受的下载将保存到此目录。否则会创建临时目录并在浏览器关闭时删除。无论哪种情况，当创建下载的浏览器上下文关闭时，下载文件都会被删除。
- setEnv Map<String, String> (可选)#
  
  指定浏览器可见的环境变量。默认为 process.env。
- setExecutablePath Path (可选)#
  
  指定浏览器可执行文件的路径以替代捆绑的浏览器。如果setExecutablePath是相对路径，则相对于当前工作目录解析。请注意Playwright仅适用于捆绑的Chromium、Firefox或WebKit，使用需自行承担风险。
- setFirefoxUserPrefs Map<String, Object> (可选)#
  
  Firefox用户首选项。了解更多关于Firefox用户首选项的信息，请访问about:config。
- setHandleSIGHUP boolean (可选)#
  
  在SIGHUP信号时关闭浏览器进程。默认为true。
- setHandleSIGINT boolean (可选)#
  
  在Ctrl-C时关闭浏览器进程。默认为true。
- setHandleSIGTERM boolean (可选)#
  
  在SIGTERM信号时关闭浏览器进程。默认为true。
- setHeadless boolean (可选)#
  
  是否以无头模式运行浏览器。关于Chromium和Firefox的更多细节。默认为true，除非setDevtools选项为true。
- setIgnoreAllDefaultArgs boolean (可选) 添加于: v1.9 #
  
  如果设为true，Playwright将不会传递自身的配置参数，仅使用来自setArgs的参数。此为危险选项，请谨慎使用。默认为false。
- setIgnoreDefaultArgs List<String> (可选)#
  
  如果设为true，Playwright将不会传递自身的配置参数，仅使用setArgs提供的参数。这是一个危险选项，请谨慎使用。
- setProxy 代理 (可选)#
  - setServer String
    
    用于所有请求的代理服务器。支持HTTP和SOCKS代理，例如http://myproxy.com:3128或socks5://myproxy.com:3128。简写形式myproxy.com:3128会被视为HTTP代理。
  - setBypass String (可选)
    
    可选的要绕过代理的逗号分隔域名，例如 ".com, chromium.org, .domain.com"。
  - setUsername String (可选)
    
    如果HTTP代理需要认证时使用的可选用户名。
  - setPassword String (可选)
    
    如果HTTP代理需要认证时可选的密码。
  网络代理设置。
- setSlowMo double (可选参数)#
  
  将Playwright操作速度减慢指定的毫秒数。这个功能很有用，可以让你看清操作过程。
- setTimeout double (可选)#
  
  等待浏览器实例启动的最大毫秒数。默认为30000(30秒)。传入0表示禁用超时。
- setTracesDir Path (可选)#
  
  如果指定，跟踪记录将保存到此目录中。

Browser #

launchPersistentContext

Added before v1.9

browserType.launchPersistentContext

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

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

用法

BrowserType.launchPersistentContext(userDataDir);
BrowserType.launchPersistentContext(userDataDir, options);

参数

userDataDir Path #

用户数据目录的路径，该目录存储浏览器会话数据，如cookies和本地存储。更多详情请参考Chromium和Firefox。请注意，Chromium的用户数据目录是chrome://version页面中看到的"Profile Path"的父目录。传入空字符串则使用临时目录替代。
options BrowserType.LaunchPersistentContextOptions (可选)
- setAcceptDownloads boolean (可选)#
  
  是否自动下载所有附件。默认为true，表示接受所有下载。
- setArgs List<String> (可选)#
  
  警告
  使用自定义浏览器参数需自行承担风险，因为其中某些参数可能会破坏Playwright的功能。
  
  传递给浏览器实例的额外参数。Chromium标志列表可以在这里找到。
- setBaseURL String (可选)#
  
  当使用Page.navigate()、Page.route()、Page.waitForURL()、Page.waitForRequest()或Page.waitForResponse()时，它会通过使用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
- setBypassCSP boolean (可选)#
  
  切换是否绕过页面的内容安全策略。默认为false。
- setChannel String (可选)#
  
  浏览器分发渠道。
  
  使用"chromium"以选择加入新的无头模式。
  
  使用"chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev"或"msedge-canary"来使用品牌化的Google Chrome和Microsoft Edge。
- setChromiumSandbox boolean (可选)#
  
  启用Chromium沙箱功能。默认为false。
- setClientCertificates List (可选) 添加于: 1.46 #
  - setOrigin String
    
    证书有效的精确来源。来源包括https协议、主机名以及可选的端口。
  - setCertPath Path (可选)
    
    PEM格式证书文件的路径。
  - setCert byte[] (可选)
    
    PEM格式证书的直接值。
  - setKeyPath Path (可选)
    
    包含PEM格式私钥的文件路径。
  - setKey byte[] (可选)
    
    PEM格式私钥的直接值。
  - setPfxPath Path (可选)
    
    PFX或PKCS12编码的私钥和证书链的路径。
  - setPfx byte[] (可选)
    
    PFX或PKCS12编码的私钥和证书链的直接值。
  - setPassphrase String (可选)
    
    私钥的密码短语(PEM或PFX格式)。
  TLS客户端认证允许服务器请求客户端证书并进行验证。
  
  详情
  
  要使用的客户端证书数组。每个证书对象必须包含certPath和keyPath两者，或者单独的pfxPath，或者它们对应的直接值等价物（cert和key，或者pfx）。如果证书已加密，可以选择提供passphrase属性。origin属性应提供与证书适用的请求来源完全匹配的值。
  
  note
  在macOS上使用WebKit时，访问localhost将无法获取客户端证书。您可以通过将localhost替换为local.playwright来解决此问题。
- setColorScheme null | enum ColorScheme { LIGHT, DARK, NO_PREFERENCE } (可选)#
  
  模拟prefers-colors-scheme媒体特性，支持的值为'light'和'dark'。详情请参阅Page.emulateMedia()。传入null会将模拟重置为系统默认值。默认为'light'。
- setContrast null | enum Contrast { NO_PREFERENCE, MORE } (可选)#
  
  模拟'prefers-contrast'媒体特性，支持的值为'no-preference'、'more'。详情请参阅Page.emulateMedia()。传入null会将模拟重置为系统默认值。默认为'no-preference'。
- setDeviceScaleFactor double (可选)#
  
  指定设备缩放比例(可视为dpr)。默认为1。了解更多关于使用设备缩放比例模拟设备的信息。
- setDevtools boolean (可选)#
  
  已弃用
  请改用 debugging tools。
  
  仅限Chromium 是否自动为每个标签页打开开发者工具面板。如果此选项设为true，则setHeadless选项将被设为false。
- setDownloadsPath Path (可选)#
  
  如果指定，已接受的下载将保存到此目录。否则会创建临时目录并在浏览器关闭时删除。无论哪种情况，当创建下载的浏览器上下文关闭时，下载文件都会被删除。
- setEnv Map<String, String> (可选)#
  
  指定浏览器可见的环境变量。默认为 process.env。
- setExecutablePath Path (可选)#
  
  指定浏览器可执行文件的路径以替代捆绑的浏览器。如果setExecutablePath是相对路径，则相对于当前工作目录解析。请注意Playwright仅适用于捆绑的Chromium、Firefox或WebKit，使用需自行承担风险。
- setExtraHTTPHeaders Map<String, String> (可选)#
  
  一个包含要随每个请求发送的额外HTTP头的对象。默认为无。
- setFirefoxUserPrefs Map<String, Object> (可选) 添加于: v1.40 #
  
  Firefox用户首选项。了解更多关于Firefox用户首选项的信息，请访问about:config。
- setForcedColors null | enum ForcedColors { ACTIVE, NONE } (可选)#
  
  模拟'forced-colors'媒体特性，支持的值为'active'、'none'。详情请参阅Page.emulateMedia()。传入null会将模拟重置为系统默认值。默认为'none'。
- setGeolocation 地理位置 (可选)#
  - setLatitude double
    
    纬度值范围在-90到90之间。
  - setLongitude double
    
    经度值介于-180到180之间。
  - setAccuracy double (可选)
    
    非负精度值。默认为 0。
- setHandleSIGHUP boolean (可选)#
  
  在SIGHUP信号时关闭浏览器进程。默认为true。
- setHandleSIGINT boolean (可选)#
  
  在Ctrl-C时关闭浏览器进程。默认为true。
- setHandleSIGTERM boolean (可选)#
  
  在SIGTERM信号时关闭浏览器进程。默认为true。
- setHasTouch boolean (可选)#
  
  指定视口是否支持触摸事件。默认为false。了解更多关于移动设备模拟的信息。
- setHeadless boolean (可选)#
  
  是否以无头模式运行浏览器。关于Chromium和Firefox的更多细节。默认为true，除非setDevtools选项为true。
- setHttpCredentials HttpCredentials (可选)#
  - setUsername String
  - setPassword String
  - setOrigin String (可选)
    
    限制在特定来源(scheme://host:port)上发送HTTP凭据。
  - setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS } (可选)
    
    此选项仅适用于从对应的APIRequestContext发送的请求，不会影响从浏览器发送的请求。'always' - 带有基本认证凭据的Authorization头部将随每个API请求一起发送。'unauthorized' - 仅当收到带有WWW-Authenticate头部的401(未授权)响应时才发送凭据。默认为'unauthorized'。
  HTTP认证的凭据。如果未指定来源，则在收到未经授权的响应时，用户名和密码将被发送到任何服务器。
- setIgnoreAllDefaultArgs boolean (可选) 添加于: v1.9 #
  
  如果设为true，Playwright将不会传递自身的配置参数，仅使用来自setArgs的参数。此为危险选项，请谨慎使用。默认为false。
- setIgnoreDefaultArgs List<String> (可选)#
  
  如果设为true，Playwright将不会传递自身的配置参数，仅使用setArgs提供的参数。这是一个危险选项，请谨慎使用。
- setIgnoreHTTPSErrors boolean (可选)#
  
  发送网络请求时是否忽略HTTPS错误。默认为false。
- setIsMobile boolean (可选)#
  
  是否考虑meta viewport标签并启用触摸事件。isMobile是设备的一部分，因此您实际上不需要手动设置它。默认为false且在Firefox中不受支持。了解更多关于移动设备模拟的信息。
- setJavaScriptEnabled boolean (可选)#
  
  是否在上下文中启用JavaScript。默认为true。了解更多关于禁用JavaScript的信息。
- setLocale String (optional)#
  
  指定用户区域设置，例如en-GB、de-DE等。区域设置会影响navigator.language值、Accept-Language请求头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的模拟指南中了解更多关于模拟的信息。
- setOffline boolean (可选)#
  
  是否模拟网络离线状态。默认为false。了解更多关于网络模拟的信息。
- setPermissions List<String> (可选)#
  
  授予此上下文中所有页面的权限列表。详情请参阅BrowserContext.grantPermissions()。默认为无。
- setProxy 代理 (可选)#
  - setServer String
    
    用于所有请求的代理服务器。支持HTTP和SOCKS代理，例如http://myproxy.com:3128或socks5://myproxy.com:3128。简写形式myproxy.com:3128会被视为HTTP代理。
  - setBypass String (可选)
    
    可选的要绕过代理的逗号分隔域名，例如 ".com, chromium.org, .domain.com"。
  - setUsername String (可选)
    
    如果HTTP代理需要认证时使用的可选用户名。
  - setPassword String (可选)
    
    如果HTTP代理需要认证时可选的密码。
  网络代理设置。
- setRecordHarContent enum HarContentPolicy { OMIT, EMBED, ATTACH } (可选)#
  
  用于控制资源内容管理的可选设置。如果指定omit，则不会持久化内容。如果指定attach，资源将作为单独文件持久化，并且所有这些文件将与HAR文件一起归档。默认为embed，根据HAR规范将内容内联存储在HAR文件中。
- setRecordHarMode enum HarMode { FULL, MINIMAL } (可选)#
  
  当设置为minimal时，仅记录从HAR路由所必需的信息。这会省略大小、时间、页面、cookies、安全和其他类型的HAR信息，这些信息在从HAR回放时不会被使用。默认为full。
- setRecordHarOmitContent boolean (可选)#
  
  可选设置，用于控制是否从HAR中省略请求内容。默认为false。
- setRecordHarPath Path (可选)#
  
  启用HAR记录，将所有页面的操作记录到文件系统中指定的HAR文件。如果未指定，则不会记录HAR。请确保调用BrowserContext.close()以保存HAR。
- setRecordHarUrlFilter String | Pattern (可选)#
- setRecordVideoDir Path (可选)#
  
  为所有页面启用视频录制到指定目录。如果未指定则不会录制视频。请确保调用BrowserContext.close()以保存视频。
- setRecordVideoSize RecordVideoSize (可选)#
  - setWidth int
    
    视频帧宽度。
  - setHeight int
    
    视频帧高度。
  录制视频的尺寸。如果未指定，大小将等于viewport按比例缩小以适应800x800。如果未明确配置viewport，视频尺寸默认为800x450。每个页面的实际画面将根据需要按比例缩小以适应指定尺寸。
- setReducedMotion null | enum ReducedMotion { REDUCE, NO_PREFERENCE } (可选)#
  
  模拟'prefers-reduced-motion'媒体特性，支持的值为'reduce'、'no-preference'。详情请参阅Page.emulateMedia()。传入null会将模拟重置为系统默认值。默认为'no-preference'。
- setScreenSize 屏幕尺寸 (可选)#
  - setWidth int
    
    页面宽度，单位为像素。
  - setHeight int
    
    页面高度，单位为像素。
  通过window.screen模拟网页内可用的固定窗口屏幕尺寸。仅在设置setViewportSize时使用。
- setServiceWorkers enum ServiceWorkerPolicy { ALLOW, BLOCK } (可选)#
  
  是否允许网站注册Service workers。默认为'allow'。
  - 'allow': 可以注册Service Workers。
  - 'block': Playwright 将阻止所有 Service Workers 的注册。
- setSlowMo double (可选参数)#
  
  将Playwright操作速度减慢指定的毫秒数。这个功能很有用，可以让你看清操作过程。
- setStrictSelectors boolean (可选)#
  
  如果设置为true，为此上下文启用严格选择器模式。在严格选择器模式下，所有暗示单个目标DOM元素的选择器操作在匹配到多个元素时都会抛出异常。此选项不会影响任何Locator API（Locator始终是严格的）。默认为false。有关严格模式的更多信息，请参阅Locator。
- setTimeout double (可选)#
  
  等待浏览器实例启动的最大毫秒数。默认为30000(30秒)。传入0表示禁用超时。
- setTimezoneId String (optional)#
  
  更改上下文的时区。支持的时区ID列表请参见ICU's metaZones.txt。默认为系统时区。
- setTracesDir Path (可选)#
  
  如果指定，跟踪记录将保存到此目录中。
- setUserAgent String (可选)#
  
  在此上下文中使用的特定用户代理。
- setViewportSize null | 视口尺寸 (可选)#
  - setWidth int
    
    页面宽度，单位为像素。
  - setHeight int
    
    页面高度，单位为像素。
  为每个页面模拟一致的视口。默认视口尺寸为1280x720。使用null可禁用一致的视口模拟。了解更多关于视口模拟的信息。
  
  note
  null值表示不使用默认预设，使视口大小取决于操作系统定义的主机窗口尺寸。这会导致测试执行变得非确定性。

BrowserContext #

名称

Added before v1.9

browserType.name

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

用法

BrowserType.name();

String #

方法​

连接​

connectOverCDP​

executablePath​

启动​

launchPersistentContext​

名称​

方法

连接

connectOverCDP

executablePath

启动

launchPersistentContext

名称