BrowserContext

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

如果一个页面打开另一个页面（例如通过 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。可以通过 BrowserContext.cookies() 获取 Cookie。

用法

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

参数

cookies List<Cookie>#
- setName String
- setValue String
- setUrl String （可选）
  
  需要提供 url 或 domain / path。可选。
- setDomain String （可选）
  
  为了让 Cookie 也适用于所有子域，请在 domain 前加上一个点，例如：".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#
  
  仅移除具有给定 domain 的 Cookie。
- setName String | Pattern （可选）添加于：v1.43#
  
  仅移除具有给定 name 的 Cookie。
- setPath String | Pattern （可选）添加于：v1.43#
  
  仅移除具有给定 path 的 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 并返回一个解析为 callback 返回值的 Promise。如果 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 （可选）#
  
  已弃用
  此选项将来会被移除。
  
  是将参数作为 handle 传递，而不是按值传递。当传递 handle 时，只支持一个参数。当按值传递时，支持多个参数。

返回值

void #

exposeFunction

在 v1.9 之前添加

browserContext.exposeFunction

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

如果 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

授予浏览器上下文指定的权限。如果指定了 origin，则仅授予给定 origin 对应的权限。

用法

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' (system-exclusive midi)
- 'midi'
- 'notifications'
- 'payment-handler'
- 'storage-access'
options BrowserContext.GrantPermissionsOptions （可选）
- setOrigin String （可选）#
  
  要授予权限的 origin，例如 "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。建议在使用请求拦截时，通过将 setServiceWorkers 设置为 'block' 来禁用 Service Worker。

用法

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

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] 以在路由期间进行匹配的 predicate。如果在上下文选项中设置了 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。建议在使用请求拦截时，通过将 setServiceWorkers 设置为 'block' 来禁用 Service Worker。

用法

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 模式、正则表达式或 predicate。只有 URL 与模式匹配的请求才会从 HAR 文件提供服务。如果未指定，所有请求都将从 HAR 文件提供服务。

返回值

void #

routeWebSocket

添加于：v1.48

browserContext.routeWebSocket

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

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

用法

下面是一个简单处理程序示例，它阻止某些 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、本地存储快照和 IndexedDB 快照。

用法

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

参数

options BrowserContext.StorageStateOptions （可选）
- setIndexedDB boolean （可选）新增于：v1.51#
  
  设置为 true 以在存储状态快照中包含 IndexedDB。如果你的应用使用 IndexedDB 存储认证令牌（如 Firebase Authentication），请启用此项。
- 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 调用某个 console 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 时触发此事件。页面可能仍在加载中。此事件也会为弹出页面触发。另请参阅 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)