Browser
Browser 通过 BrowserType.launch() 创建。以下是使用 Browser 创建 Page 的示例
import com.microsoft.playwright.*;
public class Example {
public static void main(String[] args) {
try (Playwright playwright = Playwright.create()) {
BrowserType firefox = playwright.firefox();
Browser browser = firefox.launch();
Page page = browser.newPage();
page.navigate("https://example.com");
browser.close();
}
}
}
方法
browserType
添加于版本: v1.23获取浏览器所属的浏览器类型 (chromium, firefox 或 webkit)。
用法
Browser.browserType();
返回值
close
在 v1.9 之前添加如果此浏览器是通过 BrowserType.launch() 获取的,则关闭浏览器及其所有页面 (如果已打开任何页面)。
如果此浏览器是连接到的,则清除属于此浏览器的所有已创建的上下文,并断开与浏览器服务器的连接。
这类似于强制退出浏览器。要优雅地关闭页面并确保收到页面关闭事件,请在调用 Browser.close() 之前,对您之前使用 Browser.newContext() 显式创建的任何 BrowserContext 实例调用 BrowserContext.close()。
Browser 对象本身被认为是已释放的,不能再使用。
用法
Browser.close();
Browser.close(options);
参数
返回值
contexts
在 v1.9 之前添加返回所有打开的浏览器上下文的数组。在新创建的浏览器中,这将返回零个浏览器上下文。
用法
Browser browser = pw.webkit().launch();
System.out.println(browser.contexts().size()); // prints "0"
BrowserContext context = browser.newContext();
System.out.println(browser.contexts().size()); // prints "1"
返回值
isConnected
在 v1.9 之前添加指示浏览器是否已连接。
用法
Browser.isConnected();
返回值
newBrowserCDPSession
添加于版本: v1.11CDP 会话仅在基于 Chromium 的浏览器上受支持。
返回新创建的浏览器会话。
用法
Browser.newBrowserCDPSession();
返回值
newContext
在 v1.9 之前添加创建一个新的浏览器上下文。它不会与其他浏览器上下文共享 Cookie/缓存。
如果直接使用此方法创建 BrowserContext,最佳实践是在完成 BrowserContext 后,并在调用 Browser.close() 之前,通过 BrowserContext.close() 显式关闭返回的上下文。这将确保 context
被优雅地关闭,并且任何工件 (如 HAR 和视频) 都被完全刷新和保存。
用法
Browser browser = playwright.firefox().launch(); // Or 'chromium' or 'webkit'.
// Create a new incognito browser context.
BrowserContext context = browser.newContext();
// Create a new page in a pristine context.
Page page = context.newPage();
page.navigate("https://example.com");
// Graceful close up everything
context.close();
browser.close();
参数
options
Browser.NewContextOptions
(可选)-
setAcceptDownloads
boolean (可选)#是否自动下载所有附件。默认为
true
,即接受所有下载。 -
当使用 Page.navigate(), Page.route(), Page.waitForURL(), Page.waitForRequest(), 或 Page.waitForResponse() 时,它会使用
URL()
构造函数来构建相应的 URL,从而考虑基本 URL。默认未设置。示例- baseURL:
https://127.0.0.1:3000
并导航到/bar.html
将会得到https://127.0.0.1:3000/bar.html
- baseURL:
https://127.0.0.1:3000/foo/
并导航到./bar.html
将会得到https://127.0.0.1:3000/foo/bar.html
- baseURL:
https://127.0.0.1:3000/foo
(没有尾部斜杠) 并导航到./bar.html
将会得到https://127.0.0.1:3000/bar.html
- baseURL:
-
切换绕过页面的 Content-Security-Policy。默认为
false
。 -
setClientCertificates
List<ClientCertificates> (可选)添加于版本: 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
属性应提供与证书有效的请求来源的完全匹配。注意在 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
。了解有关 使用设备比例因子模拟设备 的更多信息。 -
setExtraHTTPHeaders
Map<String, String> (可选)#一个对象,其中包含要随每个请求一起发送的其他 HTTP 标头。默认为无。
-
setForcedColors
null |enum ForcedColors { ACTIVE, NONE }
(可选)#模拟
'forced-colors'
媒体功能,支持的值为'active'
,'none'
。有关更多详细信息,请参阅 Page.emulateMedia()。传递null
会将模拟重置为系统默认值。默认为'none'
。 -
setGeolocation
Geolocation (可选)# -
指定视口是否支持触摸事件。默认为 false。了解有关 移动设备模拟 的更多信息。
-
setHttpCredentials
HttpCredentials (可选)#-
setUsername
String -
setPassword
String -
setOrigin
String (可选)限制在特定来源 (scheme://host:port).
-
setSend
enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS }
(可选)此选项仅适用于从相应的 APIRequestContext 发送的请求,并且不影响从浏览器发送的请求。
'always'
- 带有基本身份验证凭据的Authorization
标头将与每个 API 请求一起发送。'unauthorized
- 仅当收到带有WWW-Authenticate
标头的 401 (Unauthorized) 响应时才发送凭据。默认为'unauthorized'
。
HTTP 身份验证 的凭据。如果未指定来源,则用户名和密码将在收到未经授权的响应时发送到任何服务器。
-
-
setIgnoreHTTPSErrors
boolean (可选)#在发送网络请求时是否忽略 HTTPS 错误。默认为
false
。 -
是否考虑
meta viewport
标记并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为false
,并且在 Firefox 中不受支持。了解有关 移动设备模拟 的更多信息。 -
setJavaScriptEnabled
boolean (可选)#是否在此上下文中启用 JavaScript。默认为
true
。了解有关 禁用 JavaScript 的更多信息。 -
指定用户区域设置,例如
en-GB
、de-DE
等。区域设置将影响navigator.language
值、Accept-Language
请求标头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的 模拟指南 中了解有关模拟的更多信息。 -
是否模拟网络离线。默认为
false
。了解有关 网络模拟 的更多信息。 -
setPermissions
List<String> (可选)#要授予此上下文中所有页面的权限列表。有关更多详细信息,请参阅 BrowserContext.grantPermissions()。默认为无。
-
setProxy
Proxy (可选)#-
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 路由所需的信息。这省略了在从 HAR 重放时未使用的尺寸、计时、页面、Cookie、安全和其他类型的 HAR 信息。默认为full
。 -
setRecordHarOmitContent
boolean (可选)#用于控制是否从 HAR 中省略请求内容的可选设置。默认为
false
。 -
启用 HAR 记录,将所有页面的 HAR 记录到文件系统上的指定 HAR 文件中。如果未指定,则不记录 HAR。确保调用 BrowserContext.close() 以保存 HAR。
-
启用视频录制,将所有页面的视频录制到指定目录中。如果未指定,则不录制视频。确保调用 BrowserContext.close() 以保存视频。
-
setRecordVideoSize
RecordVideoSize (可选)#录制视频的尺寸。如果未指定,则尺寸将等于缩放到适合 800x800 的
viewport
。如果未显式配置viewport
,则视频尺寸默认为 800x450。如有必要,每个页面的实际图片都将缩小以适合指定的尺寸。 -
setReducedMotion
null |enum ReducedMotion { REDUCE, NO_PREFERENCE }
(可选)#模拟
'prefers-reduced-motion'
媒体功能,支持的值为'reduce'
,'no-preference'
。有关更多详细信息,请参阅 Page.emulateMedia()。传递null
会将模拟重置为系统默认值。默认为'no-preference'
。 -
setScreenSize
ScreenSize (可选)#模拟通过
window.screen
在网页内可用的统一窗口屏幕尺寸。仅当设置了 setViewportSize 时才使用。 -
setServiceWorkers
enum ServiceWorkerPolicy { ALLOW, BLOCK }
(可选)#是否允许站点注册 Service workers。默认为
'allow'
。'allow'
: 可以注册 Service Workers。'block'
: Playwright 将阻止所有 Service Workers 的注册。
-
使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.storageState() 获取的登录信息初始化上下文。
-
setStorageStatePath
Path (可选)添加于版本: v1.9#使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.storageState() 获取的登录信息初始化上下文。保存的存储状态的文件路径。
-
setStrictSelectors
boolean (可选)#如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,对选择器的所有操作 (暗示单个目标 DOM 元素) 在多个元素匹配选择器时都会抛出异常。此选项不影响任何 Locator API (Locator 始终是严格的)。默认为
false
。请参阅 Locator 以了解有关严格模式的更多信息。 -
更改上下文的时区。有关支持的时区 ID 列表,请参阅 ICU's metaZones.txt。默认为系统时区。
-
在此上下文中使用的特定用户代理。
-
setViewportSize
null | ViewportSize (可选)#为每个页面模拟一致的视口。默认为 1280x720 视口。使用
null
禁用一致的视口模拟。了解有关 视口模拟 的更多信息。注意null
值选择退出默认预设,使视口取决于操作系统定义的主机窗口大小。这使得测试的执行具有不确定性。
-
返回值
newPage
在 v1.9 之前添加在新浏览器上下文中创建一个新页面。关闭此页面也将关闭上下文。
这是一个便捷的 API,仅应用于单页场景和简短代码片段。生产代码和测试框架应显式创建 Browser.newContext(),然后创建 BrowserContext.newPage(),以控制其确切生命周期。
用法
Browser.newPage();
Browser.newPage(options);
参数
options
Browser.NewPageOptions
(可选)-
setAcceptDownloads
boolean (可选)#是否自动下载所有附件。默认为
true
,即接受所有下载。 -
当使用 Page.navigate(), Page.route(), Page.waitForURL(), Page.waitForRequest(), 或 Page.waitForResponse() 时,它会使用
URL()
构造函数来构建相应的 URL,从而考虑基本 URL。默认未设置。示例- baseURL:
https://127.0.0.1:3000
并导航到/bar.html
将会得到https://127.0.0.1:3000/bar.html
- baseURL:
https://127.0.0.1:3000/foo/
并导航到./bar.html
将会得到https://127.0.0.1:3000/foo/bar.html
- baseURL:
https://127.0.0.1:3000/foo
(没有尾部斜杠) 并导航到./bar.html
将会得到https://127.0.0.1:3000/bar.html
- baseURL:
-
切换绕过页面的 Content-Security-Policy。默认为
false
。 -
setClientCertificates
List<ClientCertificates> (可选)添加于版本: 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
属性应提供与证书有效的请求来源的完全匹配。注意在 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
。了解有关 使用设备比例因子模拟设备 的更多信息。 -
setExtraHTTPHeaders
Map<String, String> (可选)#一个对象,其中包含要随每个请求一起发送的其他 HTTP 标头。默认为无。
-
setForcedColors
null |enum ForcedColors { ACTIVE, NONE }
(可选)#模拟
'forced-colors'
媒体功能,支持的值为'active'
,'none'
。有关更多详细信息,请参阅 Page.emulateMedia()。传递null
会将模拟重置为系统默认值。默认为'none'
。 -
setGeolocation
Geolocation (可选)# -
指定视口是否支持触摸事件。默认为 false。了解有关 移动设备模拟 的更多信息。
-
setHttpCredentials
HttpCredentials (可选)#-
setUsername
String -
setPassword
String -
setOrigin
String (可选)限制在特定来源 (scheme://host:port).
-
setSend
enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS }
(可选)此选项仅适用于从相应的 APIRequestContext 发送的请求,并且不影响从浏览器发送的请求。
'always'
- 带有基本身份验证凭据的Authorization
标头将与每个 API 请求一起发送。'unauthorized
- 仅当收到带有WWW-Authenticate
标头的 401 (Unauthorized) 响应时才发送凭据。默认为'unauthorized'
。
HTTP 身份验证 的凭据。如果未指定来源,则用户名和密码将在收到未经授权的响应时发送到任何服务器。
-
-
setIgnoreHTTPSErrors
boolean (可选)#在发送网络请求时是否忽略 HTTPS 错误。默认为
false
。 -
是否考虑
meta viewport
标记并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为false
,并且在 Firefox 中不受支持。了解有关 移动设备模拟 的更多信息。 -
setJavaScriptEnabled
boolean (可选)#是否在此上下文中启用 JavaScript。默认为
true
。了解有关 禁用 JavaScript 的更多信息。 -
指定用户区域设置,例如
en-GB
、de-DE
等。区域设置将影响navigator.language
值、Accept-Language
请求标头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的 模拟指南 中了解有关模拟的更多信息。 -
是否模拟网络离线。默认为
false
。了解有关 网络模拟 的更多信息。 -
setPermissions
List<String> (可选)#要授予此上下文中所有页面的权限列表。有关更多详细信息,请参阅 BrowserContext.grantPermissions()。默认为无。
-
setProxy
Proxy (可选)#-
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 路由所需的信息。这省略了在从 HAR 重放时未使用的尺寸、计时、页面、Cookie、安全和其他类型的 HAR 信息。默认为full
。 -
setRecordHarOmitContent
boolean (可选)#用于控制是否从 HAR 中省略请求内容的可选设置。默认为
false
。 -
启用 HAR 记录,将所有页面的 HAR 记录到文件系统上的指定 HAR 文件中。如果未指定,则不记录 HAR。确保调用 BrowserContext.close() 以保存 HAR。
-
启用视频录制,将所有页面的视频录制到指定目录中。如果未指定,则不录制视频。确保调用 BrowserContext.close() 以保存视频。
-
setRecordVideoSize
RecordVideoSize (可选)#录制视频的尺寸。如果未指定,则尺寸将等于缩放到适合 800x800 的
viewport
。如果未显式配置viewport
,则视频尺寸默认为 800x450。如有必要,每个页面的实际图片都将缩小以适合指定的尺寸。 -
setReducedMotion
null |enum ReducedMotion { REDUCE, NO_PREFERENCE }
(可选)#模拟
'prefers-reduced-motion'
媒体功能,支持的值为'reduce'
,'no-preference'
。有关更多详细信息,请参阅 Page.emulateMedia()。传递null
会将模拟重置为系统默认值。默认为'no-preference'
。 -
setScreenSize
ScreenSize (可选)#模拟通过
window.screen
在网页内可用的一致窗口屏幕尺寸。仅当设置了 setViewportSize 时使用。 -
setServiceWorkers
enum ServiceWorkerPolicy { ALLOW, BLOCK }
(可选)#是否允许站点注册 Service workers。默认为
'allow'
。'allow'
: 可以注册 Service Workers。'block'
: Playwright 将阻止所有 Service Workers 的注册。
-
使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.storageState() 获取的登录信息初始化上下文。
-
setStorageStatePath
Path (可选)添加于版本: v1.9#使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.storageState() 获取的登录信息初始化上下文。保存的存储状态的文件路径。
-
setStrictSelectors
boolean (可选)#如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,对选择器的所有操作 (暗示单个目标 DOM 元素) 在多个元素匹配选择器时都会抛出异常。此选项不影响任何 Locator API (Locator 始终是严格的)。默认为
false
。请参阅 Locator 以了解有关严格模式的更多信息。 -
更改上下文的时区。有关支持的时区 ID 列表,请参阅 ICU's metaZones.txt。默认为系统时区。
-
在此上下文中使用的特定用户代理。
-
setViewportSize
null | ViewportSize (可选)#为每个页面模拟一致的视口。默认为 1280x720 视口。使用
null
禁用一致的视口模拟。了解有关 视口模拟 的更多信息。注意null
值选择退出默认预设,使视口取决于操作系统定义的主机窗口大小。这使得测试的执行具有不确定性。
-
返回值
startTracing
添加于版本: v1.11此 API 控制 Chromium 追踪,这是一个底层的 chromium 特定的调试工具。用于控制 Playwright 追踪 的 API 可以在此处找到。
您可以使用 Browser.startTracing() 和 Browser.stopTracing() 来创建一个可以在 Chrome DevTools 性能面板中打开的跟踪文件。
用法
browser.startTracing(page, new Browser.StartTracingOptions()
.setPath(Paths.get("trace.json")));
page.navigate("https://www.google.com");
browser.stopTracing();
参数
-
可选,如果指定,跟踪将包括给定页面的屏幕截图。
-
options
Browser.StartTracingOptions
(可选)
返回值
stopTracing
添加于版本: v1.11此 API 控制 Chromium 追踪,这是一个底层的 chromium 特定的调试工具。用于控制 Playwright 追踪 的 API 可以在此处找到。
返回包含跟踪数据的缓冲区。
用法
Browser.stopTracing();
返回值
version
在 v1.9 之前添加返回浏览器版本。
用法
Browser.version();
返回值
Events
onDisconnected(handler)
在 v1.9 之前添加当浏览器与浏览器应用程序断开连接时发出。这可能是由于以下原因之一而发生
- 浏览器应用程序已关闭或崩溃。
- 调用了 Browser.close() 方法。
用法
Browser.onDisconnected(handler)
事件数据