跳转到主要内容

Route

每当使用 page.route()browserContext.route() 设置网络路由时,Route 对象允许处理该路由。

了解更多关于网络的信息。


方法

中止 (abort)

v1.9 之前添加 route.abort

中止路由请求。

用法

await route.abort();
await route.abort(errorCode);

参数

  • errorCode 字符串 (可选)#

    可选的错误代码。默认为 failed,可以是以下之一

    • 'aborted' - 操作被中止(由于用户操作)
    • 'accessdenied' - 访问除网络外的资源权限被拒绝
    • 'addressunreachable' - IP 地址无法访问。这通常意味着没有到指定主机或网络的路由。
    • 'blockedbyclient' - 客户端选择阻止请求。
    • 'blockedbyresponse' - 请求失败,因为响应与未满足的要求一起交付(例如,'X-Frame-Options' 和 'Content-Security-Policy' 祖先检查)。
    • 'connectionaborted' - 由于未收到已发送数据的 ACK,连接超时。
    • 'connectionclosed' - 连接已关闭(对应于 TCP FIN)。
    • 'connectionfailed' - 连接尝试失败。
    • 'connectionrefused' - 连接尝试被拒绝。
    • 'connectionreset' - 连接被重置(对应于 TCP RST)。
    • 'internetdisconnected' - 互联网连接已断开。
    • 'namenotresolved' - 主机名无法解析。
    • 'timedout' - 操作超时。
    • 'failed' - 发生一般性故障。

返回


继续 (continue)

v1.9 之前添加 route.continue

发送路由请求到网络,可选择覆盖。

用法

await page.route('**/*', async (route, request) => {
// Override headers
const headers = {
...request.headers(),
foo: 'foo-value', // set "foo" header
bar: undefined, // remove "bar" header
};
await route.continue({ headers });
});

参数

  • options Object (可选)
    • headers 对象<字符串, 字符串> (可选)#

      如果设置,则更改请求 HTTP 头。头值将转换为字符串。

    • method 字符串 (可选)#

      如果设置,则更改请求方法(例如 GET 或 POST)。

    • postData 字符串 | Buffer | 可序列化 (可选)#

      如果设置,则更改请求的 post 数据。

    • url 字符串 (可选)#

      如果设置,则更改请求 URL。新 URL 必须与原始 URL 具有相同的协议。

返回

详情

headers 选项适用于路由请求及其发起的任何重定向。但是,urlmethodpostData 仅适用于原始请求,不会传递给重定向请求。

route.continue() 将立即将请求发送到网络,其他匹配的处理程序不会被调用。如果您希望链中下一个匹配的处理程序被调用,请使用 route.fallback()

警告

不能使用此方法覆盖 Cookie 头。如果提供了值,它将被忽略,并且 cookie 将从浏览器的 cookie 存储中加载。要设置自定义 cookie,请使用 browserContext.addCookies()


回退 (fallback)

添加于:v1.23 route.fallback

继续路由请求,可选择覆盖。此方法与 route.continue() 类似,不同之处在于其他匹配的处理程序将在发送请求之前被调用。

用法

当多个路由匹配给定模式时,它们以与注册顺序相反的顺序运行。这样,最后注册的路由总是可以覆盖所有以前的路由。在下面的示例中,请求将首先由最底部的处理程序处理,然后回退到上一个处理程序,最后被第一个注册的路由中止。

await page.route('**/*', async route => {
// Runs last.
await route.abort();
});
await page.route('**/*', async route => {
// Runs second.
await route.fallback();
});
await page.route('**/*', async route => {
// Runs first.
await route.fallback();
});

注册多个路由很有用,当您希望不同的处理程序处理不同类型的请求时,例如 API 调用与页面资源,或 GET 请求与 POST 请求,如下面的示例所示。

// Handle GET requests.
await page.route('**/*', async route => {
if (route.request().method() !== 'GET') {
await route.fallback();
return;
}
// Handling GET only.
// ...
});

// Handle POST requests.
await page.route('**/*', async route => {
if (route.request().method() !== 'POST') {
await route.fallback();
return;
}
// Handling POST only.
// ...
});

还可以修改请求,同时回退到后续处理程序,这样中间路由处理程序可以修改请求的 url、方法、头和 postData。

await page.route('**/*', async (route, request) => {
// Override headers
const headers = {
...request.headers(),
foo: 'foo-value', // set "foo" header
bar: undefined, // remove "bar" header
};
await route.fallback({ headers });
});

使用 route.continue() 立即将请求发送到网络,在这种情况下其他匹配的处理程序将不会被调用。

参数

  • options Object (可选)
    • headers 对象<字符串, 字符串> (可选)#

      如果设置,则更改请求 HTTP 头。头值将转换为字符串。

    • method 字符串 (可选)#

      如果设置,则更改请求方法(例如 GET 或 POST)。

    • postData 字符串 | Buffer | 可序列化 (可选)#

      如果设置,则更改请求的 post 数据。

    • url 字符串 (可选)#

      如果设置,则更改请求 URL。新 URL 必须与原始 URL 具有相同的协议。更改 URL 不会影响路由匹配,所有路由都使用原始请求 URL 进行匹配。

返回


抓取 (fetch)

新增于: v1.29 route.fetch

执行请求并抓取结果而不满足它,以便可以修改响应然后满足它。

用法

await page.route('https://dog.ceo/api/breeds/list/all', async route => {
const response = await route.fetch();
const json = await response.json();
json.message['big_red_dog'] = [];
await route.fulfill({ response, json });
});

参数

  • options Object (可选)
    • headers 对象<字符串, 字符串> (可选)#

      如果设置,则更改请求 HTTP 头。头值将转换为字符串。

    • maxRedirects number (可选)新增于: v1.31#

      将自动遵循的最大请求重定向次数。如果超过此数字,将抛出错误。默认为 20。传递 0 表示不遵循重定向。

    • maxRetries 数字 (可选)新增于: v1.46#

      网络错误的最大重试次数。目前只重试 ECONNRESET 错误。不根据 HTTP 响应代码重试。如果超过限制,将抛出错误。默认为 0 - 不重试。

    • method 字符串 (可选)#

      如果设置,则更改请求方法(例如 GET 或 POST)。

    • postData 字符串 | Buffer | 可序列化 (可选)#

      允许设置请求的 post 数据。如果数据参数是一个对象,它将被序列化为 json 字符串,并且如果未明确设置,content-type 头将被设置为 application/json。否则,如果未明确设置,content-type 头将被设置为 application/octet-stream

    • timeout 数字 (可选)新增于:v1.33#

      请求超时时间(毫秒)。默认为 30000 (30 秒)。传递 0 表示禁用超时。

    • url 字符串 (可选)#

      如果设置,则更改请求 URL。新 URL 必须与原始 URL 具有相同的协议。

返回

详情

请注意,headers 选项将适用于抓取的请求以及它发起的任何重定向。如果您只想将 headers 应用于原始请求,而不应用于重定向,请改为查看 route.continue()


满足 (fulfill)

v1.9 之前添加 route.fulfill

使用给定响应满足路由请求。

用法

一个用 404 响应满足所有请求的示例

await page.route('**/*', async route => {
await route.fulfill({
status: 404,
contentType: 'text/plain',
body: 'Not Found!'
});
});

一个提供静态文件的示例

await page.route('**/xhr_endpoint', route => route.fulfill({ path: 'mock_data.json' }));

参数

  • options Object (可选)
    • body 字符串 | Buffer (可选)#

      响应体。

    • contentType 字符串 (可选)#

      如果设置,等同于设置 Content-Type 响应头。

    • headers 对象<字符串, 字符串> (可选)#

      响应头。头值将转换为字符串。

    • json 可序列化 (可选)新增于: v1.29#

      JSON 响应。如果未设置,此方法将设置内容类型为 application/json

    • path 字符串 (可选)#

      用于响应的文件路径。内容类型将从文件扩展名推断。如果 path 是相对路径,则它相对于当前工作目录解析。

    • response APIResponse (可选)新增于: v1.15#

      用于满足路由请求的 APIResponse。可以使用 fulfill 选项覆盖响应的各个字段(例如头)。

    • status 数字 (可选)#

      响应状态码,默认为 200

返回


请求 (request)

v1.9 之前添加 route.request

待路由的请求。

用法

route.request();

返回