浏览器上下文
- 扩展:[EventEmitter]
浏览器上下文提供了一种操作多个独立浏览器会话的方法。
如果一个页面打开了另一个页面,例如使用 window.open
调用,则弹出窗口将属于父页面的浏览器上下文。
Playwright 允许使用 Browser.NewContextAsync() 方法创建“隐身”浏览器上下文。“隐身”浏览器上下文不会将任何浏览数据写入磁盘。
using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Firefox.LaunchAsync(new() { Headless = false });
// Create a new incognito browser context
var context = await browser.NewContextAsync();
// Create a new page inside context.
var page = await context.NewPageAsync();
await page.GotoAsync("https://bing.com");
// Dispose context once it is no longer needed.
await context.CloseAsync();
方法
AddCookiesAsync
添加于:v1.8将 Cookie 添加到此浏览器上下文。此上下文中的所有页面都将安装这些 Cookie。可以通过 BrowserContext.CookiesAsync() 获取 Cookie。
用法
await context.AddCookiesAsync(new[] { cookie1, cookie2 });
参数
-
cookies
IEnumerable<Cookie
>#-
Name
string -
Value
string -
Url
string? (可选)需要 url 或域/路径。可选。
-
Domain
string? (可选)需要 url 或域/路径。可选。
-
Path
string? (可选)需要 url 或域/路径。可选。
-
Expires
[float]? (可选)Unix 时间戳(以秒为单位)。可选。
-
HttpOnly
bool? (可选)可选。
-
Secure
bool? (可选)可选。
-
SameSite
enum SameSiteAttribute { Strict, Lax, None }?
(可选)可选。
将 Cookie 添加到浏览器上下文。
要使 Cookie 也适用于所有子域,请在域名前添加一个点,如下所示:“.example.com”。
-
返回
AddInitScriptAsync
添加于:v1.8添加将在以下情况下之一执行的脚本
- 每当在浏览器上下文中创建或导航到页面时。
- 每当在浏览器上下文的任何页面中附加或导航到子框架时。在这种情况下,脚本将在新附加的框架的上下文中执行。
在创建文档之后但在运行其任何脚本之前执行脚本。这对于修改 JavaScript 环境很有用,例如为 Math.random
播种。
用法
在页面加载之前覆盖 Math.random
的示例
// preload.js
Math.random = () => 42;
await Context.AddInitScriptAsync(scriptPath: "preload.js");
未定义通过 BrowserContext.AddInitScriptAsync() 和 Page.AddInitScriptAsync() 安装的多个脚本的执行顺序。
参数
返回
BackgroundPages
添加于:v1.11仅基于 Chromium 的浏览器支持后台页面。
上下文中所有现有的后台页面。
用法
BrowserContext.BackgroundPages
返回
Browser
添加于:v1.8返回上下文的浏览器实例。如果它作为持久上下文启动,则返回 null。
用法
BrowserContext.Browser
返回
ClearCookiesAsync
添加于:v1.8从上下文中删除 Cookie。接受可选过滤器。
用法
await context.ClearCookiesAsync();
await context.ClearCookiesAsync(new() { Name = "session-id" });
await context.ClearCookiesAsync(new() { Domain = "my-origin.com" });
await context.ClearCookiesAsync(new() { Path = "/api/v1" });
await context.ClearCookiesAsync(new() { Name = "session-id", Domain = "my-origin.com" });
参数
options
BrowserContextClearCookiesOptions?
(可选)
返回
ClearPermissionsAsync
添加于:v1.8清除浏览器上下文的所有权限覆盖。
用法
var context = await browser.NewContextAsync();
await context.GrantPermissionsAsync(new[] { "clipboard-read" });
// Alternatively, you can use the helper class ContextPermissions
// to specify the permissions...
// do stuff ...
await context.ClearPermissionsAsync();
返回
CloseAsync
添加于:v1.8关闭浏览器上下文。属于该浏览器上下文的所有页面都将关闭。
默认浏览器上下文无法关闭。
用法
await BrowserContext.CloseAsync(options);
参数
返回
CookiesAsync
添加于:v1.8如果未指定 URL,则此方法将返回所有 Cookie。如果指定了 URL,则仅返回影响这些 URL 的 Cookie。
用法
await BrowserContext.CookiesAsync(urls);
参数
-
urls
string? | IEnumerable?<string> (可选)#可选的 URL 列表。
返回
- IEnumerable<
Cookie
>#
ExposeBindingAsync
添加于:v1.8该方法在上下文中每个页面中每个框架的 window
对象上添加一个名为 name
的函数。调用时,该函数将执行 callback
并返回一个 Promise,该 Promise 将解析为 callback
的返回值。如果 callback
返回一个 Promise,则将等待它。
callback
函数的第一个参数包含有关调用方的信息:{ browserContext: BrowserContext, page: Page, frame: Frame }
。
有关仅限页面的版本,请参阅 Page.ExposeBindingAsync()。
用法
将页面 URL 公开给上下文中所有页面中所有框架的示例
using Microsoft.Playwright;
using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Webkit.LaunchAsync(new() { Headless = false });
var context = await browser.NewContextAsync();
await context.ExposeBindingAsync("pageURL", source => source.Page.Url);
var page = await context.NewPageAsync();
await page.SetContentAsync("<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>");
await page.GetByRole(AriaRole.Button).ClickAsync();
参数
-
窗口对象上函数的名称。
-
callback
Action<BindingSource, T, [TResult]>#将在 Playwright 上下文中调用的回调函数。
-
options
BrowserContextExposeBindingOptions?
(可选)
返回
ExposeFunctionAsync
添加于:v1.8该方法在上下文中每个页面的每个框架的 window
对象上添加一个名为 name
的函数。调用时,该函数将执行 callback
并返回一个 Promise,该 Promise 将解析为 callback
的返回值。
如果 callback
返回一个 Promise,它将被等待。
有关仅限页面的版本,请参阅 Page.ExposeFunctionAsync()。
用法
将 sha256
函数添加到上下文中所有页面的示例
using Microsoft.Playwright;
using System;
using System.Security.Cryptography;
using System.Threading.Tasks;
class BrowserContextExamples
{
public static async Task Main()
{
using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Webkit.LaunchAsync(new() { Headless = false });
var context = await browser.NewContextAsync();
await context.ExposeFunctionAsync("sha256", (string input) =>
{
return Convert.ToBase64String(
SHA256.Create().ComputeHash(System.Text.Encoding.UTF8.GetBytes(input)));
});
var page = await context.NewPageAsync();
await page.SetContentAsync("<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>");
await page.GetByRole(AriaRole.Button).ClickAsync();
Console.WriteLine(await page.TextContentAsync("div"));
}
}
参数
返回
GrantPermissionsAsync
添加于:v1.8向浏览器上下文授予指定的权限。如果指定,则仅向给定来源授予相应的权限。
用法
await BrowserContext.GrantPermissionsAsync(permissions, options);
参数
-
permissions
IEnumerable<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
BrowserContextGrantPermissionsOptions?
(可选)-
要向其授予权限的 来源,例如“https://example.com”。
-
返回
NewCDPSessionAsync
添加于:v1.11仅基于 Chromium 的浏览器支持 CDP 会话。
返回新创建的会话。
用法
await BrowserContext.NewCDPSessionAsync(page);
参数
返回
NewPageAsync
添加于:v1.8在浏览器上下文中创建一个新页面。
用法
await BrowserContext.NewPageAsync();
返回
Pages
添加于:v1.8返回上下文中所有打开的页面。
用法
BrowserContext.Pages
返回
RouteAsync
添加于:v1.8路由提供了修改浏览器上下文中任何页面发出的网络请求的功能。启用路由后,与 url 模式匹配的每个请求都将暂停,除非它被继续、完成或中止。
BrowserContext.RouteAsync() 不会拦截 Service Worker 拦截的请求。请参阅 此 问题。我们建议在使用请求拦截时通过将 Browser.newContext.serviceWorkers
设置为 'block'
来禁用 Service Worker。
用法
中止所有图像请求的简单处理程序示例
var context = await browser.NewContextAsync();
var page = await context.NewPageAsync();
await context.RouteAsync("**/*.{png,jpg,jpeg}", r => r.AbortAsync());
await page.GotoAsync("https://theverge.com");
await browser.CloseAsync();
或使用正则表达式模式的相同代码段
var context = await browser.NewContextAsync();
var page = await context.NewPageAsync();
await context.RouteAsync(new Regex("(\\.png$)|(\\.jpg$)"), r => r.AbortAsync());
await page.GotoAsync("https://theverge.com");
await browser.CloseAsync();
可以检查请求以决定路由操作。例如,模拟包含某些 POST 数据的所有请求,并保留所有其他请求
await page.RouteAsync("/api/**", async r =>
{
if (r.Request.PostData.Contains("my-string"))
await r.FulfillAsync(new() { Body = "mocked-data" });
else
await r.ContinueAsync();
});
当请求同时匹配两个处理程序时,页面路由(使用 Page.RouteAsync() 设置)优先于浏览器上下文路由。
要删除路由及其处理程序,可以使用 BrowserContext.UnrouteAsync()。
启用路由将禁用 http 缓存。
参数
-
url
string | Regex | Func<string, bool>#在路由时接收 URL 以进行匹配的 glob 模式、正则表达式模式或谓词。当通过上下文选项提供
baseURL
并且传递的 URL 是路径时,它将通过new URL()
构造函数进行合并。 -
用于路由请求的处理程序函数。
-
options
BrowserContextRouteOptions?
(可选)
返回
RouteFromHARAsync
添加于:v1.23如果指定,则将在上下文中发出的网络请求将从 HAR 文件提供。阅读有关 从 HAR 重放 的更多信息。
Playwright 不会从 HAR 文件提供 Service Worker 拦截的请求。请参阅 此 问题。我们建议在使用请求拦截时通过将 Browser.newContext.serviceWorkers
设置为 'block'
来禁用 Service Worker。
用法
await BrowserContext.RouteFromHARAsync(har, options);
参数
-
包含预先录制的网络数据的 HAR 文件的路径。如果
path
是相对路径,则它将解析为相对于当前工作目录的路径。 -
options
BrowserContextRouteFromHAROptions?
(可选)-
NotFound
enum HarNotFound { Abort, Fallback }?
(可选)#- 如果设置为“abort”,则 HAR 文件中找不到的任何请求都将被中止。
- 如果设置为“fallback”,则回退到处理程序链中的下一个路由处理程序。
默认为中止。
-
如果指定,则使用实际网络信息更新给定的 HAR,而不是从文件提供。调用 BrowserContext.CloseAsync() 时,该文件将写入磁盘。
-
UpdateContent
enum RouteFromHarUpdateContentPolicy { Embed, Attach }?
(可选)添加于:v1.32#用于控制资源内容管理的可选设置。如果指定了
attach
,则资源将作为单独的文件或 ZIP 存档中的条目持久化。如果指定了embed
,则内容将存储在 HAR 文件中。 -
UpdateMode
enum HarMode { Full, Minimal }?
(可选)添加于:v1.32#设置为
minimal
时,仅记录从 HAR 路由所需的信息。这将省略大小、时间、页面、cookie、安全性和其他类型的 HAR 信息,这些信息在从 HAR 重放时不会使用。默认为minimal
。 -
Url|UrlRegex
string? | Regex? (可选)#用于匹配请求 URL 的 glob 模式、正则表达式或谓词。 只有 URL 与模式匹配的请求才会由 HAR 文件提供服务。 如果未指定,则所有请求都由 HAR 文件提供服务。
-
返回
RunAndWaitForConsoleMessageAsync
添加于:v1.34执行操作并等待上下文中的页面记录 ConsoleMessage。 如果提供了谓词,它会将 ConsoleMessage 值传递到 predicate
函数,并等待 predicate(message)
返回真值。 如果在触发 BrowserContext.Console 事件之前关闭页面,则会引发错误。
用法
await BrowserContext.RunAndWaitForConsoleMessageAsync(action, options);
参数
-
触发事件的操作。
-
options
BrowserContextRunAndWaitForConsoleMessageOptions?
(可选)-
Predicate
Func<ConsoleMessage?, bool> (可选)#接收 ConsoleMessage 对象,并在等待应解析时解析为真值。
-
Timeout
[float]? (可选)#要等待的最长时间(以毫秒为单位)。 默认为
30000
(30 秒)。 传递0
可禁用超时。 默认值可以使用 BrowserContext.SetDefaultTimeout() 进行更改。
-
返回
WaitForConsoleMessageAsync
添加于:v1.34执行操作并等待上下文中的页面记录 ConsoleMessage。 如果提供了谓词,它会将 ConsoleMessage 值传递到 predicate
函数,并等待 predicate(message)
返回真值。 如果在触发 BrowserContext.Console 事件之前关闭页面,则会引发错误。
用法
await BrowserContext.WaitForConsoleMessageAsync(action, options);
参数
options
BrowserContextRunAndWaitForConsoleMessageOptions?
(可选)-
Predicate
Func<ConsoleMessage?, bool> (可选)#接收 ConsoleMessage 对象,并在等待应解析时解析为真值。
-
Timeout
[float]? (可选)#要等待的最长时间(以毫秒为单位)。 默认为
30000
(30 秒)。 传递0
可禁用超时。 默认值可以使用 BrowserContext.SetDefaultTimeout() 进行更改。
-
返回
RunAndWaitForPageAsync
添加于:v1.9执行操作并等待在上下文中创建新的 Page。 如果提供了谓词,它会将 Page 值传递到 predicate
函数,并等待 predicate(event)
返回真值。 如果在创建新的 Page 之前关闭上下文,则会引发错误。
用法
await BrowserContext.RunAndWaitForPageAsync(action, options);
参数
-
触发事件的操作。
-
options
BrowserContextRunAndWaitForPageOptions?
(可选)
返回
WaitForPageAsync
添加于:v1.9执行操作并等待在上下文中创建新的 Page。 如果提供了谓词,它会将 Page 值传递到 predicate
函数,并等待 predicate(event)
返回真值。 如果在创建新的 Page 之前关闭上下文,则会引发错误。
用法
await BrowserContext.WaitForPageAsync(action, options);
参数
options
BrowserContextRunAndWaitForPageOptions?
(可选)
返回
SetDefaultNavigationTimeout
添加于:v1.8此设置将更改以下方法和相关快捷方式的默认最大导航时间
- Page.GoBackAsync()
- Page.GoForwardAsync()
- Page.GotoAsync()
- Page.ReloadAsync()
- Page.SetContentAsync()
- Page.RunAndWaitForNavigationAsync()
用法
BrowserContext.SetDefaultNavigationTimeout(timeout);
参数
-
timeout
[float]#最大导航时间(以毫秒为单位)
SetDefaultTimeout
添加于:v1.8此设置将更改所有接受 timeout
选项的方法的默认最大时间。
用法
BrowserContext.SetDefaultTimeout(timeout);
参数
-
timeout
[float]#最大时间(以毫秒为单位)
SetExtraHTTPHeadersAsync
添加于:v1.8额外的 HTTP 标头将随上下文中的任何页面发起的每个请求一起发送。 这些标头与使用 Page.SetExtraHTTPHeadersAsync() 设置的特定于页面的额外 HTTP 标头合并。 如果页面覆盖了特定标头,则将使用特定于页面的标头值,而不是浏览器上下文标头值。
BrowserContext.SetExtraHTTPHeadersAsync() 不保证传出请求中标头的顺序。
用法
await BrowserContext.SetExtraHTTPHeadersAsync(headers);
参数
-
headers
IDictionary<string, string>#一个对象,其中包含要随每个请求一起发送的附加 HTTP 标头。 所有标头值都必须是字符串。
返回
SetGeolocationAsync
添加于:v1.8设置上下文的地理位置。 传递 null
或 undefined
会模拟位置不可用。
用法
await context.SetGeolocationAsync(new Geolocation()
{
Latitude = 59.95f,
Longitude = 30.31667f
});
请考虑使用 BrowserContext.GrantPermissionsAsync() 授予浏览器上下文页面读取其地理位置的权限。
参数
geolocation
Geolocation?#-
Latitude
[float]纬度,介于 -90 到 90 之间。
-
Longitude
[float]经度,介于 -180 到 180 之间。
-
Accuracy
[float]? (可选)非负精度值。 默认为
0
。
-
返回
SetOfflineAsync
添加于:v1.8用法
await BrowserContext.SetOfflineAsync(offline);
参数
返回
StorageStateAsync
添加于:v1.8返回此浏览器上下文的存储状态,其中包含当前 Cookie 和本地存储快照。
用法
await BrowserContext.StorageStateAsync(options);
参数
options
BrowserContextStorageStateOptions?
(可选)
返回
UnrouteAsync
添加于:v1.8删除使用 BrowserContext.RouteAsync() 创建的路由。 如果未指定 handler
,则删除 url
的所有路由。
用法
await BrowserContext.UnrouteAsync(url, handler);
参数
-
url
string | Regex | Func<string, bool>#用于使用 BrowserContext.RouteAsync() 注册路由的 glob 模式、正则表达式模式或接收 URL 的谓词。
-
用于使用 BrowserContext.RouteAsync() 注册路由的可选处理函数。
返回
UnrouteAllAsync
添加于:v1.41移除所有使用 BrowserContext.RouteAsync() 和 BrowserContext.RouteFromHARAsync() 创建的路由。
用法
await BrowserContext.UnrouteAllAsync(options);
参数
options
BrowserContextUnrouteAllOptions?
(可选)-
Behavior
enum UnrouteBehavior { Wait, IgnoreErrors, Default }?
(可选)#指定是否等待已在运行的处理程序,以及如果它们抛出错误该怎么办
'default'
- 不等待当前处理程序调用(如果有)完成,如果未路由的处理程序抛出错误,则可能导致未处理的错误'wait'
- 等待当前处理程序调用(如果有)完成'ignoreErrors'
- 不等待当前处理程序调用(如果有)完成,取消路由后处理程序抛出的所有错误都将被静默捕获
-
返回
属性
APIRequest
添加于:v1.16与此上下文关联的 API 测试助手。使用此 API 发出的请求将使用上下文 Cookie。
用法
BrowserContext.APIRequest
类型
Clock
添加于:v1.45Playwright 能够模拟时钟和时间流逝。
用法
BrowserContext.Clock
类型
Tracing
添加于:v1.12用法
BrowserContext.Tracing
类型
事件
事件 BackgroundPage
添加于:v1.11仅适用于 Chromium 浏览器的持久上下文。
在上下文中创建新的后台页面时发出。
context.BackgroundPage += (_, backgroundPage) =>
{
Console.WriteLine(backgroundPage.Url);
};
用法
BrowserContext.BackgroundPage += async (_, page) => {};
事件数据
事件 Close
添加于:v1.8在浏览器上下文关闭时发出。这可能是由于以下原因之一造成的
- 浏览器上下文已关闭。
- 浏览器应用程序已关闭或崩溃。
- 已调用 Browser.CloseAsync() 方法。
用法
BrowserContext.Close += async (_, browserContext) => {};
事件数据
事件 Console
添加于:v1.34当页面中的 JavaScript 调用某个控制台 API 方法时发出,例如 console.log
或 console.dir
。
传递给 console.log
的参数和页面可在 ConsoleMessage 事件处理程序参数中获得。
用法
context.Console += async (_, msg) =>
{
foreach (var arg in msg.Args)
Console.WriteLine(await arg.JsonValueAsync<object>());
};
await page.EvaluateAsync("console.log('hello', 5, { foo: 'bar' })");
事件数据
事件 Dialog
添加于:v1.34当出现 JavaScript 对话框时发出,例如 alert
、prompt
、confirm
或 beforeunload
。侦听器必须 Dialog.AcceptAsync() 或 Dialog.DismissAsync() 对话框 - 否则页面将 冻结 等待对话框,并且单击等操作将永远不会完成。
用法
Context.Dialog += async (_, dialog) =>
{
await dialog.AcceptAsync();
};
当不存在 Page.Dialog 或 BrowserContext.Dialog 侦听器时,所有对话框都会自动关闭。
事件数据
事件 Page
添加于:v1.8在 BrowserContext 中创建新页面时发出此事件。该页面可能仍在加载中。弹出页面也会触发此事件。另请参阅 Page.Popup,以接收与特定页面相关的弹出窗口事件。
页面可用的最早时间点是它导航到初始 URL 时。例如,使用 window.open('http://example.com')
打开弹出窗口时,当到“http://example.com”的网络请求完成并且其响应已开始在弹出窗口中加载时,将触发此事件。如果您想路由/侦听此网络请求,请分别使用 BrowserContext.RouteAsync() 和 BrowserContext.Request,而不是 Page 上的类似方法。
var popup = await context.RunAndWaitForPageAsync(async =>
{
await page.GetByText("open new page").ClickAsync();
});
Console.WriteLine(await popup.EvaluateAsync<string>("location.href"));
使用 Page.WaitForLoadStateAsync() 等待页面进入特定状态(在大多数情况下,您不需要这样做)。
用法
BrowserContext.Page += async (_, page) => {};
事件数据
事件 Request
添加于:v1.12从通过此上下文创建的任何页面发出请求时发出。 request 对象是只读的。要仅侦听来自特定页面的请求,请使用 Page.Request。
要拦截和改变请求,请参阅 BrowserContext.RouteAsync() 或 Page.RouteAsync()。
用法
BrowserContext.Request += async (_, request) => {};
事件数据
事件 RequestFailed
添加于:v1.12当请求失败时发出,例如超时。要仅侦听来自特定页面的失败请求,请使用 Page.RequestFailed。
HTTP 错误响应(例如 404 或 503)从 HTTP 的角度来看仍然是成功的响应,因此请求将使用 BrowserContext.RequestFinished 事件完成,而不是使用 BrowserContext.RequestFailed 完成。
用法
BrowserContext.RequestFailed += async (_, request) => {};
事件数据
事件 RequestFinished
添加于:v1.12在下载响应正文后请求成功完成时发出。对于成功的响应,事件顺序为 request
、response
和 requestfinished
。要侦听来自特定页面的成功请求,请使用 Page.RequestFinished。
用法
BrowserContext.RequestFinished += async (_, request) => {};
事件数据
事件 Response
添加于:v1.12当收到请求的 response 状态和标头时发出。对于成功的响应,事件顺序为 request
、response
和 requestfinished
。要侦听来自特定页面的响应事件,请使用 Page.Response。
用法
BrowserContext.Response += async (_, response) => {};
事件数据
事件 WebError
添加于:v1.38在此上下文的任何页面中未处理异常时发出。要侦听来自特定页面的错误,请改用 Page.PageError。
用法
BrowserContext.WebError += async (_, webError) => {};
事件数据