BrowserType
BrowserType 提供了启动特定浏览器实例或连接到现有浏览器的方法。以下是使用 Playwright 驱动自动化的典型示例:
🌐 BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a typical example of using Playwright to drive automation:
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();
}
}
}
方法
🌐 Methods
connect
Added before v1.9此方法将 Playwright 附加到通过 Node.js 中的 BrowserType.launchServer 创建的现有浏览器实例。
🌐 This method attaches Playwright to an existing browser instance created via BrowserType.launchServer in Node.js.
连接的 Playwright 实例的主版本和次版本需要与启动浏览器的 Playwright 版本匹配(1.2.3 → 与 1.2.x 兼容)。
🌐 The major and minor version of the Playwright instance that connects needs to match the version of Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
用法
BrowserType.connect(wsEndpoint);
BrowserType.connect(wsEndpoint, options);
参数
-
wsEndpointString Added in: v1.10#一个 Playwright 浏览器 websocket 端点用于连接。你可以通过
BrowserServer.wsEndpoint获取此端点。 -
optionsBrowserType.ConnectOptions(optional)-
setExposeNetworkString (optional) Added in: 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> (optional) Added in: v1.11#随 WebSocket 连接请求一起发送的其他 HTTP 头。可选。
-
setSlowModouble (optional) Added in: v1.10#按指定的毫秒数减慢 Playwright 的操作。这样做很有用,可以让你看到正在发生的情况。默认值为 0。
-
setTimeoutdouble (optional) Added in: v1.10#建立连接的最大等待时间(毫秒)。默认值为
0(无限时长)。
-
返回
connectOverCDP
Added in: v1.9此方法使用 Chrome DevTools 协议将 Playwright 附加到现有浏览器实例。
🌐 This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
默认的浏览器上下文可以通过 Browser.contexts() 访问。
🌐 The default browser context is accessible via Browser.contexts().
仅支持通过 Chrome DevTools 协议连接到基于 Chromium 的浏览器。
🌐 Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
此连接的保真度远低于通过 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);
参数
-
endpointURLString Added in: v1.11#要连接的 CDP websocket 端点或 HTTP URL。例如
http://localhost:9222/或ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4。 -
optionsBrowserType.ConnectOverCDPOptions(optional)-
setHeadersMap<String, String> (optional) Added in: v1.11#要随连接请求发送的额外 HTTP 请求头。可选。
-
setIsLocalboolean (optional) Added in: v1.58#告诉 Playwright 它与 CDP 服务器运行在同一主机上。这将启用某些依赖于 Playwright 与浏览器之间文件系统相同的优化。
-
setSlowModouble (optional) Added in: v1.11#按指定的毫秒数减慢 Playwright 的操作。这样做很有用,可以让你看到正在发生的情况。默认值为 0。
-
setTimeoutdouble (optional) Added in: v1.11#等待连接建立的最长时间(毫秒)。默认值为
30000(30 秒)。传入0可禁用超时。
-
返回
executablePath
Added before v1.9Playwright 希望找到打包的浏览器可执行文件的路径。
🌐 A path where Playwright expects to find a bundled browser executable.
用法
BrowserType.executablePath();
返回
launch
Added before v1.9返回浏览器实例。
🌐 Returns the browser instance.
用法
你可以使用 setIgnoreDefaultArgs 来从默认参数中筛选出 --mute-audio :
🌐 You can use setIgnoreDefaultArgs to filter out --mute-audio from default arguments:
// 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 或 开发者渠道 版本。
像 Google Chrome 和 Microsoft Edge 这样的标准浏览器适用于需要专有媒体编解码器进行视频播放的测试。有关 Chromium 和 Chrome 之间其他差异,请参见 这篇文章。这篇文章 介绍了 Linux 用户的一些差异情况。
参数
optionsBrowserType.LaunchOptions(optional)-
setArgsList<String> (optional)#warning使用自定义浏览器参数需自行承担风险,因为其中一些可能会破坏 Playwright 的功能。
传递给浏览器实例的额外参数。Chromium 标志列表可以在 这里 查看。
-
浏览器分发渠道。
使用“chromium”来选择使用新的无头模式。
使用“chrome”、“chrome-beta”、“chrome-dev”、“chrome-canary”、“msedge”、“msedge-beta”、“msedge-dev”或“msedge-canary”来使用品牌化的 Google Chrome 和 Microsoft Edge。
-
setChromiumSandboxboolean (optional)#启用 Chromium 沙箱。默认值为
false。 -
setDownloadsPathPath (optional)#如果指定了目录,接收的下载内容会被下载到该目录中。否则,会创建临时目录,并在浏览器关闭时删除。无论哪种情况,下载的内容都会在创建它们的浏览器上下文关闭时被删除。
-
setEnvMap<String, String> (optional)#指定将在浏览器中可见的环境变量。默认值为
process.env。 -
setExecutablePathPath (optional)#用于运行的浏览器可执行文件路径,替代打包的浏览器。如果 setExecutablePath 是相对路径,则相对于当前工作目录解析。请注意,Playwright 仅兼容打包的 Chromium、Firefox 或 WebKit,请自行承担风险使用其他浏览器。
-
setFirefoxUserPrefsMap<String, Object> (optional)#Firefox 用户偏好设置。请在
about:config了解有关 Firefox 用户偏好设置的更多信息。你也可以通过
PLAYWRIGHT_FIREFOX_POLICIES_JSON环境变量提供自定义policies.json文件 的路径。 -
setHandleSIGHUPboolean (optional)#在接收到 SIGHUP 信号时关闭浏览器进程。默认值为
true。 -
setHandleSIGINTboolean (optional)#在按 Ctrl-C 时关闭浏览器进程。默认为
true。 -
setHandleSIGTERMboolean (optional)#在收到 SIGTERM 时关闭浏览器进程。默认为
true。 -
setIgnoreAllDefaultArgsboolean (optional) Added in: v1.9#如果
true,Playwright 不会传递自身的配置参数,而只使用来自 setArgs 的参数。危险选项;请谨慎使用。默认值为false。 -
setIgnoreDefaultArgsList<String> (optional)#如果
true,Playwright 不会传递自己的配置参数,只会使用来自 setArgs 的参数。危险选项,请小心使用。 -
setProxyProxy (optional)#-
setServerString用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128或socks5://myproxy.com:3128。简写myproxy.com:3128被视为 HTTP 代理。 -
setBypassString (optional)可选的以逗号分隔的域名,用于绕过代理,例如
".com, chromium.org, .domain.com"。 -
setUsernameString (optional)如果 HTTP 代理需要身份验证,则使用可选的用户名。
-
setPasswordString (optional)如果 HTTP 代理需要身份验证,则使用可选密码。
网络代理设置。
-
-
将 Playwright 操作延迟指定的毫秒数。这样做很有用,可以让你看到正在发生的情况。
-
等待浏览器实例启动的最长时间,单位为毫秒。默认值为
30000(30 秒)。传入0可禁用超时。 -
如果指定,跟踪将保存到此目录中。
-
返回
launchPersistentContext
Added before v1.9返回持久浏览器上下文实例。
🌐 Returns the persistent browser context instance.
启动使用位于 userDataDir 的持久存储的浏览器,并返回唯一的上下文。关闭此上下文将自动关闭浏览器。
🌐 Launches browser that uses persistent storage located at userDataDir and returns the only context. Closing this context will automatically close the browser.
用法
BrowserType.launchPersistentContext(userDataDir);
BrowserType.launchPersistentContext(userDataDir, options);
参数
-
用户数据目录的路径,用于存储浏览器会话数据,如 Cookie 和本地存储。传入空字符串以创建临时目录。
有关 Chromium 和 Firefox 的更多详细信息。Chromium 的用户数据目录是
chrome://version所示“配置文件路径”的上级目录。请注意,浏览器不允许使用同一个用户数据目录启动多个实例。
warningChromium/Chrome:由于近期 Chrome 政策的变化,不支持自动化默认的 Chrome 用户配置文件。将
userDataDir指向 Chrome 的主“用户数据”目录(即你平时浏览使用的配置文件)可能会导致页面无法加载或浏览器退出。请创建并使用一个单独的目录(例如一个空文件夹)作为你的自动化配置文件。详细信息请参见 https://developer.chrome.com/blog/remote-debugging-port。 -
optionsBrowserType.LaunchPersistentContextOptions(optional)-
setAcceptDownloadsboolean (optional)#是否自动下载所有附件。默认值为
true,表示接受所有下载。 -
setArgsList<String> (optional)#warning使用自定义浏览器参数需自行承担风险,因为其中一些可能会破坏 Playwright 的功能。
传递给浏览器实例的额外参数。Chromium 标志列表可以在 这里 查看。
-
在使用 Page.navigate()、Page.route()、Page.waitForURL()、Page.waitForRequest() 或 Page.waitForResponse() 时,会通过使用
URL()构造函数构建相应的 URL 来考虑基础 URL。默认情况下未设置。示例:- 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
- baseURL:
-
setBypassCSPboolean (optional)#切换是否绕过页面的内容安全策略。默认值为
false。 -
浏览器分发渠道。
使用“chromium”来选择使用新的无头模式。
使用“chrome”、“chrome-beta”、“chrome-dev”、“chrome-canary”、“msedge”、“msedge-beta”、“msedge-dev”或“msedge-canary”来使用品牌化的 Google Chrome 和 Microsoft Edge。
-
setChromiumSandboxboolean (optional)#启用 Chromium 沙箱。默认值为
false。 -
setClientCertificatesList<ClientCertificates> (optional) Added in: 1.46#-
setOriginString证书有效的确切来源。来源包括
https协议、主机名以及可选的端口。 -
setCertPathPath (optional)PEM 格式的证书文件路径。
-
setCertbyte[] (optional)PEM 格式的证书的直接值。
-
setKeyPathPath (optional)PEM 格式的私钥文件路径。
-
setKeybyte[] (optional)PEM 格式的私钥的直接值。
-
setPfxPathPath (optional)PFX 或 PKCS12 编码的私钥和证书链的路径。
-
setPfxbyte[] (optional)PFX 或 PKCS12 编码的私钥和证书链的直接值。
-
setPassphraseString (optional)私钥的密码(PEM 或 PFX)。
TLS 客户端身份验证允许服务器请求客户端证书并对其进行验证。
详情
要使用的一组客户端证书。每个证书对象必须同时具有
certPath和keyPath,或者单独具有pfxPath,或它们对应的直接值等效项(cert和key,或pfx)。如果证书是加密的,则可选择提供passphrase属性。origin属性应提供与证书有效的请求来源完全匹配的值。客户端证书认证仅在提供至少一个客户端证书时才有效。如果你想拒绝服务器发送的所有客户端证书,你需要提供一个
origin与你计划访问的任何域名都不匹配的客户端证书。note在 macOS 上使用 WebKit 时,访问
localhost不会使用客户端证书。你可以通过将localhost替换为local.playwright来使其正常工作。 -
-
setColorSchemenull |enum ColorScheme { LIGHT, DARK, NO_PREFERENCE }(optional)#模拟 prefers-colors-scheme 媒体特性,支持的值为
'light'和'dark'。更多详情请参见 Page.emulateMedia()。传入null会将模拟重置为系统默认值。默认值为'light'。 -
setContrastnull |enum Contrast { NO_PREFERENCE, MORE }(optional)#模拟
'prefers-contrast'媒体特性,支持的值为'no-preference'、'more'。更多详情请参见 Page.emulateMedia()。传递null会将模拟重置为系统默认值。默认为'no-preference'。 -
setDeviceScaleFactordouble (optional)#指定设备缩放因子(可以理解为 DPR)。默认值为
1。了解有关使用设备缩放因子模拟设备的更多信息。 -
setDownloadsPathPath (optional)#如果指定了目录,接收的下载内容会被下载到该目录中。否则,会创建临时目录,并在浏览器关闭时删除。无论哪种情况,下载的内容都会在创建它们的浏览器上下文关闭时被删除。
-
setEnvMap<String, String> (optional)#指定将在浏览器中可见的环境变量。默认值为
process.env。 -
setExecutablePathPath (optional)#用于运行的浏览器可执行文件路径,替代打包的浏览器。如果 setExecutablePath 是相对路径,则相对于当前工作目录解析。请注意,Playwright 仅兼容打包的 Chromium、Firefox 或 WebKit,请自行承担风险使用其他浏览器。
-
setExtraHTTPHeadersMap<String, String> (optional)#一个包含附加 HTTP 头的对象,这些头将随每个请求发送。默认为无。
-
setFirefoxUserPrefsMap<String, Object> (optional) Added in: v1.40#Firefox 用户偏好设置。请在
about:config了解有关 Firefox 用户偏好设置的更多信息。你也可以通过
PLAYWRIGHT_FIREFOX_POLICIES_JSON环境变量提供自定义policies.json文件 的路径。 -
setForcedColorsnull |enum ForcedColors { ACTIVE, NONE }(optional)#模拟
'forced-colors'媒体特性,支持的值为'active'、'none'。更多详情请参见 Page.emulateMedia()。传递null会将模拟重置为系统默认值。默认为'none'。 -
setGeolocationGeolocation (optional)# -
setHandleSIGHUPboolean (optional)#在接收到 SIGHUP 信号时关闭浏览器进程。默认值为
true。 -
setHandleSIGINTboolean (optional)#在按 Ctrl-C 时关闭浏览器进程。默认为
true。 -
setHandleSIGTERMboolean (optional)#在收到 SIGTERM 时关闭浏览器进程。默认为
true。 -
setHasTouchboolean (optional)#指定视口是否支持触摸事件。默认值为 false。了解更多关于 移动模拟 的信息。
-
setHttpCredentialsHttpCredentials (optional)#-
setUsernameString -
setPasswordString -
setOriginString (optional)限制在特定来源 (scheme://host:port) 上发送 http 凭据。
-
setSendenum HttpCredentialsSend { UNAUTHORIZED, ALWAYS }(optional)此选项仅适用于从对应的 APIRequestContext 发送的请求,并不影响从浏览器发送的请求。
'always'-Authorization头信息会随每个 API 请求发送基本认证凭据。'unauthorized- 凭据仅在收到带有WWW-Authenticate头的 401(未授权)响应时发送。默认为'unauthorized'。
HTTP 认证 的凭据。如果未指定来源,用户名和密码将在收到未授权响应时发送到任何服务器。
-
-
setIgnoreAllDefaultArgsboolean (optional) Added in: v1.9#如果
true,Playwright 不会传递自身的配置参数,而只使用来自 setArgs 的参数。危险选项;请谨慎使用。默认值为false。 -
setIgnoreDefaultArgsList<String> (optional)#如果
true,Playwright 不会传递自己的配置参数,只会使用来自 setArgs 的参数。这是一个危险选项,请谨慎使用。 -
setIgnoreHTTPSErrorsboolean (optional)#发送网络请求时是否忽略 HTTPS 错误。默认值为
false。 -
setIsMobileboolean (optional)#是否考虑
meta viewport标签并启用触摸事件。isMobile 是 device 的一部分,因此你实际上不需要手动设置它。默认值为false,并且在 Firefox 中不受支持。了解更多关于 移动端模拟 的信息。 -
setJavaScriptEnabledboolean (optional)#是否在此环境中启用 JavaScript。默认为
true。了解更多关于禁用 JavaScript的信息。 -
指定用户区域设置,例如
en-GB、de-DE等。区域设置会影响navigator.language的值、Accept-Language请求头的值以及数字和日期的格式规则。默认为系统默认区域设置。有关模拟的更多信息,请参阅我们的 模拟指南。 -
setOfflineboolean (optional)#是否模拟网络离线。默认为
false。了解更多关于 网络模拟 的信息。 -
setPermissionsList<String> (optional)#在此上下文中授予所有页面的权限列表。有关更多详细信息,请参阅 BrowserContext.grantPermissions()。默认情况下无权限。
-
setProxyProxy (optional)#-
setServerString用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如
http://myproxy.com:3128或socks5://myproxy.com:3128。简写myproxy.com:3128被视为 HTTP 代理。 -
setBypassString (optional)可选的以逗号分隔的域名,用于绕过代理,例如
".com, chromium.org, .domain.com"。 -
setUsernameString (optional)如果 HTTP 代理需要身份验证,则使用可选的用户名。
-
setPasswordString (optional)如果 HTTP 代理需要身份验证,则使用可选密码。
网络代理设置。
-
-
setRecordHarContentenum HarContentPolicy { OMIT, EMBED, ATTACH }(optional)#可选设置,用于控制资源内容管理。如果指定
omit,内容不会被保存。如果指定attach,资源将作为单独的文件保存,并且所有这些文件会与 HAR 文件一起归档。默认值为embed,根据 HAR 规范将内容以内联方式存储在 HAR 文件中。 -
setRecordHarModeenum HarMode { FULL, MINIMAL }(optional)#当设置为
minimal时,仅记录从 HAR 路由所需的信息。这会省略在从 HAR 回放时不使用的大小、时间、页面、Cookies、安全性以及其他类型的 HAR 信息。默认值为full。 -
setRecordHarOmitContentboolean (optional)#可选设置,用于控制是否从 HAR 中省略请求内容。默认值为
false。 -
setRecordHarPathPath (optional)#启用将所有页面的 HAR 记录到文件系统中指定的 HAR 文件。如果未指定,则不会记录 HAR。请确保调用 BrowserContext.close() 以保存 HAR。
-
setRecordVideoDirPath (optional)#启用将所有页面的视频录制到指定目录。如果未指定,则不记录视频。请确保调用 BrowserContext.close() 以保存视频。
-
setRecordVideoSizeRecordVideoSize (optional)#录制视频的尺寸。如果未指定,尺寸将等于
viewport,并缩小以适应 800x800。如果未明确配置viewport,视频尺寸默认为 800x450。如有必要,每一页的实际图片将被缩小以适应指定尺寸。 -
setReducedMotionnull |enum ReducedMotion { REDUCE, NO_PREFERENCE }(optional)#模拟
'prefers-reduced-motion'媒体特性,支持的值为'reduce'、'no-preference'。更多详情请参见 Page.emulateMedia()。传递null会将模拟重置为系统默认值。默认为'no-preference'。 -
setScreenSizeScreenSize (optional)#通过
window.screen模拟网页内可用的一致窗口屏幕尺寸。仅在设置了 setViewportSize 时使用。 -
setServiceWorkersenum ServiceWorkerPolicy { ALLOW, BLOCK }(optional)#是否允许网站注册服务工作进程。默认值为
'allow'。'allow':服务工作者 可以被注册。'block':Playwright 将阻止所有服务工作进程的注册。
-
将 Playwright 操作延迟指定的毫秒数。这样做很有用,可以让你看到正在发生的情况。
-
setStrictSelectorsboolean (optional)#如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,对选择器进行的所有操作,如果操作意图是单个目标 DOM 元素,当有多个元素匹配选择器时将会抛出错误。此选项不会影响任何定位器(Locator)API(定位器始终是严格的)。默认值为
false。请参阅 Locator 了解有关严格模式的更多信息。 -
等待浏览器实例启动的最长时间,单位为毫秒。默认值为
30000(30 秒)。传入0可禁用超时。 -
setTimezoneIdString (optional)#更改上下文的时区。有关支持的时区 ID 列表,请参阅 ICU 的 metaZones.txt。默认使用系统时区。
-
如果指定,跟踪将保存到此目录中。
-
setUserAgentString (optional)#在此上下文中使用的特定用户代理。
-
setViewportSizenull | ViewportSize (optional)#为每个页面模拟一致的视口。默认视口为 1280x720。使用
null可禁用一致视口模拟。了解更多关于视口模拟的信息。notenull值选择不使用默认预设,使视口依赖于操作系统定义的主机窗口大小。这会导致测试执行结果不确定。
-
返回
name
Added before v1.9返回浏览器名称。例如:'chromium'、'webkit' 或 'firefox'。
🌐 Returns browser name. For example: 'chromium', 'webkit' or 'firefox'.
用法
BrowserType.name();
返回