Request
Whenever the page sends a request for a network resource the following sequence of events are emitted by Page:
- Page.onRequest(handler) emitted when the request is issued by the page.
- Page.onResponse(handler) emitted when/if the response status and headers are received for the request.
- Page.onRequestFinished(handler) emitted when the response body is downloaded and the request is complete.
If request fails at some point, then instead of 'requestfinished'
event (and possibly instead of 'response' event), the Page.onRequestFailed(handler) event is emitted.
HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with 'requestfinished'
event.
If request gets a 'redirect' response, the request is successfully finished with the requestfinished
event, and a new request is issued to a redirected url.
方法 (Methods)
allHeaders
Added in: v1.15An object with all the request HTTP headers associated with this request. The header names are lower-cased.
使用方式
Request.allHeaders();
傳回值
failure
Added before v1.9The method returns null
unless this request has failed, as reported by requestfailed
event.
使用方式
Example of logging of all the failed requests:
page.onRequestFailed(request -> {
System.out.println(request.url() + " " + request.failure());
});
傳回值
frame
Added before v1.9Returns the Frame that initiated this request.
使用方式
String frameUrl = request.frame().url();
傳回值
Details
Note that in some cases the frame is not available, and this method will throw.
- When request originates in the Service Worker. You can use
request.serviceWorker()
to check that. - When navigation request is issued before the corresponding frame is created. You can use Request.isNavigationRequest() to check that.
Here is an example that handles all the cases:
headerValue
Added in: v1.15Returns the value of the header matching the name. The name is case-insensitive.
使用方式
Request.headerValue(name);
參數
傳回值
headers
Added before v1.9An object with the request HTTP headers. The header names are lower-cased. Note that this method does not return security-related headers, including cookie-related ones. You can use Request.allHeaders() for complete list of headers that include cookie
information.
使用方式
Request.headers();
傳回值
headersArray
Added in: v1.15An array with all the request HTTP headers associated with this request. Unlike Request.allHeaders(), header names are NOT lower-cased. Headers with multiple entries, such as Set-Cookie
, appear in the array multiple times.
使用方式
Request.headersArray();
傳回值
isNavigationRequest
Added before v1.9Whether this request is driving frame's navigation.
Some navigation requests are issued before the corresponding frame is created, and therefore do not have Request.frame() available.
使用方式
Request.isNavigationRequest();
傳回值
method
Added before v1.9Request's method (GET, POST, etc.)
使用方式
Request.method();
傳回值
postData
Added before v1.9Request's post body, if any.
使用方式
Request.postData();
傳回值
postDataBuffer
Added before v1.9Request's post body in a binary form, if any.
使用方式
Request.postDataBuffer();
傳回值
redirectedFrom
Added before v1.9Request that was redirected by the server to this one, if any.
When the server responds with a redirect, Playwright creates a new Request object. The two requests are connected by redirectedFrom()
and redirectedTo()
methods. When multiple server redirects has happened, it is possible to construct the whole redirect chain by repeatedly calling redirectedFrom()
.
使用方式
For example, if the website http://example.com
redirects to https://example.com
:
Response response = page.navigate("http://example.com");
System.out.println(response.request().redirectedFrom().url()); // "http://example.com"
If the website https://google.com
has no redirects:
Response response = page.navigate("https://google.com");
System.out.println(response.request().redirectedFrom()); // null
傳回值
redirectedTo
Added before v1.9New request issued by the browser if the server responded with redirect.
使用方式
This method is the opposite of Request.redirectedFrom():
System.out.println(request.redirectedFrom().redirectedTo() == request); // true
傳回值
resourceType
Added before v1.9Contains the request's resource type as it was perceived by the rendering engine. ResourceType will be one of the following: document
, stylesheet
, image
, media
, font
, script
, texttrack
, xhr
, fetch
, eventsource
, websocket
, manifest
, other
.
使用方式
Request.resourceType();
傳回值
response
Added before v1.9Returns the matching Response object, or null
if the response was not received due to error.
使用方式
Request.response();
傳回值
sizes
Added in: v1.15Returns resource size information for given request.
使用方式
Request.sizes();
傳回值
- Sizes#
-
requestBodySize
intSize of the request body (POST data payload) in bytes. Set to 0 if there was no body.
-
requestHeadersSize
intTotal number of bytes from the start of the HTTP request message until (and including) the double CRLF before the body.
-
responseBodySize
intSize of the received response body (encoded) in bytes.
-
responseHeadersSize
intTotal number of bytes from the start of the HTTP response message until (and including) the double CRLF before the body.
-
timing
Added before v1.9Returns resource timing information for given request. Most of the timing values become available upon the response, responseEnd
becomes available when request finishes. Find more information at Resource Timing API.
使用方式
page.onRequestFinished(request -> {
Timing timing = request.timing();
System.out.println(timing.responseEnd - timing.startTime);
});
page.navigate("http://example.com");
傳回值
- Timing#
-
startTime
doubleRequest start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
-
domainLookupStart
doubleTime immediately before the browser starts the domain name lookup for the resource. The value is given in milliseconds relative to
startTime
, -1 if not available. -
domainLookupEnd
doubleTime immediately after the browser starts the domain name lookup for the resource. The value is given in milliseconds relative to
startTime
, -1 if not available. -
connectStart
doubleTime immediately before the user agent starts establishing the connection to the server to retrieve the resource. The value is given in milliseconds relative to
startTime
, -1 if not available. -
secureConnectionStart
doubleTime immediately before the browser starts the handshake process to secure the current connection. The value is given in milliseconds relative to
startTime
, -1 if not available. -
connectEnd
doubleTime immediately before the user agent starts establishing the connection to the server to retrieve the resource. The value is given in milliseconds relative to
startTime
, -1 if not available. -
requestStart
doubleTime immediately before the browser starts requesting the resource from the server, cache, or local resource. The value is given in milliseconds relative to
startTime
, -1 if not available. -
responseStart
doubleTime immediately after the browser receives the first byte of the response from the server, cache, or local resource. The value is given in milliseconds relative to
startTime
, -1 if not available. -
responseEnd
doubleTime immediately after the browser receives the last byte of the resource or immediately before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to
startTime
, -1 if not available.
-
url
Added before v1.9URL of the request.
使用方式
Request.url();
傳回值