Route

每当使用 Page.route() 或 BrowserContext.route() 设置网络路由时，Route 对象允许处理该路由。

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

方法

abort

在 v1.9 之前添加

route.abort

中止路由的请求。

用法

Route.abort();
Route.abort(errorCode);

参数

errorCode String (可选)#

可选的错误代码。默认为 failed，可以是以下之一
- 'aborted' - 操作已中止（由于用户操作）
- 'accessdenied' - 拒绝访问网络以外的资源
- 'addressunreachable' - IP 地址不可达。这通常意味着没有到达指定主机或网络的路由。
- 'blockedbyclient' - 客户端选择阻止请求。
- 'blockedbyresponse' - 请求失败，因为响应与未满足的要求一起传递（例如，“X-Frame-Options”和“Content-Security-Policy”祖先检查）。
- 'connectionaborted' - 由于未收到发送数据的 ACK，连接超时。
- 'connectionclosed' - 连接已关闭（对应于 TCP FIN）。
- 'connectionfailed' - 连接尝试失败。
- 'connectionrefused' - 连接尝试被拒绝。
- 'connectionreset' - 连接已重置（对应于 TCP RST）。
- 'internetdisconnected' - Internet 连接已断开。
- 'namenotresolved' - 无法解析主机名。
- 'timedout' - 操作超时。
- 'failed' - 发生一般性故障。

返回值

void #

fallback

添加于: v1.23

route.fallback

继续路由的请求，并带有可选的覆盖。此方法类似于 Route.resume()，区别在于在发送请求之前将调用其他匹配的处理程序。

用法

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

page.route("**/*", route -> {
  // Runs last.
  route.abort();
});

page.route("**/*", route -> {
  // Runs second.
  route.fallback();
});

page.route("**/*", route -> {
  // Runs first.
  route.fallback();
});

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

// Handle GET requests.
page.route("**/*", route -> {
  if (!route.request().method().equals("GET")) {
    route.fallback();
    return;
  }
  // Handling GET only.
  // ...
});

// Handle POST requests.
page.route("**/*", route -> {
  if (!route.request().method().equals("POST")) {
    route.fallback();
    return;
  }
  // Handling POST only.
  // ...
});

也可以在回退到后续处理程序时修改请求，这样中间路由处理程序可以修改请求的 url、method、headers 和 postData。

page.route("**/*", route -> {
  // Override headers
  Map<String, String> headers = new HashMap<>(route.request().headers());
  headers.put("foo", "foo-value"); // set "foo" header
  headers.remove("bar"); // remove "bar" header
  route.fallback(new Route.ResumeOptions().setHeaders(headers));
});

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

参数

options Route.FallbackOptions (可选)
- setHeaders Map<String, String> (可选)#
  
  如果设置，则更改请求 HTTP 标头。标头值将转换为字符串。
- setMethod String (可选)#
  
  如果设置，则更改请求方法（例如 GET 或 POST）。
- setPostData String | byte[] (可选)#
  
  如果设置，则更改请求的 post data。
- setUrl String (可选)#
  
  如果设置，则更改请求 URL。新 URL 必须与原始 URL 具有相同的协议。更改 URL 不会影响路由匹配，所有路由都使用原始请求 URL 进行匹配。

返回值

void #

fetch

添加于: v1.29

route.fetch

执行请求并获取结果，而无需 fulfill 它，以便可以修改响应然后再 fulfill 它。

用法

page.route("https://dog.ceo/api/breeds/list/all", route -> {
  APIResponse response = route.fetch();
  JsonObject json = new Gson().fromJson(response.text(), JsonObject.class);
  JsonObject message = itemObj.get("json").getAsJsonObject();
  message.set("big_red_dog", new JsonArray());
  route.fulfill(new Route.FulfillOptions()
    .setResponse(response)
    .setBody(json.toString()));
});

参数

options Route.FetchOptions (可选)
- setHeaders Map<String, String> (可选)#
  
  如果设置，则更改请求 HTTP 标头。标头值将转换为字符串。
- setMaxRedirects int (可选)添加于: v1.31#
  
  将自动跟踪的最大请求重定向数。如果超过此数目，将抛出错误。默认为 20。传递 0 以不跟踪重定向。
- setMaxRetries int (可选)添加于: v1.46#
  
  网络错误应重试的最大次数。目前仅重试 ECONNRESET 错误。不根据 HTTP 响应代码重试。如果超过限制，将抛出错误。默认为 0 - 不重试。
- setMethod String (可选)#
  
  如果设置，则更改请求方法（例如 GET 或 POST）。
- setPostData String | byte[] (可选)#
  
  如果设置，则更改请求的 post data。
- setTimeout double (可选)添加于: v1.33#
  
  请求超时时间，以毫秒为单位。默认为 30000（30 秒）。传递 0 以禁用超时。
- setUrl String (可选)#
  
  如果设置，则更改请求 URL。新 URL 必须与原始 URL 具有相同的协议。

返回值

APIResponse #

详情

请注意，setHeaders 选项将应用于 fetch 的请求以及它启动的任何重定向。如果您只想将 setHeaders 应用于原始请求，而不应用于重定向，请查看 Route.resume()。

fulfill

在 v1.9 之前添加

route.fulfill

使用给定的响应 fulfill 路由的请求。

用法

使用 404 响应 fulfill 所有请求的示例

page.route("**/*", route -> {
  route.fulfill(new Route.FulfillOptions()
    .setStatus(404)
    .setContentType("text/plain")
    .setBody("Not Found!"));
});

提供静态文件的示例

page.route("**/xhr_endpoint", route -> route.fulfill(
  new Route.FulfillOptions().setPath(Paths.get("mock_data.json"))));

参数

options Route.FulfillOptions (可选)
- setBody String (可选)#
  
  可选的响应主体，为文本。
- setBodyBytes byte[] (可选)添加于: v1.9#
  
  可选的响应主体，为原始字节。
- setContentType String (可选)#
  
  如果设置，则等于设置 Content-Type 响应标头。
- setHeaders Map<String, String> (可选)#
  
  响应标头。标头值将转换为字符串。
- setPath Path (可选)#
  
  要响应的文件路径。内容类型将从文件扩展名推断。如果 path 是相对路径，则相对于当前工作目录解析。
- setResponse APIResponse (可选)添加于: v1.15#
  
  APIResponse 用于 fulfill 路由的请求。可以使用 fulfill 选项覆盖响应的各个字段（例如标头）。
- setStatus int (可选)#
  
  响应状态代码，默认为 200。

返回值

void #

request

在 v1.9 之前添加

route.request

要路由的请求。

用法

Route.request();

返回值

Request #

resume

在 v1.9 之前添加

route.resume

将路由的请求发送到网络，并带有可选的覆盖。

用法

page.route("**/*", route -> {
  // Override headers
  Map<String, String> headers = new HashMap<>(route.request().headers());
  headers.put("foo", "foo-value"); // set "foo" header
  headers.remove("bar"); // remove "bar" header
  route.resume(new Route.ResumeOptions().setHeaders(headers));
});

参数

options Route.ResumeOptions (可选)
- setHeaders Map<String, String> (可选)#
  
  如果设置，则更改请求 HTTP 标头。标头值将转换为字符串。
- setMethod String (可选)#
  
  如果设置，则更改请求方法（例如 GET 或 POST）。
- setPostData String | byte[] (可选)#
  
  如果设置，则更改请求的 post data。
- setUrl String (可选)#
  
  如果设置，则更改请求 URL。新 URL 必须与原始 URL 具有相同的协议。

返回值

void #

详情

setHeaders 选项同时应用于路由的请求及其启动的任何重定向。但是，setUrl、setMethod 和 setPostData 仅应用于原始请求，而不传递给重定向的请求。

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

方法​

abort​

fallback​

fetch​

fulfill​

request​

resume​

方法

abort

fallback

fetch

fulfill

request

resume