Spring Cloud Gateway应用详解1之谓词

环境：springboot2.3.7 + spring cloud Hoxton.SR9

Spring Cloud Gateway工作流程：

 

客户端调用spring cloud gateway配置的请求。根据配置的映射确定请求与路由，将其发送到网关Web处理程序。此处理程序通过特定于请求的过滤器运行请求。过滤器被虚线分割的原因是，过滤器可以在代理请求发送之前和之后运行逻辑。执行所有“pre”过滤器逻辑。然后发出代理请求。在发出代理请求之后，运行“post”过滤器逻辑。

一. 路由谓词

1. After 路由谓词工厂
   作用：After 谓词工厂接受一个参数datetime（它是java ZonedDateTime）。此谓词匹配在指定日期时间之后发生的请求。以下示例配置After Route谓词：

spring:
  cloud:
    gateway:
      enabled: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      routes:
      - id: after_route
        uri: https://www.baidu.com
        predicates:
        - After=2021-01-10T17:42:47.789-07:00  

所有的请求必须在
2021-01-10T17:42:47.789-07:00之后才能访问。当超过当前配置的这个时间，请求会返回404。

测试：

当前时间：2021-01-11 17:09

After=2021-01-10T17:42:47.789-07:00

 

正常调整到了页面：

设置：

After=2021-01-20T17:42:47.789-07:00

 

1. Before 路由谓词工厂
   作用：Before 谓词工厂接受一个参数datetime（它是java ZonedDateTime）。此谓词匹配在指定日期时间之前发生的请求。以下示例配置Before Route谓词：

spring:
  cloud:
    gateway:
      enabled: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      routes:
      - id: before_route
        uri: https://www.qq.com
        predicates:
        - Before=2021-01-10T17:42:47.789-07:00

运行结果与After正好相反。

1. Between 路由谓词工厂
   作用：Between谓词工厂接受两个参数datetime（它是java ZonedDateTime）。此谓词匹配请求必须在两个日期之间发生。以下示例配置Between Route谓词：

spring:
  cloud:
    gateway:
      enabled: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      routes:
      - id: between_route
        uri: https://www.163.com
        predicates:
        - Between=2021-01-01T17:42:47, 2021-01-10T17:42:47

请求必须位于2021-01-01T17:42:47到2021-01-10T17:42:47之间，如果超过这个日期范围返回

404。

失败：

配置：Between=2021-01-01T17:42:47, 2021-01-10T17:42:47

 

1. Cookie 路由谓词工厂
   作用：只有网关请求中包含指定的cookie 才能匹配，否则404。以下示例配置Cookie Route谓词：

spring:
  cloud:
    gateway:
      enabled: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      routes:
      - id: cookie_route
        uri: https://www.baidu.com
        predicates:
        - Cookie=code,testiptv255

当请求header中包含的Cookie中包含name为code，值为testiptv255时，请求才能被匹配。

示例：

 

当不包含name为code的cookie时请求返回404。

1. Header 路由谓词工厂

作用：当请求中包含指定的Header信息时，请求才能匹配。以下示例配置Header Route谓词：

spring:
  cloud:
    gateway:
      enabled: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      routes:
      - id: header_route
        uri: https://www.baidu.com
        predicates:
        - Header=Host,localhost:20000

当网关请求Header中包含Host请求头，并且值为localhost:20000，请求才会被匹配。

示例：

 

1. Host 路由谓词工厂

作用：当请求Header中的Host头信息为配置中的列表中，那么网关将被匹配。以下示例配置Host Route谓词：

spring:
  cloud:
    gateway:
      enabled: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      routes:
      - id: host_route
        uri: https://www.baidu.com
        predicates:
        - Host=**.xg.com,localhost:20000

当请求Header中的Host取值为：www.xg.com或者xxx.xg.com或者localhost:20000时路由将被匹配：

示例：

 

1. Method 路由谓词工厂

作用：当请求是指定的Method时，路由将被匹配。以下示例配置Method Route谓词：

spring:
  cloud:
    gateway:
      enabled: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      routes:
      - id: method_route
        uri: https://www.baidu.com
        predicates:
        - Method=GET,POST

当请求是GET或者是POST请求时，网关路由将会被匹配。

示例：

 

1. Path 路由谓词工厂

作用：当请求的路径为指定的Path时，路由将会被匹配。以下示例配置Path Route谓词：

spring:
  cloud:
    gateway:
      enabled: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      routes:
      - id: path_route
        uri: https://www.baidu.com
        predicates:
        - Path=/api-a/{segment},/api-1/{segment}

当请求的地址为：http://xxx/api-a/xxx或者是http://xxx/api-1/xxx时，路由将会被匹配；注意：你的目标地址应该有/api-a/xxx和/api-1/xxx这两个请求地址。

示例：

 

页面显示的404是因为
http://www.baidu.com/api-a/1没有这样的请求地址是baidu返回的404，并不是我们服务器返回的404错误。

1. Query 路由谓词工厂

作用：当请求中包含指定的查询参数或者是包含指定的查询参数及值时才匹配路由。以下示例配置Query Route谓词：

1、方式1：
spring:
  cloud:
    gateway:
      enabled: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      routes:
      - id: query_route
        uri: https://www.baidu.com
        predicates:
        - Query=name
2、方式2：
spring:
  cloud:
    gateway:
      enabled: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      routes:
      - id: query_route
        uri: https://www.baidu.com
        predicates:
        - Query=name,admin

方式1：当请求中只要包含name参数即可。

 

方式2：当请求中包含name参数名并且值为admin时匹配路由。

 

当值非admin时返回404。

下节：《Spring Cloud Gateway应用详解2之Filter》

关注+转发谢谢