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

browser.browserType

获取该浏览器所属的浏览器类型（chromium、firefox 或 webkit）。

用法

Browser.browserType();

返回值

BrowserType #

close

在 v1.9 之前添加

browser.close

如果此浏览器是使用 BrowserType.launch() 获取的，则关闭浏览器及其所有页面（如果已打开任何页面）。

如果此浏览器处于连接状态，则清除属于此浏览器的所有已创建上下文，并断开与浏览器服务器的连接。

备注

这类似于强制退出浏览器。要正常关闭页面并确保收到页面关闭事件，请在调用 Browser.close() 之前，对之前使用 Browser.newContext() 显式创建的任何 BrowserContext 实例调用 BrowserContext.close()。

Browser 对象本身将被视为已释放，不能再使用。

用法

Browser.close();
Browser.close(options);

参数

options Browser.CloseOptions（可选）
- setReason String（可选）添加于：v1.40#
  
  报告给因浏览器关闭而中断的操作的原因。

返回值

void #

contexts

在 v1.9 之前添加

browser.contexts

返回所有打开的浏览器上下文的数组。在新创建的浏览器中，此方法将返回零个浏览器上下文。

用法

Browser browser = pw.webkit().launch();
System.out.println(browser.contexts().size()); // 打印 "0"
BrowserContext context = browser.newContext();
System.out.println(browser.contexts().size()); // 打印 "1"

返回值

List<BrowserContext>#

isConnected

在 v1.9 之前添加

browser.isConnected

指示浏览器是否已连接。

用法

Browser.isConnected();

返回值

boolean #

newBrowserCDPSession

新增于：v1.11

browser.newBrowserCDPSession

备注

CDP 会话仅在基于 Chromium 的浏览器上受支持。

返回新创建的浏览器会话。

用法

Browser.newBrowserCDPSession();

返回值

CDPSession #

newContext

在 v1.9 之前添加

browser.newContext

创建一个新的浏览器上下文。它不会与其他浏览器上下文共享 cookie/缓存。

备注

如果直接使用此方法创建 BrowserContext，最佳做法是在代码使用完 BrowserContext 后，且在调用 Browser.close() 之前，通过 BrowserContext.close() 显式关闭返回的上下文。这将确保 context 被正常关闭，并且任何产物（如 HAR 和视频）都能被完全刷新并保存。

用法

Browser browser = playwright.firefox().launch();  // 或者 'chromium' 或 'webkit'。
// 创建一个新的无痕浏览器上下文。
BrowserContext context = browser.newContext();
// 在全新的上下文中创建一个新页面。
Page page = context.newPage();
page.navigate("https://example.com");

// 正常关闭所有内容
context.close();
browser.close();

参数

options Browser.NewContextOptions（可选）
- setAcceptDownloads boolean（可选）#
  
  是否自动下载所有附件。默认为 true，即接受所有下载。
- setBaseURL String（可选）#
  
  使用 Page.navigate()、Page.route()、Page.waitForURL()、Page.waitForRequest() 或 Page.waitForResponse() 时，它会通过使用 URL() 构造函数来构建相应的 URL，从而考虑基本 URL。默认未设置。示例如下：
  - 基本 URL：http://localhost:3000，导航到 /bar.html，结果为 http://localhost:3000/bar.html
  - 基本 URL：http://localhost:3000/foo/，导航到 ./bar.html，结果为 http://localhost:3000/foo/bar.html
  - 基本 URL：http://localhost:3000/foo（无尾部斜杠），导航到 ./bar.html，结果为 http://localhost:3000/bar.html
- setBypassCSP boolean（可选）#
  
  切换是否绕过页面的内容安全策略（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（可选）#
  - setLatitude double
    
    纬度，范围在 -90 到 90 之间。
  - setLongitude double
    
    经度，范围在 -180 到 180 之间。
  - setAccuracy double（可选）
    
    非负精度值。默认为 0。
- setHasTouch boolean（可选）#
  
  指定视口是否支持触摸事件。默认为 false。了解有关移动设备模拟的更多信息。
- setHttpCredentials HttpCredentials（可选）#
  - setUsername String
  - setPassword String
  - setOrigin String（可选）
    
    限制在特定源（scheme://host:port）上发送 HTTP 凭据。
  - setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS }（可选）
    
    此选项仅适用于从相应 APIRequestContext 发送的请求，不影响从浏览器发送的请求。'always' - 每个 API 请求都将发送带有基本身份验证凭据的 Authorization 标头。'unauthorized - 仅在收到带有 WWW-Authenticate 标头的 401（未授权）响应时才发送凭据。默认为 'unauthorized'。
  HTTP 身份验证的凭据。如果未指定源，则在收到未经授权的响应时，用户名和密码将发送到任何服务器。
- setIgnoreHTTPSErrors boolean（可选）#
  
  发送网络请求时是否忽略 HTTPS 错误。默认为 false。
- setIsMobile boolean（可选）#
  
  是否考虑 meta viewport 标签并启用触摸事件。isMobile 是设备的一部分，因此实际上无需手动设置。默认为 false，且在 Firefox 中不受支持。了解有关移动设备模拟的更多信息。
- setJavaScriptEnabled boolean（可选）#
  
  在此上下文中是否启用 JavaScript。默认为 true。了解有关禁用 JavaScript 的更多信息。
- setLocale String（可选）#
  
  指定用户区域设置，例如 en-GB、de-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求标头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的模拟指南中了解有关模拟的更多信息。
- setOffline boolean（可选）#
  
  是否模拟网络离线。默认为 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 进行路由所需的信息。这将省略大小、时间、页面、cookie、安全性和其他类型的 HAR 信息，这些信息在从 HAR 重放时不会使用。默认为 full。
- setRecordHarOmitContent boolean（可选）#
  
  用于控制是否从 HAR 中省略请求内容的可选设置。默认为 false。
- setRecordHarPath Path（可选）#
  
  启用将所有页面的 HAR 记录到文件系统上指定的 HAR 文件中。如果未指定，则不记录 HAR。确保调用 BrowserContext.close() 以保存 HAR。
- setRecordHarUrlFilter String | Pattern（可选）#
- setRecordVideoDir Path（可选）#
  
  启用将所有页面的视频记录到指定目录中。如果未指定，则不记录视频。确保调用 BrowserContext.close() 以保存视频。
- setRecordVideoSize RecordVideoSize（可选）#
  - setWidth int
    
    视频帧宽度。
  - setHeight int
    
    视频帧高度。
  录制视频的尺寸。如果未指定，尺寸将等于 viewport 缩小到适合 800x800 的大小。如果未明确配置 viewport，视频大小默认为 80

返回值

BrowserContext #

newPage

在 v1.9 之前添加

browser.newPage

在新的浏览器上下文（BrowserContext）中创建一个新页面。关闭此页面也将关闭该上下文。

这是一个便捷 API，仅应用于单页场景和简短代码片段。生产代码和测试框架应显式创建 Browser.newContext()，然后创建 BrowserContext.newPage()，以精确控制其生命周期。

用法

Browser.newPage();
Browser.newPage(options);

参数

options Browser.NewPageOptions（可选）
- setAcceptDownloads boolean（可选）#
  
  是否自动下载所有附件。默认为 true，即接受所有下载。
- setBaseURL String（可选）#
  
  使用 Page.navigate()、Page.route()、Page.waitForURL()、Page.waitForRequest() 或 Page.waitForResponse() 时，它会通过使用 URL() 构造函数来构建相应的 URL，从而考虑基础 URL。默认未设置。示例：
  - 基础 URL：http://localhost:3000，导航到 /bar.html，结果为 http://localhost:3000/bar.html
  - 基础 URL：http://localhost:3000/foo/，导航到 ./bar.html，结果为 http://localhost:3000/foo/bar.html
  - 基础 URL：http://localhost:3000/foo（无尾部斜杠），导航到 ./bar.html，结果为 http://localhost:3000/bar.html
- setBypassCSP boolean（可选）#
  
  切换是否绕过页面的内容安全策略（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（可选）#
  - setLatitude double
    
    纬度，范围在 -90 到 90 之间。
  - setLongitude double
    
    经度，范围在 -180 到 180 之间。
  - setAccuracy double（可选）
    
    非负精度值。默认为 0。
- setHasTouch boolean（可选）#
  
  指定视口是否支持触摸事件。默认为 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。
- setIsMobile boolean（可选）#
  
  是否考虑 meta viewport 标签并启用触摸事件。isMobile 是设备的一部分，因此实际上无需手动设置。默认为 false，且在 Firefox 中不受支持。了解有关移动设备模拟的更多信息。
- setJavaScriptEnabled boolean（可选）#
  
  是否在上下文中启用 JavaScript。默认为 true。了解有关禁用 JavaScript 的更多信息。
- setLocale String（可选）#
  
  指定用户区域设置，例如 en-GB、de-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求标头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的模拟指南中了解有关模拟的更多信息。
- setOffline boolean（可选）#
  
  是否模拟网络离线。默认为 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 路由所需的信息。这将省略大小、时间、页面、cookie、安全性和其他类型的 HAR 信息，这些信息在从 HAR 重放时不会使用。默认为 full。
- setRecordHarOmitContent boolean（可选）#
  
  用于控制是否从 HAR 中省略请求内容的可选设置。默认为 false。
- setRecordHarPath Path（可选）#
  
  启用将所有页面的 HAR 记录到文件系统上指定的 HAR 文件中。如果未指定，则不记录 HAR。确保调用 BrowserContext.close() 以保存 HAR。
- setRecordHarUrlFilter String | Pattern（可选）#
- setRecordVideoDir Path（可选）#
  
  启用将所有页面的视频记录到指定目录中。如果未指定，则不记录视频。确保调用 BrowserContext.close() 以保存视频。
- setRecordVideoSize RecordVideoSize（可选）#
  - setWidth int
    
    视频帧宽度。
  - setHeight int
    
    视频帧高度。
  录制视频的尺寸。如果未指定，尺寸将等于 viewport 缩小到适合 800x800 的大小。如果未显式配置 viewport，视频大小默认为 800x450。如有必要，每个页面的实际画面将缩小以适应指定大小。
- setReducedMotion [

返回值

Page #

startTracing

新增于：v1.11

browser.startTracing

备注

此 API 用于控制 Chromium Tracing，这是一种特定于 Chromium 的底层调试工具。用于控制 Playwright Tracing 的 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();

参数

page Page（可选）#

可选，如果指定，则跟踪将包括给定页面的屏幕截图。
options Browser.StartTracingOptions（可选）
- setCategories List<String>（可选）#
  
  指定要使用的自定义类别，而不是默认类别。
- setPath Path（可选）#
  
  写入跟踪文件的路径。
- setScreenshots boolean（可选）#
  
  在跟踪中捕获屏幕截图。

返回值

void #

stopTracing

新增于：v1.11

browser.stopTracing

备注

此 API 控制 Chromium Tracing，这是一种特定于 Chromium 的底层调试工具。控制 Playwright Tracing 的 API 可在此处找到。

返回包含跟踪数据的缓冲区。

用法

Browser.stopTracing();

返回值

[byte[]]#

version

在 v1.9 之前添加

browser.version

返回浏览器版本。

用法

Browser.version();

返回值

String #

事件

onDisconnected(handler)

在 v1.9 之前添加

browser.onDisconnected(handler)

当浏览器与浏览器应用程序断开连接时触发。这可能是由于以下原因之一：

浏览器应用程序关闭或崩溃。
调用了 Browser.close() 方法。

用法

Browser.onDisconnected(handler)

事件数据

Browser

方法​

browserType​

close​

用法​

参数​

返回值​

contexts​

用法​

返回值​

isConnected​

用法​

返回值​

newBrowserCDPSession​

newContext​

参数​

newPage​

startTracing​

stopTracing​

version​

事件​

onDisconnected(handler)​

方法

browserType

close

用法

参数

返回值

contexts

用法

返回值

isConnected

用法

返回值

newBrowserCDPSession

newContext

参数

newPage

startTracing

stopTracing

version

事件

onDisconnected(handler)