Request

每当页面发送网络资源请求时，页面都会发出以下事件序列：

• page.on('request')：当页面发出请求时触发。
• page.on('response')：当请求的响应状态和标头被接收时触发。
• page.on('requestfinished')：当响应正文下载完成且请求完成时触发。

如果请求在某个时刻失败，则会触发page.on('requestfailed')事件，而不是'requestfinished'事件（可能也代替'response'事件）。

注意

HTTP 错误响应，例如 404 或 503，从 HTTP 角度来看仍然是成功响应，因此请求将以'requestfinished'事件完成。

如果请求收到“重定向”响应，则该请求将成功地以requestfinished事件完成，并且会向重定向的 URL 发出新请求。

---

方法

allHeaders

新增于: v1.15 request.allHeaders

一个包含与此请求关联的所有请求 HTTP 标头的对象。标头名称是小写。

用法

await request.allHeaders();

返回

• Promise<Object<string, string>>#

---

failure

v1.9 之前添加 request.failure

此方法返回null，除非此请求已失败，如requestfailed事件报告的那样。

用法

记录所有失败请求的示例

page.on('requestfailed', request => {
  console.log(request.url() + ' ' + request.failure().errorText);
});

返回

• null | Object#

  • errorText string

    人类可读的错误消息，例如'net::ERR_FAILED'。

---

frame

v1.9 之前添加 request.frame

返回发起此请求的Frame。

用法

const frameUrl = request.frame().url();

返回

• Frame#

详情

请注意，在某些情况下，frame 不可用，此方法将抛出错误。

• 当请求源自 Service Worker 时。您可以使用request.serviceWorker()进行检查。
• 当导航请求在相应的 frame 创建之前发出时。您可以使用request.isNavigationRequest()进行检查。

这是一个处理所有情况的示例

if (request.serviceWorker())
  console.log(`request ${request.url()} from a service worker`);
else if (request.isNavigationRequest())
  console.log(`request ${request.url()} is a navigation request`);
else
  console.log(`request ${request.url()} from a frame ${request.frame().url()}`);

---

headerValue

新增于: v1.15 request.headerValue

返回与名称匹配的标头的值。名称不区分大小写。

用法

await request.headerValue(name);

参数

• name string#

  头名称。

返回

• Promise<null | string>#

---

headers

v1.9 之前添加 request.headers

一个包含请求 HTTP 标头的对象。标头名称是小写。请注意，此方法不返回与安全相关的标头，包括与 cookie 相关的标头。您可以使用request.allHeaders()获取包含cookie信息的完整标头列表。

用法

request.headers();

返回

• Object<string, string>#

---

headersArray

新增于: v1.15 request.headersArray

一个包含与此请求关联的所有请求 HTTP 标头的数组。与request.allHeaders()不同，标头名称不转换为小写。具有多个条目的标头，例如Set-Cookie，在数组中多次出现。

用法

await request.headersArray();

返回

• Promise<Array<Object>>#

  • name string

    头名称。

  • value string

    头值。

---

isNavigationRequest

v1.9 之前添加 request.isNavigationRequest

此请求是否正在驱动 frame 的导航。

某些导航请求在相应的 frame 创建之前发出，因此request.frame()不可用。

用法

request.isNavigationRequest();

返回

• boolean#

---

method

v1.9 之前添加 request.method

请求方法（GET、POST 等）

用法

request.method();

返回

• string#

---

postData

v1.9 之前添加 request.postData

请求的 POST 正文，如果有的话。

用法

request.postData();

返回

• null | string#

---

postDataBuffer

v1.9 之前添加 request.postDataBuffer

请求的 POST 正文的二进制形式，如果有的话。

用法

request.postDataBuffer();

返回

• null | Buffer#

---

postDataJSON

v1.9 之前添加 request.postDataJSON

返回解析后的请求正文，对于form-urlencoded和 JSON（作为备用）而言，如果有的话。

当响应是application/x-www-form-urlencoded时，将返回一个键/值对象。否则，它将被解析为 JSON。

用法

request.postDataJSON();

返回

• null | Serializable#

---

redirectedFrom

v1.9 之前添加 request.redirectedFrom

被服务器重定向到此请求的请求，如果有的话。

当服务器响应重定向时，Playwright 会创建一个新的Request对象。这两个请求通过redirectedFrom()和redirectedTo()方法连接。当发生多次服务器重定向时，可以通过重复调用redirectedFrom()来构建完整的重定向链。

用法

例如，如果网站http://example.com重定向到https://example.com

const response = await page.goto('http://example.com');
console.log(response.request().redirectedFrom().url()); // 'http://example.com'

如果网站https://google.com没有重定向

const response = await page.goto('https://google.com');
console.log(response.request().redirectedFrom()); // null

返回

• null | Request#

---

redirectedTo

v1.9 之前添加 request.redirectedTo

如果服务器响应重定向，浏览器发出的新请求。

用法

此方法与request.redirectedFrom()相反

console.log(request.redirectedFrom().redirectedTo() === request); // true

返回

• null | Request#

---

resourceType

v1.9 之前添加 request.resourceType

包含渲染引擎所感知的请求资源类型。ResourceType 将是以下之一：document、stylesheet、image、media、font、script、texttrack、xhr、fetch、eventsource、websocket、manifest、other。

用法

request.resourceType();

返回

• string#

---

response

v1.9 之前添加 request.response

返回匹配的Response对象，如果由于错误未收到响应，则返回null。

用法

await request.response();

返回

• Promise<null | Response>#

---

serviceWorker

添加于：v1.24 request.serviceWorker

执行请求的 Service Worker。

用法

request.serviceWorker();

返回

• null | Worker#

详情

此方法仅适用于 Chromium。在使用其他浏览器时调用是安全的，但它将始终为null。

源自 Service Worker 的请求没有可用的request.frame()。

---

sizes

新增于: v1.15 request.sizes

返回给定请求的资源大小信息。

用法

await request.sizes();

返回

• Promise<Object>#

  • requestBodySize number

    请求正文（POST 数据有效负载）的大小，以字节为单位。如果没有正文，则设置为 0。

  • requestHeadersSize number

    从 HTTP 请求消息开始到（包括）正文前的双 CRLF 的总字节数。

  • responseBodySize number

    接收到的响应正文（编码后）的大小，以字节为单位。

  • responseHeadersSize number

    从 HTTP 响应消息开始到（包括）正文前的双 CRLF 的总字节数。

---

timing

v1.9 之前添加 request.timing

返回给定请求的资源计时信息。大多数计时值在响应时可用，responseEnd在请求完成时可用。更多信息请参见资源计时 API。

用法

const requestFinishedPromise = page.waitForEvent('requestfinished');
await page.goto('http://example.com');
const request = await requestFinishedPromise;
console.log(request.timing());

返回

• Object#

  • startTime number

    请求开始时间，自 1970 年 1 月 1 日 00:00:00 UTC 以来的毫秒数

  • domainLookupStart number

    浏览器开始查找资源域名之前的时间。该值以相对于startTime的毫秒数给出，如果不可用则为 -1。

  • domainLookupEnd number

    浏览器开始查找资源域名之后的时间。该值以相对于startTime的毫秒数给出，如果不可用则为 -1。

  • connectStart number

    用户代理开始建立与服务器的连接以检索资源之前的时间。该值以相对于startTime的毫秒数给出，如果不可用则为 -1。

  • secureConnectionStart number

    浏览器开始握手过程以保护当前连接之前的时间。该值以相对于startTime的毫秒数给出，如果不可用则为 -1。

  • connectEnd number

    用户代理开始建立与服务器的连接以检索资源之前的时间。该值以相对于startTime的毫秒数给出，如果不可用则为 -1。

  • requestStart number

    浏览器开始从服务器、缓存或本地资源请求资源之前的时间。该值以相对于startTime的毫秒数给出，如果不可用则为 -1。

  • responseStart number

    浏览器从服务器、缓存或本地资源收到响应的第一个字节之后的时间。该值以相对于startTime的毫秒数给出，如果不可用则为 -1。

  • responseEnd number

    浏览器收到资源的最后一个字节之后的时间，或者传输连接关闭之前的时间，以先发生者为准。该值以相对于startTime的毫秒数给出，如果不可用则为 -1。

---

url

v1.9 之前添加 request.url

请求的 URL。

用法

request.url();

返回

• string#