5. 路由谓词工厂 (5. Route Predicate Factories) _ Spring Cloud Gateway3.1.9中文文档(官方文档中文翻译)|Spring 教程 —

5. 路由谓词工厂

Spring Cloud 网关将路由作为 Spring WebFlux 基础结构的一部分进行匹配。 Spring Cloud 网关包括许多内置的路由谓词工厂。所有这些谓词都与 HTTP 请求的不同属性匹配。您可以将多个路由谓词工厂与逻辑语句组合在一起。HandlerMappingandspring-doc.cn

5.1. After Route 谓词工厂

路由谓词工厂采用一个参数 a （即 java ）。此谓词匹配在指定日期/时间之后发生的请求。以下示例配置 after 路由谓词：AfterdatetimeZonedDateTimespring-doc.cn

示例 1.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: https://example.org
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]

此路由匹配 2017 年 1 月 20 日 17：42 山区时间（丹佛）之后发出的任何请求。spring-doc.cn

5.2. Before Route 谓词工厂

路由谓词工厂采用一个参数 a （即 java ）。此谓词匹配在指定的 . 以下示例配置 before route 谓词：BeforedatetimeZonedDateTimedatetimespring-doc.cn

示例 2.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: before_route
        uri: https://example.org
        predicates:
        - Before=2017-01-20T17:42:47.789-07:00[America/Denver]

此路由匹配在 2017 年 1 月 20 日 17：42 山区时间（丹佛）之前发出的任何请求。spring-doc.cn

5.3. Between 路由谓词工厂

路由谓词工厂采用两个参数，它们是 java 对象。此谓词匹配在之后和之前发生的请求。参数必须位于之后。以下示例配置了 between 路由谓词：Betweendatetime1datetime2ZonedDateTimedatetime1datetime2datetime2datetime1spring-doc.cn

例 3.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: between_route
        uri: https://example.org
        predicates:
        - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]

此路由匹配在 2017 年 1 月 20 日 17：42 山区时间（丹佛）和 2017 年 1 月 21 日 17：42 山区时间（丹佛）之前发出的任何请求。这对于维护时段可能很有用。spring-doc.cn

路由谓词工厂采用两个参数：cookie 和 a（这是一个 Java 正则表达式）。此谓词匹配具有给定名称且其值与正则表达式匹配的 Cookie。以下示例配置 cookie 路由谓词工厂：Cookienameregexpspring-doc.cn

示例 4.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: cookie_route
        uri: https://example.org
        predicates:
        - Cookie=chocolate, ch.p

此路由匹配具有 cookie 的请求，该 cookie 的名称与其值与正则表达式匹配。chocolatech.pspring-doc.cn

5.5. Header 路由谓词工厂

路由谓词工厂采用两个参数，即 the 和 a（这是一个 Java 正则表达式）。此谓词与具有给定名称的 Headers 匹配，该 Headers 的值与正则表达式匹配。以下示例配置标头路由谓词：Headerheaderregexpspring-doc.cn

例 5.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: header_route
        uri: https://example.org
        predicates:
        - Header=X-Request-Id, \d+

如果请求具有一个名为 Headers 的 Header，其值与正则表达式匹配（即，它的值为一个或多个数字），则此路由匹配。X-Request-Id\d+spring-doc.cn

5.6. 主机路由谓词工厂

路由谓词工厂采用一个参数： host name 列表。该模式是 Ant 样式的模式，作为分隔符。此谓词与匹配模式的标头匹配。以下示例配置主机路由谓词：Hostpatterns.Hostspring-doc.cn

例 6.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: https://example.org
        predicates:
        - Host=**.somehost.org,**.anotherhost.org

还支持 URI 模板变量（如）。{sub}.myhost.orgspring-doc.cn

如果请求的标头值为 or 或，则此路由匹配。Hostwww.somehost.orgbeta.somehost.orgwww.anotherhost.orgspring-doc.cn

此谓词将 URI 模板变量（如上例中定义的）提取为名称和值的映射，并将其放置在中，并在中定义了键。然后，这些值可供 GatewayFilter 工厂使用subServerWebExchange.getAttributes()ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTEspring-doc.cn

5.7. Method Route Predicate Factory

Route Predicate Factory 采用一个参数，该参数是一个或多个参数：要匹配的 HTTP 方法。以下示例配置方法路由谓词：Methodmethodsspring-doc.cn

例 7.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: method_route
        uri: https://example.org
        predicates:
        - Method=GET,POST

如果请求方法是 a 或 a ，则此路由匹配。GETPOSTspring-doc.cn

5.8. 路径路由谓词工厂

Route Predicate Factory 采用两个参数：Spring 列表和名为（defaults to）的可选标志。以下示例配置路径路由谓词：PathPathMatcherpatternsmatchTrailingSlashtruespring-doc.cn

例 8.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: path_route
        uri: https://example.org
        predicates:
        - Path=/red/{segment},/blue/{segment}

如果请求路径为，则此路由匹配，例如：or or or 。/red/1/red/1//red/blue/blue/greenspring-doc.cn

如果设置为，则不会匹配请求路径。matchTrailingSlashfalse/red/1/spring-doc.cn

此谓词将 URI 模板变量（如上例中定义的）提取为名称和值的映射，并将其放置在中，并在中定义了键。然后，这些值可供 GatewayFilter 工厂使用segmentServerWebExchange.getAttributes()ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTEspring-doc.cn

可以使用一种实用程序方法（称为）来更轻松地访问这些变量。以下示例演示如何使用该方法：getgetspring-doc.cn

Map<String, String> uriVariables = ServerWebExchangeUtils.getUriTemplateVariables(exchange);

String segment = uriVariables.get("segment");

5.9. 查询路由谓词工厂

路由谓词工厂采用两个参数：一个 required 和一个 optional （这是一个 Java 正则表达式）。以下示例配置查询路由谓词：Queryparamregexpspring-doc.cn

例 9.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: https://example.org
        predicates:
        - Query=green

如果请求包含查询参数，则前面的路由匹配。greenspring-doc.cn

application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: https://example.org
        predicates:
        - Query=red, gree.

如果请求包含其值与 regexp 匹配的查询参数，则前面的路由匹配，则 so 和 would match。redgree.greengreetspring-doc.cn

5.10. RemoteAddr 路由谓词工厂

路由谓词工厂采用的列表（最小大小 1），这些列表是 CIDR 表示法（IPv4 或 IPv6）字符串，例如（其中是 IP 地址，是子网掩码）。下面的示例配置 RemoteAddr 路由谓词：RemoteAddrsources192.168.0.1/16192.168.0.116spring-doc.cn

例 10.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: remoteaddr_route
        uri: https://example.org
        predicates:
        - RemoteAddr=192.168.1.1/24

例如，如果请求的远程地址为 .192.168.1.10spring-doc.cn

5.10.1. 修改解析远程地址的方式

默认情况下，RemoteAddr 路由谓词工厂使用来自传入请求的远程地址。如果 Spring Cloud Gateway 位于代理层后面，则这可能与实际的客户端 IP 地址不匹配。spring-doc.cn

您可以通过设置自定义 . Spring Cloud 网关附带一个基于 X-Forwarded-For 标头的非默认远程地址解析器。RemoteAddressResolverXForwardedRemoteAddressResolverspring-doc.cn

XForwardedRemoteAddressResolver有两个 static 构造函数方法，它们采用不同的安全方法：spring-doc.cn

XForwardedRemoteAddressResolver::trustAll返回 a，它始终采用在标头中找到的第一个 IP 地址。此方法容易受到欺骗，因为恶意客户端可能会为设置初始值，解析程序将接受该值。RemoteAddressResolverX-Forwarded-ForX-Forwarded-Forspring-doc.cn
XForwardedRemoteAddressResolver::maxTrustedIndex采用与 Spring Cloud Gateway 前面运行的可信基础设施数量相关的索引。例如，如果 Spring Cloud 网关只能通过 HAProxy 访问，则应使用值 1。如果在 Spring Cloud Gateway 可访问之前需要两个受信任的基础结构跃点，则应使用值 2。spring-doc.cn

请考虑以下标头值：spring-doc.cn

X-Forwarded-For: 0.0.0.1, 0.0.0.2, 0.0.0.3

以下值生成以下远程地址：maxTrustedIndexspring-doc.cn

maxTrustedIndex 结果

`maxTrustedIndex`	结果
[`Integer.MIN_VALUE`,0]spring-doc.cn	（无效，在初始化期间）`IllegalArgumentException`spring-doc.cn
1spring-doc.cn	0.0.0.3spring-doc.cn
2spring-doc.cn	0.0.0.2spring-doc.cn
3spring-doc.cn	0.0.0.1spring-doc.cn
[4,`Integer.MAX_VALUE`]spring-doc.cn	0.0.0.1spring-doc.cn

[Integer.MIN_VALUE,0]spring-doc.cn

（无效，在初始化期间）IllegalArgumentExceptionspring-doc.cn

1spring-doc.cn

0.0.0.3spring-doc.cn

2spring-doc.cn

0.0.0.2spring-doc.cn

3spring-doc.cn

0.0.0.1spring-doc.cn

[4,Integer.MAX_VALUE]spring-doc.cn

0.0.0.1spring-doc.cn

以下示例显示了如何使用 Java 实现相同的配置：spring-doc.cn

例 11.GatewayConfig.java

RemoteAddressResolver resolver = XForwardedRemoteAddressResolver
    .maxTrustedIndex(1);

...

.route("direct-route",
    r -> r.remoteAddr("10.1.1.1", "10.10.1.1/24")
        .uri("https://downstream1")
.route("proxied-route",
    r -> r.remoteAddr(resolver, "10.10.1.1", "10.10.1.1/24")
        .uri("https://downstream2")
)

5.11. 权重路由谓词工厂

路由谓词工厂接受两个参数：和（an int）。权重按组计算。以下示例配置权重路由谓词：Weightgroupweightspring-doc.cn

例 12.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: weight_high
        uri: https://weighthigh.org
        predicates:
        - Weight=group1, 8
      - id: weight_low
        uri: https://weightlow.org
        predicates:
        - Weight=group1, 2

此路由会将 ~80% 的流量转发到 weighthigh.org，将 ~20% 的流量转发到 weighlow.org spring-doc.cn

5.12. XForwarded 远程 Addr 路由谓词工厂

路由谓词工厂采用的列表（最小大小 1），这些列表是 CIDR 表示法（IPv4 或 IPv6）字符串，例如（其中是 IP 地址，是子网掩码）。XForwarded Remote Addrsources192.168.0.1/16192.168.0.116spring-doc.cn

此路由谓词允许根据 HTTP 标头筛选请求。X-Forwarded-Forspring-doc.cn

这可以与反向代理（如负载均衡器或 Web 应用程序防火墙）一起使用，其中仅当请求来自这些地址使用的受信任 IP 地址列表时，才应允许该请求反向代理。spring-doc.cn

下面的示例配置 XForwardedRemoteAddr 路由谓词：spring-doc.cn

例 13.application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: xforwarded_remoteaddr_route
        uri: https://example.org
        predicates:
        - XForwardedRemoteAddr=192.168.1.1/24

如果标头包含例如 .X-Forwarded-For192.168.1.10spring-doc.cn