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#

详情

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

• 当请求源自服务工作线程时。您可以使用 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

请求的正文（如果有）。

用法

Request.postData();

返回值

• null | String#

---

postDataBuffer

在 v1.9 之前添加 request.postDataBuffer

请求的二进制形式的正文（如果有）。

用法

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

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

用法

Request.resourceType();

返回值

• 字符串#

---

响应

在 v1.9 之前添加 request.response

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

用法

Request.response();

返回值

• null | Response#

---

大小

新增于：v1.15 request.sizes

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

用法

Request.sizes();

返回值

• 大小#

  • requestBodySize int

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

  • requestHeadersSize int

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

  • responseBodySize int

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

  • responseHeadersSize int

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

---

时间

在 v1.9 之前添加 request.timing

返回给定请求的资源时间信息。大多数时间值在响应时可用，responseEnd 在请求完成时可用。在 Resource Timing API 中查找更多信息。

用法

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

返回值

• 时间#

  • 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();

返回值

• 字符串#