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 数据。
- setUrl String (可选)#
  
  如果设置，则更改请求 URL。新的 URL 必须与原始 URL 具有相同的协议。更改 URL 不会影响路由匹配，所有路由都使用原始请求 URL 进行匹配。

返回值

void #

fetch

添加于: v1.29

route.fetch

执行请求并抓取结果而不满足它，以便可以修改响应然后满足它。

用法

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 数据。
- setTimeout double (可选)添加于: v1.33#
  
  请求超时时间（毫秒）。默认为 30000 (30 秒)。传递 0 表示禁用超时。
- setUrl String (可选)#
  
  如果设置，则更改请求 URL。新的 URL 必须与原始 URL 具有相同的协议。

返回值

APIResponse #

详情

注意，setHeaders 选项将应用于被抓取的请求以及由此引起的任何重定向。如果你只想将 setHeaders 应用于原始请求而不应用于重定向，请考虑使用 Route.resume()。

fulfill

在 v1.9 之前添加

route.fulfill

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

用法

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

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 选项覆盖响应的单个字段（例如头部）。
- 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 数据。
- setUrl String (可选)#
  
  如果设置，则更改请求 URL。新的 URL 必须与原始 URL 具有相同的协议。

返回值

void #

详情

setHeaders 选项应用于被路由的请求及其发起的任何重定向。然而，setUrl、setMethod 和 setPostData 仅应用于原始请求，不会传递给重定向请求。

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

警告

Cookie 头部不能通过此方法覆盖。如果提供了值，它将被忽略，并且 cookie 将从浏览器的 cookie 存储中加载。要设置自定义 cookie，请使用 BrowserContext.addCookies()。

方法​

abort​

fallback​

fetch​

fulfill​

request​

resume​

方法

abort

fallback

fetch

fulfill

request

resume