3. Spring Cloud Gateway之断言Predicate

1. 断言介绍

网关中的Predicate灵感来自java8的新特性java.util.function.Predicate，可以理解为：当满足条件后才会进行转发，如果是多个Predicate，那就是满足所有条件才会转发

2. 断言种类

1. After：匹配在指定日期时间之后发生的请求。
2. Before：匹配在指定日期之前发生的请求。
3. Between：需要指定两个日期参数，设定一个时间区间，匹配此时间区间内的请求。
4. Cookie：需要指定两个参数，分别为name和regexp（正则表达式），也可以理解Key和Value，匹配具有给定名称且其值与正则表达式匹配的Cookie。
5. Header：需要两个参数header和regexp（正则表达式），也可以理解为Key和Value，匹配请求携带信息。
6. Host：匹配当前请求是否来自于设置的主机。
7. Method：可以设置一个或多个参数，匹配HTTP请求，比如GET、POST
8. Path：匹配指定路径下的请求，可以是多个用逗号分隔
9. Query：需要指定一个或者多个参数，一个必须参数和一个可选的正则表达式，匹配请求中是否包含第一个参数，如果有两个参数，则匹配请求中第一个参数的值是否符合正则表达式。
10. RemoteAddr：匹配指定IP或IP段，符合条件转发。
11. Weight：需要两个参数group和weight（int），实现了路由权重功能，按照路由权重选择同一个分组中的路由

3. 常用断言演示

以上这么多的断言，我们不可能一一的去演示，我们挑出一些比较常用的来给大家做演示，这些具体的演示在官网上都有提供，具体地址为：Spring Cloud Gateway

1. After

表示配置时间之后才进行转发

spring.cloud.gateway.routes[0].id=nacos-provider
spring.cloud.gateway.routes[0].uri=lb://nacos-provider
# 访问路径Path=/test/**
spring.cloud.gateway.routes[0].predicates[0]=Path=/test/**
# 并且After时间之后的请求才转发
spring.cloud.gateway.routes[0].predicates[1]=After=2022-04-16T12:02:30.000+08:00[Asia/Shanghai] 

2. Cookie

格式为：Cookie=Cookie Name,Value Regexp

1. Cookie Name，这个是必选项，需要填入cookie的名称
2. Value Regexp，这个是可选项，需要填入值的正则表达式，如果没有填写，则判断有Cookie Name就匹配成功

spring.cloud.gateway.routes[0].id=nacos-provider
spring.cloud.gateway.routes[0].uri=lb://nacos-provider
# 访问路径Path=/test/**
spring.cloud.gateway.routes[0].predicates[0]=Path=/test/**
# 并且After时间之后的请求才转发
#spring.cloud.gateway.routes[0].predicates[1]=After=2022-04-16T12:02:30.000+08:00[Asia/Shanghai] 
# 并且匹配Cookie的key和value，这里表示有cookie为username值为小写字母的就匹配
spring.cloud.gateway.routes[0].predicates[1]=Cookie=username,[a-z]+ 

3. Header

Header和Cookie的原理是一样的，只是一个作用在Cookie上，一个作用在Header上。

spring.cloud.gateway.routes[0].id=nacos-provider
spring.cloud.gateway.routes[0].uri=lb://nacos-provider
# 访问路径Path=/test/**
spring.cloud.gateway.routes[0].predicates[0]=Path=/test/**
# 并且匹配Header的key和value，这里表示有cookie为X-Request-Id值为数字时匹配
spring.cloud.gateway.routes[0].predicates[1]=Header=X-Request-Id,\d+

4. Host

匹配当前请求是否来自于设置的主机，支持**匹配，如下

spring.cloud.gateway.routes[0].id=nacos-provider
spring.cloud.gateway.routes[0].uri=lb://nacos-provider
# 访问路径Path=/test/**
spring.cloud.gateway.routes[0].predicates[0]=Path=/test/**
# 并且匹配请求头Host，这里表示Host为**.test.com的请求才匹配
spring.cloud.gateway.routes[0].predicates[1]=Host=**host:8888

非**host:888不能访问

5. Method

这个就更简单了，匹配请求方式，如：GET/POST/HEAD等

spring.cloud.gateway.routes[0].id=nacos-provider
spring.cloud.gateway.routes[0].uri=lb://nacos-provider
# 访问路径Path=/test/**
spring.cloud.gateway.routes[0].predicates[0]=Path=/test/**
# 并且请求方式是GET才匹配
spring.cloud.gateway.routes[0].predicates[1]=Method=GET

浏览器之间输入地址打开，就是用的GET，能访问

Jmeter用POST访问同样的地址，不能访问，返回404

6. Query

匹配请求参数，和Head和Cookie一样，第一个参数为参数名字，是必填项，第二个参数是匹配值的正则表达式， 是选填项，如果没有第二个参数，则匹配有查询参数为配置名称的请求

spring.cloud.gateway.routes[0].id=nacos-provider
spring.cloud.gateway.routes[0].uri=lb://nacos-provider
# 访问路径Path=/test/**
spring.cloud.gateway.routes[0].predicates[0]=Path=/test/**
spring.cloud.gateway.routes[0].predicates[1]=Query=username,[a-z]+

7. Weight

这个predicate断言是用于实现后端服务多实例时，需要某些实例请求转发流量多些或少些，以实现权重的不同， 所以需要有多个路由才配置才有意义，一个路由的话始终100%了，需要两个参数group和weight（int），配置如下：

# 第一组配置，权重20%
spring.cloud.gateway.routes[0].id=nacos-provider8081
spring.cloud.gateway.routes[0].uri=http://localhost:8081
spring.cloud.gateway.routes[0].predicates[0]=Path=/test/**
spring.cloud.gateway.routes[0].predicates[1]=Weight=nacos-provider-weight-group,2
# 第一组配置，权重80%
spring.cloud.gateway.routes[1].id=nacos-provider8083
spring.cloud.gateway.routes[1].uri=http://localhost:8083
spring.cloud.gateway.routes[1].predicates[0]=Path=/test/**
spring.cloud.gateway.routes[1].predicates[1]=Weight=nacos-provider-weight-group,8

从GIF动图可以看出，大部分的流量分配给了8083端口了。

4. 总结

Predicate就是为了实现一组匹配规则，让请求过来找到对应的Route进行处理。