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 Session 仅在基于 Chromium 的浏览器上受支持。
返回新创建的浏览器会话。
用法
Browser.newBrowserCDPSession();
返回
newContext
添加于 v1.9 之前创建一个新的浏览器上下文。它不会与其他浏览器上下文共享 cookie/缓存。
如果直接使用此方法创建 BrowserContext,最佳实践是在代码使用完 BrowserContext 后,并在调用 Browser.close() 之前,通过 BrowserContext.close() 显式关闭返回的上下文。这将确保上下文优雅关闭,并且所有附属文件(例如 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:
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:
-
切换是否绕过页面的 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 认证的凭据。如果未指定 origin,则在未授权响应时将向任何服务器发送用户名和密码。
-
-
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 时不使用的 HAR 信息,例如大小、时序、页面、cookie、安全等。默认为full
。 -
setRecordHarOmitContent
boolean (可选)#可选设置,用于控制是否从 HAR 中省略请求内容。默认为
false
。 -
将所有页面的 HAR 记录到文件系统中指定的 HAR 文件中。如果未指定,则不记录 HAR。务必调用 BrowserContext.close() 以保存 HAR。
-
将所有页面的视频记录到指定的目录中。如果未指定,则不记录视频。务必调用 BrowserContext.close() 以保存视频。
-
setRecordVideoSize
RecordVideoSize (可选)#录制视频的尺寸。如果未指定,尺寸将等于
viewport
缩小以适应 800x800。如果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 详细了解严格模式。 -
更改上下文的时区。请参阅 ICU 的 metaZones.txt 以获取支持的时区 ID 列表。默认为系统时区。
-
在此上下文中使用的特定用户代理。
-
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:
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:
-
切换是否绕过页面的 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 认证的凭据。如果未指定 origin,则在未授权响应时将向任何服务器发送用户名和密码。
-
-
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<字符串> (可选)#授予此上下文中所有页面的权限列表。有关更多详细信息,请参阅 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 时不使用的 HAR 信息,例如大小、时序、页面、cookie、安全等。默认为full
。 -
setRecordHarOmitContent
布尔型 (可选)#可选设置,用于控制是否从 HAR 中省略请求内容。默认为
false
。 -
将所有页面的 HAR 记录到文件系统中指定的 HAR 文件中。如果未指定,则不记录 HAR。务必调用 BrowserContext.close() 以保存 HAR。
-
将所有页面的视频记录到指定的目录中。如果未指定,则不记录视频。务必调用 BrowserContext.close() 以保存视频。
-
setRecordVideoSize
RecordVideoSize (可选)#录制视频的尺寸。如果未指定,尺寸将等于
viewport
缩小以适应 800x800。如果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() 获取的登录信息初始化上下文。保存存储状态文件的路径。
-
如果设置为 true,则为此上下文启用严格选择器模式。在严格选择器模式下,当多个元素匹配选择器时,所有暗示单个目标 DOM 元素的选择器操作都将抛出异常。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为
false
。请参阅 Locator 详细了解严格模式。 -
更改上下文的时区。请参阅 ICU 的 metaZones.txt 以获取支持的时区 ID 列表。默认为系统时区。
-
在此上下文中使用的特定用户代理。
-
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();
返回
事件
onDisconnected(handler)
添加于 v1.9 之前当 Browser 从浏览器应用程序断开连接时触发。这可能由以下原因之一引起:
- 浏览器应用程序关闭或崩溃。
- 调用了 Browser.close() 方法。
用法
Browser.onDisconnected(handler)
事件数据