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。 Cookie 可以通过BrowserContext.cookies()获得。

用法

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

参数

cookies List<Cookie>#
- setName String
- setValue String
- setUrl String (可选)
  
  url 或域/路径至少需要其中一个。可选。
- setDomain String (可选)
  
  要使 cookie 也适用于所有子域，请在域名前缀加一个点，例如：".example.com"。 url 或域/路径至少需要其中一个。可选。
- setPath String (可选)
  
  url 或域/路径至少需要其中一个可选。
- 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，则会等待该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，则会等待该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));
      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'
- 'accessibility-events'
- '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()不会拦截服务工作者拦截的请求。请参阅此问题。我们建议通过将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();

或使用正则表达式模式而不是 glob 模式相同的代码段

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

可以检查请求以确定路由操作。例如，模拟包含一些发布数据的请求，并将所有其他请求保留原样

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 文件提供服务工作者拦截的请求。请参阅此问题。我们建议通过将setServiceWorkers设置为'block'来禁用服务工作者，然后再使用请求拦截。

用法

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

参数

har Path #

具有预先录制网络数据的HAR文件的路径。如果path是相对路径，则它相对于当前工作目录解析。
options BrowserContext.RouteFromHAROptions (可选)
- setNotFound enum HarNotFound { ABORT, FALLBACK } (可选)#
  - 如果设置为“abort”，则 HAR 文件中找不到的任何请求都将被中止。
  - 如果设置为“fallback”，则会继续执行处理程序链中的下一个路由处理程序。
  默认值为中止。
- 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 (可选)#
  
  一个 glob 模式、正则表达式或谓词，用于匹配请求 URL。只有 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 的 WebSockets 才会被路由。字符串模式可以相对于 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 #

以毫秒为单位的最大时间

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

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

用法

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>#

一个 glob 模式、正则表达式模式或接收使用 BrowserContext.route() 注册路由的 [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。如果提供了谓词，它会将 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。如果提供了谓词，它会将 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 发出的请求将使用上下文 cookie。

用法

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)