Request

每当页面发送网络资源请求时，Page 会按以下顺序发出一系列事件：

• Page.onRequest(handler)：当页面发出请求时发出。
• Page.onResponse(handler)：当请求接收到响应状态和标头时发出。
• Page.onRequestFinished(handler)：当响应体下载完成且请求结束时发出。

如果请求在某个时刻失败，则会发出 Page.onRequestFailed(handler) 事件，而不是 'requestfinished' 事件（可能也不会发出 'response' 事件）。

备注

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

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

---

方法

allHeaders

添加于：v1.15 request.allHeaders

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

用法

Request.allHeaders();

返回值

• Map<String, String>#

---

failure

在 v1.9 之前添加 request.failure

除非此请求失败（如 requestfailed 事件所报告），否则该方法返回 null。

用法

记录所有失败请求的示例：

page.onRequestFailed(request -> {
  System.out.println(request.url() + " " + request.failure());
});

返回值

• null | String#

---

frame

在 v1.9 之前添加 request.frame

返回发起此请求的 Frame（框架）。

用法

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

返回值

• Frame#

详细信息

请注意，在某些情况下框架不可用，此方法将抛出异常。

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

以下是处理所有情况的示例：

---

headerValue

添加于：v1.15 request.headerValue

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

用法

Request.headerValue(name);

参数

• name String# 标头的名称。

返回值

• null | String#

---

headers

在 v1.9 之前添加 request.headers

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

用法

Request.headers();

返回值

• Map<String, String>#

---

headersArray

添加于：v1.15 request.headersArray

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

用法

Request.headersArray();

返回值

• List<HttpHeader>#

  • name String

    标头名称。

  • value String

    标头值。

---

isNavigationRequest

在 v1.9 之前添加 request.isNavigationRequest

此请求是否驱动框架的导航。

一些导航请求在相应的框架创建之前发出，因此没有可用的 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 | [byte[]]#

---

redirectedFrom

在 v1.9 之前添加 request.redirectedFrom

如果存在，此请求是由服务器重定向到当前请求的请求。

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

用法

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

Response response = page.navigate("http://example.com");
System.out.println(response.request().redirectedFrom().url()); // "http://example.com"

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

Response response = page.navigate("https://google.com");
System.out.println(response.request().redirectedFrom()); // null

返回值

• null | Request#

---

redirectedTo

在 v1.9 之前添加 request.redirectedTo

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

用法

此方法与 Request.redirectedFrom() 相反：

System.out.println(request.redirectedFrom().redirectedTo() == request); // true

返回值

• null | Request#

---

resourceType

在 v1.9 之前添加 request.resourceType

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

用法

Request.resourceType();

返回值

• String#

---

response

在 v1.9 之前添加 request.response

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

用法

Request.response();

返回值

• null | Response#

---

sizes

添加于：v1.15 request.sizes

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

用法

Request.sizes();

返回值

• Sizes#

  • requestBodySize int

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

  • requestHeadersSize int

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

  • responseBodySize int

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

  • responseHeadersSize int

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

---

timing

在 v1.9 之前添加 request.timing

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

用法

page.onRequestFinished(request -> {
  Timing timing = request.timing();
  System.out.println(timing.responseEnd - timing.startTime);
});
page.navigate("http://example.com");

返回值

• Timing#

  • startTime double

    自 1970 年 1 月 1 日 00:00:00 UTC 起经过的毫秒数表示的请求开始时间

  • domainLookupStart double

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

  • domainLookupEnd double

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

  • connectStart double

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

  • secureConnectionStart double

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

  • connectEnd double

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

  • requestStart double

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

  • responseStart double

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

  • responseEnd double

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

---

url

在 v1.9 之前添加 request.url

请求的 URL。

用法

Request.url();

返回值

• String#