BrowserContext

BrowserContexts 提供了一种操作多个独立浏览器会话的方式。

如果页面打开另一个页面，例如通过 window.open 调用，则弹出窗口将属于父页面的浏览器上下文。

Playwright 允许使用 Browser.newContext() 方法创建隔离的非持久浏览器上下文。非持久浏览器上下文不会将任何浏览数据写入磁盘。

// Create a new incognito browser context
BrowserContext context = browser.newContext();
// Create a new page inside context.
Page page = context.newPage();
page.navigate("https://example.com");
// Dispose context once it is no longer needed.
context.close();

方法

addCookies

在 v1.9 版本之前添加

browserContext.addCookies

将 Cookie 添加到此浏览器上下文中。此上下文中的所有页面都将安装这些 Cookie。Cookie 可以通过 BrowserContext.cookies() 获取。

用法

browserContext.addCookies(Arrays.asList(cookieObject1, cookieObject2));

参数

cookies List<Cookie>#
- setName String
- setValue String
- setUrl String (可选)
  
  url 或 domain / path 必须提供一个。可选。
- setDomain String (可选)
  
  为了使 Cookie 也适用于所有子域名，请在域名前加上一个点，例如 ".example.com"。url 或 domain / path 必须提供一个。可选。
- setPath String (可选)
  
  url 或 domain / path 必须提供一个。可选。
- setExpires double (可选)
  
  Unix 时间戳，单位为秒。可选。
- setHttpOnly boolean (可选)
  
  可选。
- setSecure boolean (可选)
  
  可选。
- setSameSite enum SameSiteAttribute { STRICT, LAX, NONE } (可选)
  
  可选。

返回值

void #

addInitScript

在 v1.9 版本之前添加

browserContext.addInitScript

添加一个脚本，该脚本将在以下情况下执行：

每当在浏览器上下文中创建或导航页面时。
每当子框架在浏览器上下文中的任何页面中附加或导航时。在这种情况下，脚本在新附加的框架的上下文中执行。

脚本在文档创建之后但在其任何脚本运行之前执行。这对于修改 JavaScript 环境很有用，例如，为 Math.random 设定种子。

用法

在页面加载之前覆盖 Math.random 的示例

// preload.js
Math.random = () => 42;

// In your playwright script, assuming the preload.js file is in same directory.
browserContext.addInitScript(Paths.get("preload.js"));

注意

通过 BrowserContext.addInitScript() 和 Page.addInitScript() 安装的多个脚本的执行顺序未定义。

参数

script String | Path #

要在浏览器上下文中所有页面中执行的脚本。

返回值

void #

backgroundPages

添加于: v1.11

browserContext.backgroundPages

注意

后台页面仅在基于 Chromium 的浏览器上受支持。

上下文中所有现有的后台页面。

用法

BrowserContext.backgroundPages();

返回值

List<Page>#

browser

在 v1.9 版本之前添加

browserContext.browser

返回上下文的浏览器实例。如果它是作为持久上下文启动的，则返回 null。

用法

BrowserContext.browser();

返回值

null | Browser #

clearCookies

在 v1.9 版本之前添加

browserContext.clearCookies

从上下文中移除 Cookie。接受可选的过滤器。

用法

context.clearCookies();
context.clearCookies(new BrowserContext.ClearCookiesOptions().setName("session-id"));
context.clearCookies(new BrowserContext.ClearCookiesOptions().setDomain("my-origin.com"));
context.clearCookies(new BrowserContext.ClearCookiesOptions().setPath("/api/v1"));
context.clearCookies(new BrowserContext.ClearCookiesOptions()
                         .setName("session-id")
                         .setDomain("my-origin.com"));

参数

options BrowserContext.ClearCookiesOptions (可选)
- setDomain String | Pattern (可选)添加于: v1.43#
  
  仅移除具有给定域名的 Cookie。
- setName String | Pattern (可选)添加于: v1.43#
  
  仅移除具有给定名称的 Cookie。
- setPath String | Pattern (可选)添加于: v1.43#
  
  仅移除具有给定路径的 Cookie。

返回值

void #

clearPermissions

在 v1.9 版本之前添加

browserContext.clearPermissions

清除浏览器上下文的所有权限覆盖。

用法

BrowserContext context = browser.newContext();
context.grantPermissions(Arrays.asList("clipboard-read"));
// do stuff ..
context.clearPermissions();

返回值

void #

close

在 v1.9 版本之前添加

browserContext.close

关闭浏览器上下文。所有属于该浏览器上下文的页面都将被关闭。

注意

默认浏览器上下文无法关闭。

用法

BrowserContext.close();
BrowserContext.close(options);

参数

options BrowserContext.CloseOptions (可选)
- setReason String (可选)添加于: v1.40#
  
  报告给上下文关闭中断的操作的原因。

返回值

void #

cookies

在 v1.9 版本之前添加

browserContext.cookies

如果未指定 URL，则此方法返回所有 Cookie。如果指定了 URL，则仅返回影响这些 URL 的 Cookie。

用法

BrowserContext.cookies();
BrowserContext.cookies(urls);

参数

urls String | List<String> (可选)#

可选的 URL 列表。

返回值

List<Cookie>#
- name String
- value String
- domain String
- path String
- expires double
  
  Unix 时间戳，单位为秒。
- httpOnly boolean
- secure boolean
- sameSite enum SameSiteAttribute { STRICT, LAX, NONE }

exposeBinding

在 v1.9 版本之前添加

browserContext.exposeBinding

此方法在上下文中每个页面的每个框架的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。如果 callback 返回一个 Promise，它将被等待。

callback 函数的第一个参数包含有关调用者的信息：{ browserContext: BrowserContext, page: Page, frame: Frame }。

有关仅页面版本的，请参阅 Page.exposeBinding()。

用法

在上下文中向所有页面中的所有框架公开页面 URL 的示例

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType webkit = playwright.webkit();
      Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));
      BrowserContext context = browser.newContext();
      context.exposeBinding("pageURL", (source, args) -> source.page().url());
      Page page = context.newPage();
      page.setContent("<script>\n" +
        "  async function onClick() {\n" +
        "    document.querySelector('div').textContent = await window.pageURL();\n" +
        "  }\n" +
        "</script>\n" +
        "<button onclick=\"onClick()\">Click me</button>\n" +
        "<div></div>");
      page.getByRole(AriaRole.BUTTON).click();
    }
  }
}

参数

name String #

window 对象上的函数名称。
callback BindingCallback#

将在 Playwright 上下文中调用的回调函数。
options BrowserContext.ExposeBindingOptions (可选)
- setHandle boolean (可选)#
  
  已弃用
  此选项将在未来版本中移除。
  
  是否将参数作为句柄传递，而不是按值传递。当传递句柄时，仅支持一个参数。当按值传递时，支持多个参数。

返回值

void #

exposeFunction

在 v1.9 版本之前添加

browserContext.exposeFunction

此方法在上下文中每个页面的每个框架的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。

如果 callback 返回一个 Promise，它将被等待。

有关仅页面版本的，请参阅 Page.exposeFunction()。

用法

向上下文中的所有页面添加 sha256 函数的示例

import com.microsoft.playwright.*;

import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Base64;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType webkit = playwright.webkit();
      Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));
      BrowserContext context = browser.newContext();
      context.exposeFunction("sha256", args -> {
        String text = (String) args[0];
        MessageDigest crypto;
        try {
          crypto = MessageDigest.getInstance("SHA-256");
        } catch (NoSuchAlgorithmException e) {
          return null;
        }
        byte[] token = crypto.digest(text.getBytes(StandardCharsets.UTF_8));
        return Base64.getEncoder().encodeToString(token);
      });
      Page page = context.newPage();
      page.setContent("<script>\n" +
        "  async function onClick() {\n" +
        "    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');\n" +
        "  }\n" +
        "</script>\n" +
        "<button onclick=\"onClick()\">Click me</button>\n" +
        "<div></div>\n");
      page.getByRole(AriaRole.BUTTON).click();
    }
  }
}

参数

name String #

window 对象上的函数名称。
callback FunctionCallback#

将在 Playwright 上下文中调用的回调函数。

返回值

void #

grantPermissions

在 v1.9 版本之前添加

browserContext.grantPermissions

授予浏览器上下文指定的权限。如果指定了来源，则仅向给定来源授予相应的权限。

用法

BrowserContext.grantPermissions(permissions);
BrowserContext.grantPermissions(permissions, options);

参数

permissions List<String>#

要授予的权限列表。

危险
支持的权限在浏览器之间，甚至在同一浏览器的不同版本之间都可能有所不同。任何权限都可能在更新后停止工作。

以下是一些可能受某些浏览器支持的权限：
- 'accelerometer'
- 'ambient-light-sensor'
- 'background-sync'
- 'camera'
- 'clipboard-read'
- 'clipboard-write'
- 'geolocation'
- 'gyroscope'
- 'magnetometer'
- 'microphone'
- 'midi-sysex' (系统独占 MIDI)
- 'midi'
- 'notifications'
- 'payment-handler'
- 'storage-access'
options BrowserContext.GrantPermissionsOptions (可选)
- setOrigin String (可选)#
  
  要授予权限的来源，例如 "https://example.com"。

返回值

void #

newCDPSession

添加于: v1.11

browserContext.newCDPSession

注意

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

返回新创建的会话。

用法

BrowserContext.newCDPSession(page);

参数

page Page | Frame #

要为其创建新会话的目标。为了向后兼容，此参数名为 page，但它可以是 Page 或 Frame 类型。

返回值

CDPSession #

newPage

在 v1.9 版本之前添加

browserContext.newPage

在浏览器上下文中创建一个新页面。

用法

BrowserContext.newPage();

返回值

Page #

pages

在 v1.9 版本之前添加

browserContext.pages

返回上下文中所有打开的页面。

用法

BrowserContext.pages();

返回值

List<Page>#

route

在 v1.9 版本之前添加

browserContext.route

路由提供了修改浏览器上下文中任何页面发出的网络请求的功能。启用路由后，每个与 url 模式匹配的请求都将暂停，除非它被继续、完成或中止。

注意

BrowserContext.route() 不会拦截 Service Worker 拦截的请求。请参阅这个 issue。我们建议在使用请求拦截时禁用 Service Worker，方法是将 setServiceWorkers 设置为 'block'。

用法

一个简单的处理程序示例，该处理程序中止所有图像请求

BrowserContext context = browser.newContext();
context.route("**/*.{png,jpg,jpeg}", route -> route.abort());
Page page = context.newPage();
page.navigate("https://example.com");
browser.close();

或使用正则表达式模式的相同代码片段

BrowserContext context = browser.newContext();
context.route(Pattern.compile("(\\.png$)|(\\.jpg$)"), route -> route.abort());
Page page = context.newPage();
page.navigate("https://example.com");
browser.close();

可以检查请求以决定路由操作。例如，模拟所有包含某些 post 数据的请求，并将所有其他请求保持原样

context.route("/api/**", route -> {
  if (route.request().postData().contains("my-string"))
    route.fulfill(new Route.FulfillOptions().setBody("mocked-data"));
  else
    route.resume();
});

当请求与两个处理程序都匹配时，页面路由（使用 Page.route() 设置）优先于浏览器上下文路由。

要移除路由及其处理程序，可以使用 BrowserContext.unroute()。

注意

启用路由会禁用 http 缓存。

参数

url String | Pattern | Predicate<String>#

用于在路由时匹配的 glob 模式、正则表达式模式或谓词，接收 [URL]。当通过上下文选项提供了 setBaseURL 并且传递的 URL 是路径时，它会通过 new URL() 构造函数合并。
handler Consumer<Route>#

用于路由请求的处理函数。
options BrowserContext.RouteOptions (可选)
- setTimes int (可选)添加于: v1.15#
  
  路由应使用的次数。默认情况下，它将每次都使用。

返回值

void #

routeFromHAR

添加于: v1.23

browserContext.routeFromHAR

如果指定，则在此上下文中发出的网络请求将从 HAR 文件提供。阅读更多关于从 HAR 重放。

Playwright 不会从 HAR 文件提供 Service Worker 拦截的请求。请参阅这个 issue。我们建议在使用请求拦截时禁用 Service Worker，方法是将 setServiceWorkers 设置为 'block'。

用法

BrowserContext.routeFromHAR(har);
BrowserContext.routeFromHAR(har, options);

参数

har Path #

具有预先录制的网络数据的 HAR 文件的路径。如果 path 是相对路径，则它是相对于当前工作目录解析的。
options BrowserContext.RouteFromHAROptions (可选)
- setNotFound enum HarNotFound { ABORT, FALLBACK } (可选)#
  - 如果设置为 'abort'，则任何在 HAR 文件中未找到的请求都将被中止。
  - 如果设置为 'fallback'，则会回退到处理程序链中的下一个路由处理程序。
  默认为 abort。
- setUpdate boolean (可选)#
  
  如果指定，则使用实际网络信息更新给定的 HAR，而不是从文件提供服务。当调用 BrowserContext.close() 时，该文件将被写入磁盘。
- setUpdateContent enum RouteFromHarUpdateContentPolicy { EMBED, ATTACH } (可选)添加于: v1.32#
  
  用于控制资源内容管理的可选设置。如果指定了 attach，则资源将作为单独的文件或 ZIP 存档中的条目持久保存。如果指定了 embed，则内容将以内联方式存储在 HAR 文件中。
- setUpdateMode enum HarMode { FULL, MINIMAL } (可选)添加于: v1.32#
  
  当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这省略了大小、计时、页面、Cookie、安全性和其他类型的 HAR 信息，这些信息在从 HAR 重放时未使用。默认为 minimal。
- setUrl String | Pattern (可选)#
  
  用于匹配请求 URL 的 glob 模式、正则表达式或谓词。只有 URL 与模式匹配的请求才会从 HAR 文件提供。如果未指定，则所有请求都从 HAR 文件提供。

返回值

void #

routeWebSocket

添加于: v1.48

browserContext.routeWebSocket

此方法允许修改浏览器上下文中任何页面建立的 websocket 连接。

请注意，只有在此方法调用后创建的 WebSockets 才会被路由。建议在创建任何页面之前调用此方法。

用法

以下是一个简单的处理程序示例，该处理程序阻止某些 websocket 消息。有关更多详细信息和示例，请参阅 WebSocketRoute。

context.routeWebSocket("/ws", ws -> {
  ws.routeSend(message -> {
    if ("to-be-blocked".equals(message))
      return;
    ws.send(message);
  });
  ws.connect();
});

参数

url String | Pattern | Predicate<String>#

只有 URL 与此模式匹配的 WebSocket 才会被路由。字符串模式可以是相对于 setBaseURL 上下文选项的相对路径。
handler Consumer<WebSocketRoute>#

用于路由 WebSocket 的处理函数。

返回值

void #

在 v1.9 版本之前添加

browserContext.setDefaultNavigationTimeout

此设置将更改以下方法和相关快捷方式的默认最大导航时间：

注意

Page.setDefaultNavigationTimeout() 和 Page.setDefaultTimeout() 优先于 BrowserContext.setDefaultNavigationTimeout()。

用法

BrowserContext.setDefaultNavigationTimeout(timeout);

参数

timeout double #

最大导航时间，单位为毫秒

setDefaultTimeout

在 v1.9 版本之前添加

browserContext.setDefaultTimeout

此设置将更改所有接受 timeout 选项的方法的默认最大时间。

注意

Page.setDefaultNavigationTimeout(), Page.setDefaultTimeout() 和 BrowserContext.setDefaultNavigationTimeout() 优先于 BrowserContext.setDefaultTimeout()。

用法

BrowserContext.setDefaultTimeout(timeout);

参数

timeout double #

最大时间，单位为毫秒。传递 0 以禁用超时。

setExtraHTTPHeaders

在 v1.9 版本之前添加

browserContext.setExtraHTTPHeaders

额外的 HTTP 标头将随上下文中任何页面发起的每个请求一起发送。这些标头与使用 Page.setExtraHTTPHeaders() 设置的页面特定的额外 HTTP 标头合并。如果页面覆盖了特定的标头，则将使用页面特定的标头值，而不是浏览器上下文标头值。

注意

BrowserContext.setExtraHTTPHeaders() 不保证传出请求中标头的顺序。

用法

BrowserContext.setExtraHTTPHeaders(headers);

参数

headers Map<String, String>#

一个对象，其中包含要随每个请求一起发送的附加 HTTP 标头。所有标头值都必须是字符串。

返回值

void #

setGeolocation

在 v1.9 版本之前添加

browserContext.setGeolocation

设置上下文的地理位置。传递 null 或 undefined 模拟位置不可用。

用法

browserContext.setGeolocation(new Geolocation(59.95, 30.31667));

注意

考虑使用 BrowserContext.grantPermissions() 授予浏览器上下文页面读取其地理位置的权限。

参数

geolocation null | Geolocation#
- setLatitude double
  
  纬度，介于 -90 和 90 之间。
- setLongitude double
  
  经度，介于 -180 和 180 之间。
- setAccuracy double (可选)
  
  非负的精度值。默认为 0。

返回值

void #

setOffline

在 v1.9 版本之前添加

browserContext.setOffline

用法

BrowserContext.setOffline(offline);

参数

offline boolean #

是否为浏览器上下文模拟离线网络状态。

返回值

void #

storageState

在 v1.9 版本之前添加

browserContext.storageState

返回此浏览器上下文的存储状态，包含当前的 cookies 和本地存储快照。

用法

BrowserContext.storageState();
BrowserContext.storageState(options);

参数

options BrowserContext.StorageStateOptions (可选)
- setPath Path (可选)#
  
  用于保存存储状态的文件路径。如果 setPath 是相对路径，则它将相对于当前工作目录解析。如果未提供路径，则仍会返回存储状态，但不会保存到磁盘。

返回值

String #

unroute

在 v1.9 版本之前添加

browserContext.unroute

移除使用 BrowserContext.route() 创建的路由。当未指定 handler 时，移除 url 的所有路由。

用法

BrowserContext.unroute(url);
BrowserContext.unroute(url, handler);

参数

url String | Pattern | Predicate<String>#

用于注册 BrowserContext.route() 路由的 glob 模式、正则表达式模式或接收 [URL] 的谓词。
handler Consumer<Route> (可选)#

用于注册 BrowserContext.route() 路由的可选处理函数。

返回值

void #

unrouteAll

添加于版本: v1.41

browserContext.unrouteAll

移除所有使用 BrowserContext.route() 和 BrowserContext.routeFromHAR() 创建的路由。

用法

BrowserContext.unrouteAll();

返回值

void #

waitForCondition

添加于: v1.32

browserContext.waitForCondition

该方法将阻塞，直到条件返回 true。当方法等待条件时，将分发所有 Playwright 事件。

用法

使用此方法等待依赖于页面事件的条件

List<String> failedUrls = new ArrayList<>();
context.onResponse(response -> {
  if (!response.ok()) {
    failedUrls.add(response.url());
  }
});
page1.getByText("Create user").click();
page2.getByText("Submit button").click();
context.waitForCondition(() -> failedUrls.size() > 3);

参数

condition [BooleanSupplier]#

要等待的条件。
options BrowserContext.WaitForConditionOptions (可选)
- setTimeout double (可选)#
  
  等待的最长时间，以毫秒为单位。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。

返回值

void #

waitForConsoleMessage

添加于版本: v1.34

browserContext.waitForConsoleMessage

执行操作并等待上下文中页面记录 ConsoleMessage。如果提供了 predicate，它会将 ConsoleMessage 值传递到 predicate 函数中，并等待 predicate(message) 返回真值。如果在 BrowserContext.onConsoleMessage(handler) 事件触发之前页面关闭，将抛出错误。

用法

BrowserContext.waitForConsoleMessage(callback);
BrowserContext.waitForConsoleMessage(callback, options);

参数

options BrowserContext.WaitForConsoleMessageOptions (可选)
- setPredicate Predicate<ConsoleMessage> (可选)#
  
  接收 ConsoleMessage 对象，并在等待应该解决时解析为真值。
- setTimeout double (可选)#
  
  等待的最长时间，以毫秒为单位。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 更改。
callback Runnable #

执行触发事件操作的回调。

返回值

ConsoleMessage #

waitForPage

添加于版本: v1.9

browserContext.waitForPage

执行操作并等待在此上下文中创建新的 Page。如果提供了 predicate，它会将 Page 值传递到 predicate 函数中，并等待 predicate(event) 返回真值。如果在创建新的 Page 之前上下文关闭，将抛出错误。

用法

BrowserContext.waitForPage(callback);
BrowserContext.waitForPage(callback, options);

参数

options BrowserContext.WaitForPageOptions (可选)
- setPredicate Predicate<Page> (可选)#
  
  接收 Page 对象，并在等待应该解决时解析为真值。
- setTimeout double (可选)#
  
  等待的最长时间，以毫秒为单位。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 更改。
callback Runnable #

执行触发事件操作的回调。

返回值

Page #

属性

clock()

添加于版本: v1.45

browserContext.clock()

Playwright 具有模拟时钟和时间流逝的能力。

用法

BrowserContext.clock()

返回值

Clock

request()

添加于版本: v1.16

browserContext.request()

与此上下文关联的 API 测试助手。使用此 API 发出的请求将使用上下文 cookies。

用法

BrowserContext.request()

返回值

APIRequestContext

tracing()

添加于版本: v1.12

browserContext.tracing()

用法

BrowserContext.tracing()

返回值

Tracing

事件

onBackgroundPage(handler)

添加于: v1.11

browserContext.onBackgroundPage(handler)

注意

仅适用于 Chromium 浏览器的持久上下文。

当在此上下文中创建新的后台页面时触发。

context.onBackgroundPage(backgroundPage -> {
  System.out.println(backgroundPage.url());
});

用法

BrowserContext.onBackgroundPage(handler)

事件数据

Page

onClose(handler)

在 v1.9 版本之前添加

browserContext.onClose(handler)

当浏览器上下文关闭时触发。这可能是由于以下原因之一造成的：

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

用法

BrowserContext.onClose(handler)

事件数据

BrowserContext

onConsoleMessage(handler)

添加于版本: v1.34

browserContext.onConsoleMessage(handler)

当页面内的 JavaScript 调用控制台 API 方法（例如 console.log 或 console.dir）之一时触发。

传递到 console.log 的参数和页面在 ConsoleMessage 事件处理程序参数中可用。

用法

context.onConsoleMessage(msg -> {
  for (int i = 0; i < msg.args().size(); ++i)
    System.out.println(i + ": " + msg.args().get(i).jsonValue());
});
page.evaluate("() => console.log('hello', 5, { foo: 'bar' })");

事件数据

ConsoleMessage

onDialog(handler)

添加于版本: v1.34

browserContext.onDialog(handler)

当出现 JavaScript 对话框时触发，例如 alert、prompt、confirm 或 beforeunload。监听器必须 Dialog.accept() 或 Dialog.dismiss() 对话框 - 否则页面将冻结等待对话框，并且诸如单击之类的操作将永远不会完成。

用法

context.onDialog(dialog -> {
  dialog.accept();
});

注意

当没有 Page.onDialog(handler) 或 BrowserContext.onDialog(handler) 监听器时，所有对话框都会自动关闭。

事件数据

Dialog

onPage(handler)

在 v1.9 版本之前添加

browserContext.onPage(handler)

当在 BrowserContext 中创建新页面时，将触发此事件。页面可能仍在加载中。此事件也会为弹出页面触发。另请参阅 Page.onPopup(handler) 以接收有关特定页面的弹出窗口的事件。

页面可用的最早时刻是它导航到初始 URL 时。例如，当使用 window.open('http://example.com') 打开弹出窗口时，当对 "http://example.com" 的网络请求完成并且其响应已开始在弹出窗口中加载时，将触发此事件。如果您想路由/监听此网络请求，请分别使用 BrowserContext.route() 和 BrowserContext.onRequest(handler)，而不是 Page 上的类似方法。

Page newPage = context.waitForPage(() -> {
  page.getByText("open new page").click();
});
System.out.println(newPage.evaluate("location.href"));

注意

使用 Page.waitForLoadState() 等待页面达到特定状态（在大多数情况下您不需要它）。

用法

BrowserContext.onPage(handler)

事件数据

Page

onRequest(handler)

添加于版本: v1.12

browserContext.onRequest(handler)

当从此上下文创建的任何页面发出请求时触发。 request 对象是只读的。要仅监听来自特定页面的请求，请使用 Page.onRequest(handler)。

为了拦截和修改请求，请参阅 BrowserContext.route() 或 Page.route()。

用法

BrowserContext.onRequest(handler)

事件数据

Request

onRequestFailed(handler)

添加于版本: v1.12

browserContext.onRequestFailed(handler)

当请求失败时触发，例如由于超时。要仅监听来自特定页面的失败请求，请使用 Page.onRequestFailed(handler)。

注意

HTTP 错误响应（例如 404 或 503）从 HTTP 的角度来看仍然是成功的响应，因此请求将使用 BrowserContext.onRequestFinished(handler) 事件完成，而不是 BrowserContext.onRequestFailed(handler)。

用法

BrowserContext.onRequestFailed(handler)

事件数据

Request

onRequestFinished(handler)

添加于版本: v1.12

browserContext.onRequestFinished(handler)

当请求在下载响应主体后成功完成时触发。对于成功的响应，事件序列为 request、response 和 requestfinished。要监听来自特定页面的成功请求，请使用 Page.onRequestFinished(handler)。

用法

BrowserContext.onRequestFinished(handler)

事件数据

Request

onResponse(handler)

添加于版本: v1.12

browserContext.onResponse(handler)

当收到请求的 response 状态和标头时触发。对于成功的响应，事件序列为 request、response 和 requestfinished。要监听来自特定页面的响应事件，请使用 Page.onResponse(handler)。

用法

BrowserContext.onResponse(handler)

事件数据

Response

onWebError(handler)

添加于版本: v1.38

browserContext.onWebError(handler)

当此上下文中任何页面中发生未处理的异常时触发。要监听来自特定页面的错误，请改为使用 Page.onPageError(handler)。

用法

BrowserContext.onWebError(handler)

事件数据

WebError

方法​

addCookies​

addInitScript​

backgroundPages​

browser​

clearCookies​

clearPermissions​

close​

cookies​

exposeBinding​

exposeFunction​

grantPermissions​

newCDPSession​

newPage​

pages​

route​

routeFromHAR​

routeWebSocket​

setDefaultNavigationTimeout​

setDefaultTimeout​

setExtraHTTPHeaders​

setGeolocation​

setOffline​

storageState​

unroute​

unrouteAll​

waitForCondition​

waitForConsoleMessage​

waitForPage​

属性​

clock()​

request()​

tracing()​

事件​

onBackgroundPage(handler)​

onClose(handler)​

onConsoleMessage(handler)​

onDialog(handler)​

onPage(handler)​

onRequest(handler)​

onRequestFailed(handler)​

onRequestFinished(handler)​

onResponse(handler)​

onWebError(handler)​

方法

addCookies

addInitScript

backgroundPages

browser

clearCookies

clearPermissions

close

cookies

exposeBinding

exposeFunction

grantPermissions

newCDPSession

newPage

pages

route

routeFromHAR

routeWebSocket

setDefaultNavigationTimeout

setDefaultTimeout

setExtraHTTPHeaders

setGeolocation

setOffline

storageState

unroute

unrouteAll

waitForCondition

waitForConsoleMessage

waitForPage

属性

clock()

request()

tracing()

事件

onBackgroundPage(handler)

onClose(handler)

onConsoleMessage(handler)

onDialog(handler)

onPage(handler)

onRequest(handler)

onRequestFailed(handler)

onRequestFinished(handler)

onResponse(handler)

onWebError(handler)