浏览器
浏览器是通过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
Added in: v1.23获取浏览器所属的类型(chromium、firefox 或 webkit)。
用法
Browser.browserType();
返回
关闭
Added before v1.9如果此浏览器是通过BrowserType.launch()获取的,则会关闭该浏览器及其所有页面(如果有打开的页面)。
如果此浏览器已连接,将清除属于该浏览器的所有已创建上下文,并断开与浏览器服务器的连接。
这类似于强制退出浏览器。要优雅地关闭页面并确保接收到页面关闭事件,请在任何显式创建的BrowserContext实例上调用BrowserContext.close()(这些实例是通过Browser.newContext()创建的),然后再调用Browser.close()。
Browser对象本身被视为已释放,无法再使用。
用法
Browser.close();
Browser.close(options);
参数
返回
上下文
Added before 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
Added before v1.9表示浏览器已连接。
用法
Browser.isConnected();
返回
newBrowserCDPSession
Added in: v1.11CDP会话仅在基于Chromium的浏览器上受支持。
返回新创建的浏览器会话。
用法
Browser.newBrowserCDPSession();
返回
newContext
Added before v1.9创建一个新的浏览器上下文。它不会与其他浏览器上下文共享cookies/缓存。
如果直接使用此方法创建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
(optional)-
setAcceptDownloads
boolean (可选)#是否自动下载所有附件。默认为
true
,表示接受所有下载。 -
当使用Page.navigate()、Page.route()、Page.waitForURL()、Page.waitForRequest()或Page.waitForResponse()时,它会通过使用
URL()
构造函数来考虑基础URL以构建相应的URL。默认情况下未设置。示例:- baseURL:
http://localhost:3000
and navigating to/bar.html
results inhttp://localhost:3000/bar.html
- baseURL:
http://localhost:3000/foo/
and navigating to./bar.html
results inhttp://localhost:3000/foo/bar.html
- baseURL:
http://localhost:3000/foo
(without trailing slash) and navigating to./bar.html
results inhttp://localhost:3000/bar.html
- baseURL:
-
切换是否绕过页面的内容安全策略。默认为
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
属性应提供与证书适用的请求来源完全匹配的值。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
。了解更多关于使用设备缩放比例模拟设备的信息。 -
setExtraHTTPHeaders
Map<String, String> (可选)#一个包含要随每个请求发送的额外HTTP头的对象。默认为无。
-
setForcedColors
null |enum ForcedColors { ACTIVE, NONE }
(可选)#模拟
'forced-colors'
媒体特性,支持的值为'active'
、'none'
。详情请参阅Page.emulateMedia()。传入null
会将模拟重置为系统默认值。默认为'none'
。 -
setGeolocation
地理位置 (可选)# -
指定视口是否支持触摸事件。默认为false。了解更多关于移动设备模拟的信息。
-
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认证的凭据。如果未指定来源,则在收到未经授权的响应时,用户名和密码将被发送到任何服务器。
-
-
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
代理 (可选)#-
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
。 -
启用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
屏幕尺寸 (可选)#通过
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。 -
setTimezoneId
String (optional)#更改上下文的时区。支持的时区ID列表请参见ICU's metaZones.txt。默认为系统时区。
-
在此上下文中使用的特定用户代理。
-
setViewportSize
null | 视口尺寸 (可选)#为每个页面模拟一致的视口。默认视口尺寸为1280x720。使用
null
可禁用一致的视口模拟。了解更多关于视口模拟的信息。notenull
值表示不使用默认预设,使视口大小取决于操作系统定义的主机窗口尺寸。这会导致测试执行变得非确定性。
-
返回
newPage
Added before v1.9在新的浏览器上下文中创建一个新页面。关闭此页面也将关闭上下文。
这是一个便捷API,仅适用于单页场景和简短代码片段。生产代码和测试框架应显式创建Browser.newContext(),随后调用BrowserContext.newPage()以精确控制其生命周期。
用法
Browser.newPage();
Browser.newPage(options);
参数
options
Browser.NewPageOptions
(optional)-
setAcceptDownloads
boolean (可选)#是否自动下载所有附件。默认为
true
,表示接受所有下载。 -
当使用Page.navigate()、Page.route()、Page.waitForURL()、Page.waitForRequest()或Page.waitForResponse()时,它会通过使用
URL()
构造函数来考虑基础URL以构建相应的URL。默认情况下未设置。示例:- baseURL:
http://localhost:3000
and navigating to/bar.html
results inhttp://localhost:3000/bar.html
- baseURL:
http://localhost:3000/foo/
and navigating to./bar.html
results inhttp://localhost:3000/foo/bar.html
- baseURL:
http://localhost:3000/foo
(without trailing slash) and navigating to./bar.html
results inhttp://localhost:3000/bar.html
- baseURL:
-
切换是否绕过页面的内容安全策略。默认为
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
属性应提供与证书适用的请求来源完全匹配的值。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
。了解更多关于使用设备缩放比例模拟设备的信息。 -
setExtraHTTPHeaders
Map<String, String> (可选)#一个包含要随每个请求发送的额外HTTP头的对象。默认为无。
-
setForcedColors
null |enum ForcedColors { ACTIVE, NONE }
(可选)#模拟
'forced-colors'
媒体特性,支持的值为'active'
、'none'
。详情请参阅Page.emulateMedia()。传入null
会将模拟重置为系统默认值。默认为'none'
。 -
setGeolocation
地理位置 (可选)# -
指定视口是否支持触摸事件。默认为false。了解更多关于移动设备模拟的信息。
-
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认证的凭据。如果未指定来源,则在收到未经授权的响应时,用户名和密码将被发送到任何服务器。
-
-
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
代理 (可选)#-
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
。 -
启用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
屏幕尺寸 (可选)#通过
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。 -
setTimezoneId
String (optional)#更改上下文的时区。支持的时区ID列表请参见ICU's metaZones.txt。默认为系统时区。
-
在此上下文中使用的特定用户代理。
-
setViewportSize
null | 视口尺寸 (可选)#为每个页面模拟一致的视口。默认视口尺寸为1280x720。使用
null
可禁用一致的视口模拟。了解更多关于视口模拟的信息。notenull
值表示不使用默认预设,使视口大小取决于操作系统定义的主机窗口尺寸。这会导致测试执行变得非确定性。
-
返回
开始追踪
Added in: v1.11该API控制Chromium Tracing,这是一个底层的Chromium专用调试工具。控制Playwright Tracing的API可以在这里找到。
你可以使用Browser.startTracing()和Browser.stopTracing()来创建一个可以在Chrome开发者工具性能面板中打开的跟踪文件。
用法
browser.startTracing(page, new Browser.StartTracingOptions()
.setPath(Paths.get("trace.json")));
page.navigate("https://www.google.com");
browser.stopTracing();
参数
-
可选参数,如果指定,追踪将包含给定页面的截图。
-
options
Browser.StartTracingOptions
(可选)
返回
stopTracing
Added in: v1.11该API控制Chromium Tracing,这是一个底层的Chromium专用调试工具。控制Playwright Tracing的API可以在这里找到。
返回包含跟踪数据的缓冲区。
用法
Browser.stopTracing();
返回
版本
Added before v1.9返回浏览器版本。
用法
Browser.version();
返回
事件
onDisconnected(handler)
Added before v1.9当浏览器与浏览器应用程序断开连接时触发。可能由以下原因之一导致:
- 浏览器应用程序已关闭或崩溃。
- 调用了Browser.close()方法。
用法
Browser.onDisconnected(handler)
事件数据