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();
}
}
}
方法
connect
v1.9 之前添加此方法将 Playwright 附加到通过 Node.js 中的 BrowserType.launchServer 创建的现有浏览器实例。
连接的 Playwright 实例的主版本和次版本需要与启动浏览器的 Playwright 版本匹配(1.2.3 → 兼容 1.2.x)。
用法
BrowserType.connect(endpoint);
BrowserType.connect(endpoint, options);
参数
-
要连接的 Playwright 浏览器 WebSocket 端点。您可以通过
BrowserServer.wsEndpoint获取此端点。 -
optionsBrowserType.ConnectOptions(可选)-
setExposeNetworkString (可选)新增于:v1.37#此选项将连接客户端上可用的网络暴露给要连接的浏览器。由逗号分隔的规则列表组成。
可用规则
- 主机名模式,例如:
example.com、*.org:99、x.*.y.com、*foo.org。 - IP 字面量,例如:
127.0.0.1、0.0.0.0:99、[::1]、[0:0::1]:99。 <loopback>匹配本地回环接口:localhost、*.localhost、127.0.0.1、[::1]。
一些常见示例
"*"暴露所有网络。"<loopback>"暴露本地网络。"*.test.internal-domain,*.staging.internal-domain,<loopback>"暴露测试/预发布部署和本地主机。
- 主机名模式,例如:
-
setHeadersMap<String, String> (可选)添加于:v1.11#要随 WebSocket 连接请求发送的额外 HTTP 头。可选。
-
setSlowModouble (可选)新增于: v1.10#将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。默认为 0。
-
setTimeoutdouble (可选)新增于: v1.10#等待连接建立的最大时间(毫秒)。默认为
0(无超时)。
-
返回
connectOverCDP
添加于:v1.9此方法使用 Chrome DevTools 协议将 Playwright 附加到现有浏览器实例。
默认浏览器上下文可通过 Browser.contexts() 访问。
通过 Chrome DevTools 协议连接仅支持基于 Chromium 的浏览器。
此连接的保真度明显低于通过 BrowserType.connect() 建立的 Playwright 协议连接。如果您遇到问题或尝试使用高级功能,建议使用 BrowserType.connect()。
用法
Browser browser = playwright.chromium().connectOverCDP("https://:9222");
BrowserContext defaultContext = browser.contexts().get(0);
Page page = defaultContext.pages().get(0);
参数
-
要连接的 CDP WebSocket 端点或 HTTP URL。例如
https://:9222/或ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4。 -
optionsBrowserType.ConnectOverCDPOptions(可选)-
setArtifactsDirPath (可选)添加于:v1.61#如果指定,浏览器产物(如追踪记录和下载文件)将被保存到此目录中。
-
setHeadersMap<String, String> (可选)添加于:v1.11#要随连接请求发送的额外 HTTP 头。可选。
-
setIsLocalboolean (可选)添加于: v1.58#告诉 Playwright 它与 CDP 服务器运行在同一台主机上。它将启用某些依赖于 Playwright 和浏览器之间文件系统相同的优化。
-
setNoDefaultsboolean (可选)添加于: v1.60#当为 true 时,Playwright 不会将默认覆盖应用于现有的默认浏览器上下文。具体来说,setAcceptDownloads 将保持浏览器原有的设置,焦点模拟功能不会被启用,媒体模拟选项(例如 setColorScheme, setReducedMotion, setForcedColors 和 setContrast)也不会被应用。这在附加到用户的日常使用浏览器时非常有用,因为这些覆盖会干扰现有的浏览器状态。通过 Browser.newContext() 创建的新上下文不受影响。默认为
false。 -
setSlowModouble (可选)添加于:v1.11#将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。默认为 0。
-
setTimeoutdouble (可选)添加于:v1.11#等待连接建立的最大时间(毫秒)。默认为
30000(30 秒)。传递0禁用超时。
-
返回
executablePath
v1.9 之前添加Playwright 期望找到捆绑浏览器可执行文件的路径。
用法
BrowserType.executablePath();
返回
launch
v1.9 之前添加返回浏览器实例。
用法
您可以使用 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 用户的一些差异。
参数
optionsBrowserType.LaunchOptions(可选)-
警告
使用自定义浏览器参数需自行承担风险,因为其中一些参数可能会破坏 Playwright 的功能。
传递给浏览器实例的附加参数。Chromium 标志列表可以在 这里 找到。
-
如果指定,产物(追踪记录、视频、下载文件、HAR 文件等)将保存到此目录中。当浏览器关闭时,该目录不会被自动清理。如果未指定,则使用临时目录,并在浏览器关闭时清理。
-
浏览器分发渠道。
使用 "chromium" 以选择启用新版无头模式。
使用 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev" 或 "msedge-canary" 来使用品牌化的 Google Chrome 和 Microsoft Edge。
-
setChromiumSandboxboolean (可选)#启用 Chromium 沙盒。默认为
false。 -
如果指定,接受的下载将下载到此目录。否则,将创建临时目录并在浏览器关闭时删除。在这两种情况下,下载将在创建它们的浏览器上下文关闭时删除。
-
setEnvMap<String, String> (可选)#指定浏览器可见的环境变量。默认为
process.env。 -
要运行的浏览器可执行文件路径,以替代捆绑的浏览器。如果 setExecutablePath 是相对路径,则它相对于当前工作目录解析。请注意,Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit,使用其他路径后果自负。
-
setFirefoxUserPrefsMap<String, Object> (可选)#Firefox 用户偏好设置。在
about:config了解更多关于 Firefox 用户偏好设置的信息。您还可以通过
PLAYWRIGHT_FIREFOX_POLICIES_JSON环境变量提供自定义policies.json文件 的路径。 -
在收到 SIGHUP 信号时关闭浏览器进程。默认为
true。 -
在收到 Ctrl-C 信号时关闭浏览器进程。默认为
true。 -
setHandleSIGTERMboolean (可选)#在收到 SIGTERM 信号时关闭浏览器进程。默认为
true。 -
setIgnoreAllDefaultArgsboolean (可选)添加于:v1.9#如果为
true,Playwright 将不会传递其自身的配置参数,而仅使用来自 setArgs 的参数。这是一个危险选项;请谨慎使用。默认为false。 -
setIgnoreDefaultArgsList<String> (可选)#如果为
true,Playwright 将不会传递其自身的配置参数,而仅使用来自 setArgs 的参数。这是一个危险选项;请谨慎使用。 -
setProxyProxy (可选)#-
setServerString用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128或socks5://myproxy.com:3128。简写形式myproxy.com:3128被视为 HTTP 代理。 -
setBypassString (可选)可选的逗号分隔的域以绕过代理,例如
".com, chromium.org, .domain.com"。 -
setUsernameString (可选)如果 HTTP 代理需要身份验证,则使用的可选用户名。
-
setPasswordString (可选)如果 HTTP 代理需要身份验证,则使用的可选密码。
网络代理设置。
-
-
将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。
-
等待浏览器实例启动的最大时间(毫秒)。默认为
30000(30 秒)。传递0禁用超时。 -
如果指定,追踪将保存到此目录。
-
返回
launchPersistentContext
v1.9 之前添加返回持久浏览器上下文实例。
启动使用位于 userDataDir 的持久化存储的浏览器,并返回唯一的上下文。关闭此上下文将自动关闭浏览器。
用法
BrowserType.launchPersistentContext(userDataDir);
BrowserType.launchPersistentContext(userDataDir, options);
参数
-
用户数据目录的路径,该目录存储浏览器会话数据,如 Cookie 和本地存储。传递空字符串以创建临时目录。
有关 Chromium 和 Firefox 的更多详细信息。Chromium 的用户数据目录是
chrome://version中显示的“个人资料路径 (Profile Path)”的父目录。请注意,浏览器不允许使用相同的用户数据目录启动多个实例。
警告Chromium/Chrome:由于 Chrome 最近的政策变更,不支持自动化处理默认的 Chrome 用户个人资料。将
userDataDir指向 Chrome 的主要“用户数据”目录(您日常浏览使用的个人资料)可能会导致页面无法加载或浏览器退出。请改为创建并使用一个单独的目录(例如,一个空文件夹)作为您的自动化个人资料。有关详情,请参见 https://developer.chrome.com/blog/remote-debugging-port。 -
optionsBrowserType.LaunchPersistentContextOptions(可选)-
setAcceptDownloadsboolean (可选)#是否自动下载所有附件。默认为
true,即接受所有下载。 -
警告
使用自定义浏览器参数需自行承担风险,因为其中一些参数可能会破坏 Playwright 的功能。
传递给浏览器实例的附加参数。Chromium 标志列表可以在 这里 找到。
-
如果指定,产物(追踪记录、视频、下载文件、HAR 文件等)将保存到此目录中。当浏览器关闭时,该目录不会被自动清理。如果未指定,则使用临时目录,并在浏览器关闭时清理。
-
当使用 Page.navigate(), Page.route(), Page.waitForURL(), Page.waitForRequest() 或 Page.waitForResponse() 时,它会通过
URL()构造函数将基准 URL 纳入考量以构建相应的 URL。默认未设置。示例- baseURL:
https://:3000,导航到/bar.html会得到https://:3000/bar.html - baseURL:
https://:3000/foo/,导航到./bar.html会得到https://:3000/foo/bar.html - baseURL:
https://:3000/foo(不带尾部斜杠),导航到./bar.html,结果为https://:3000/bar.html
- baseURL:
-
切换是否绕过页面的 Content-Security-Policy。默认为
false。 -
浏览器分发渠道。
使用 "chromium" 以选择启用新版无头模式。
使用 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev" 或 "msedge-canary" 来使用品牌化的 Google Chrome 和 Microsoft Edge。
-
setChromiumSandboxboolean (可选)#启用 Chromium 沙盒。默认为
false。 -
setClientCertificatesList<ClientCertificates> (可选)添加于: 1.46#-
setOriginString证书有效的精确源。源包括
https协议、主机名和可选的端口。 -
setCertPathPath (可选)PEM 格式证书文件的路径。
-
setCertbyte[] (可选)PEM 格式证书的直接值。
-
setKeyPathPath (可选)PEM 格式私钥文件的路径。
-
setKeybyte[] (可选)PEM 格式私钥的直接值。
-
setPfxPathPath (可选)PFX 或 PKCS12 编码的私钥和证书链文件的路径。
-
setPfxbyte[] (可选)PFX 或 PKCS12 编码的私钥和证书链的直接值。
-
setPassphraseString (可选)私钥(PEM 或 PFX)的密码。
TLS 客户端认证允许服务器请求并验证客户端证书。
详情
要使用的客户端证书数组。每个证书对象必须同时包含
certPath和keyPath,单个pfxPath,或其相应的直接值(cert和key,或pfx)。如果证书已加密,可以选择提供passphrase属性。origin属性应提供与证书有效的请求源的确切匹配。仅当提供至少一个客户端证书时,客户端证书身份验证才处于活动状态。如果您想拒绝服务器发送的所有客户端证书,您需要提供一个
origin与您计划访问的任何域都不匹配的客户端证书。注意在 macOS 上使用 WebKit 时,访问
localhost将不会选取客户端证书。您可以通过将localhost替换为local.playwright来使其工作。 -
-
setColorSchemenull |enum ColorScheme { LIGHT, DARK, NO_PREFERENCE }(可选)#模拟 prefers-colors-scheme 媒体特性,支持的值为
'light'和'dark'。更多详情请参阅 Page.emulateMedia()。传递null将重置为系统默认值。默认为'light'。 -
setContrastnull |enum Contrast { NO_PREFERENCE, MORE }(可选)#模拟
'prefers-contrast'媒体特性,支持的值为'no-preference','more'。更多详情请参阅 Page.emulateMedia()。传递null将重置为系统默认值。默认为'no-preference'。 -
setDeviceScaleFactordouble (可选)#指定设备缩放因子(可视为 dpr)。默认为
1。了解更多关于模拟具有设备缩放因子的设备的信息。 -
如果指定,接受的下载将下载到此目录。否则,将创建临时目录并在浏览器关闭时删除。在这两种情况下,下载将在创建它们的浏览器上下文关闭时删除。
-
setEnvMap<String, String> (可选)#指定浏览器可见的环境变量。默认为
process.env。 -
要运行的浏览器可执行文件路径,以替代捆绑的浏览器。如果 setExecutablePath 是相对路径,则它相对于当前工作目录解析。请注意,Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit,使用其他路径后果自负。
-
setExtraHTTPHeadersMap<String, String> (可选)#一个对象,包含要随每个请求发送的附加 HTTP 头。默认为无。
-
setFirefoxUserPrefsMap<String, Object> (可选)添加于:v1.40#Firefox 用户偏好设置。在
about:config了解更多关于 Firefox 用户偏好设置的信息。您还可以通过
PLAYWRIGHT_FIREFOX_POLICIES_JSON环境变量提供自定义policies.json文件 的路径。 -
setForcedColorsnull |enum ForcedColors { ACTIVE, NONE }(可选)#模拟
'forced-colors'媒体特性,支持的值为'active','none'。更多详情请参阅 Page.emulateMedia()。传递null将重置为系统默认值。默认为'none'。 -
setGeolocationGeolocation (可选)# -
在收到 SIGHUP 信号时关闭浏览器进程。默认为
true。 -
在收到 Ctrl-C 信号时关闭浏览器进程。默认为
true。 -
setHandleSIGTERMboolean (可选)#在收到 SIGTERM 信号时关闭浏览器进程。默认为
true。 -
指定视口是否支持触摸事件。默认为 false。了解更多关于移动端模拟的信息。
-
setHttpCredentialsHttpCredentials (可选)#-
setUsernameString -
setPasswordString -
setOriginString (可选)限制在特定源(scheme://host:port)上发送 http 凭据).
-
setSend枚举 HttpCredentialsSend { UNAUTHORIZED, ALWAYS }(可选)此选项仅适用于从相应的 APIRequestContext 发出的请求,不影响从浏览器发出的请求。
'always'- 每个 API 请求都将携带包含基本身份验证凭据的Authorization标头。'unauthorized'- 仅在收到包含WWW-Authenticate标头的 401(未授权)响应时,才会发送凭据。默认为'unauthorized'。
HTTP 身份验证 的凭据。如果未指定 origin,则用户名和密码将在收到未授权响应时发送给任何服务器。
-
-
setIgnoreAllDefaultArgsboolean (可选)添加于:v1.9#如果为
true,Playwright 将不会传递其自身的配置参数,而仅使用来自 setArgs 的参数。这是一个危险选项;请谨慎使用。默认为false。 -
setIgnoreDefaultArgsList<String> (可选)#如果为
true,Playwright 将不会传递其自身的配置参数,而仅使用来自 setArgs 的参数。这是一个危险选项;请谨慎使用。 -
setIgnoreHTTPSErrorsboolean (可选)#发送网络请求时是否忽略 HTTPS 错误。默认为
false。 -
是否考虑
meta viewport标签并启用触摸事件。isMobile 是设备配置的一部分,因此实际上不需要手动设置它。默认为false,且 Firefox 不支持此选项。了解更多关于移动端模拟的信息。 -
setJavaScriptEnabledboolean (可选)#是否在上下文中启用 JavaScript。默认为
true。了解更多关于禁用 JavaScript 的信息。 -
指定用户区域设置,例如
en-GB,de-DE等。区域设置将影响navigator.language值、Accept-Language请求头值以及数字和日期格式化规则。默认为系统默认区域设置。在我们的模拟指南中了解更多关于模拟的信息。 -
是否模拟网络离线状态。默认为
false。了解更多关于网络模拟的信息。 -
setPermissionsList<String> (可选)#授予此上下文中所有页面的权限列表。详情请参阅 BrowserContext.grantPermissions()。默认为无权限。
-
setProxyProxy (可选)#-
setServerString用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128或socks5://myproxy.com:3128。简写形式myproxy.com:3128被视为 HTTP 代理。 -
setBypassString (可选)可选的逗号分隔的域以绕过代理,例如
".com, chromium.org, .domain.com"。 -
setUsernameString (可选)如果 HTTP 代理需要身份验证,则使用的可选用户名。
-
setPasswordString (可选)如果 HTTP 代理需要身份验证,则使用的可选密码。
网络代理设置。
-
-
setRecordHarContentenum HarContentPolicy { OMIT, EMBED, ATTACH }(可选)#可选设置,用于控制资源内容管理。如果指定了
omit,则不持久化内容。如果指定了attach,则资源将作为单独的文件持久化,并且所有这些文件将与 HAR 文件一起存档。默认为embed,它将内容内联存储在 HAR 文件中,符合 HAR 规范。 -
setRecordHarModeenum HarMode { FULL, MINIMAL }(可选)#设置为
minimal时,仅记录从 HAR 路由所需的信息。这会省略 HAR 的大小、时间、页面、Cookie、安全性和其他类型的 HAR 信息,这些信息在从 HAR 重放时不使用。默认为full。 -
setRecordHarOmitContentboolean (可选)#控制是否从 HAR 中省略请求内容的可选设置。默认为
false。 -
启用对所有页面进行 HAR 记录,并保存到文件系统中的指定 HAR 文件。如果未指定,则不记录 HAR。请务必调用 BrowserContext.close() 以保存 HAR。
-
启用对所有页面进行视频录制,并保存到指定目录。如果未指定,则不记录视频。请务必调用 BrowserContext.close() 以保存视频。
-
setRecordVideoSizeRecordVideoSize (可选)#录制视频的尺寸。如果未指定,尺寸将等于
viewport按比例缩小以适应 800x800。如果未明确配置viewport,视频尺寸默认为 800x450。如果需要,每个页面的实际图像将按比例缩小以适应指定的尺寸。 -
setReducedMotionnull |enum ReducedMotion { REDUCE, NO_PREFERENCE }(可选)#模拟
'prefers-reduced-motion'媒体特性,支持的值为'reduce','no-preference'。更多详情请参阅 Page.emulateMedia()。传递null将重置为系统默认值。默认为'no-preference'。 -
setScreenSizeScreenSize (可选)#模拟网页内通过
window.screen可用的固定窗口屏幕尺寸。仅在设置了 setViewportSize 时使用。 -
setServiceWorkersenum ServiceWorkerPolicy { ALLOW, BLOCK }(可选)#是否允许站点注册 Service Workers。默认为
'allow'。'allow':可以注册 Service Workers。'block': Playwright 将阻止所有 Service Workers 的注册。
-
将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。
-
setStrictSelectorsboolean (可选)#如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,所有暗示单个目标 DOM 元素的选择器操作,当超过一个元素匹配该选择器时都会抛出异常。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为
false。参阅 Locator 以了解更多关于严格模式的信息。 -
等待浏览器实例启动的最大时间(毫秒)。默认为
30000(30 秒)。传递0禁用超时。 -
更改上下文的时区。查看 ICU 的 metaZones.txt 获取支持的时区 ID 列表。默认为系统时区。
-
如果指定,追踪将保存到此目录。
-
此上下文中使用的特定用户代理。
-
setViewportSizenull | ViewportSize (可选)#模拟每个页面的固定视口。默认为 1280x720 视口。使用
null可禁用固定视口模拟。了解更多关于视口模拟的信息。注意null值会取消默认预设,使视口取决于操作系统定义的主机窗口大小。这会使测试的执行不确定。
-
返回
name
v1.9 之前添加返回浏览器名称。例如:'chromium'、'webkit' 或 'firefox'。
用法
BrowserType.name();
返回