Gateway断言Predicate
每一个Predicate的使用,可以理解为:当满足条件后才会进行转发,如果多个,那就是满足所有条件才会转发
断言种类
- After:匹配在指定日期时间之后发生的请求。
- Before:匹配在指定日期之前发生的请求。
- Between:需要指定两个日期参数,设定一个时间区间,匹配此时间区间内的请求。
- Cookie:需要指定两个参数,分别为name和regexp(正则表达式),也可以理解Key和Value,匹配具有给定名称且其值与正则表达式匹配的Cookie。
- Header:需要两个参数header和regexp(正则表达式),也可以理解为Key和Value,匹配请求携带信息。
- Host:匹配当前请求是否来自于设置的主机。
- Method:可以设置一个或多个参数,匹配HTTP请求,比如GET、POST
- Path:匹配指定路径下的请求,可以是多个用逗号分隔
- Query:需要指定一个或者多个参数,一个必须参数和一个可选的正则表达式,匹配请求中是否包含第一个参数,如果有两个参数,则匹配请求中第一个参数的值是否符合正则表达式。
- RemoteAddr:匹配指定IP或IP段,符合条件转发。
- Weight:需要两个参数group和weight(int),实现了路由权重功能,按照路由权重选择同一个分组中的路由
- XForwarded:允许基于X-Forwarded-For HTTP头对请求进行过滤。 The XForwarded 远程地址路由断言工厂接受一个源列表(最小大小为1),它是 CIDR-notation (IPv4 or IPv6) ,例如:192.168.0.1/16(其中192.168.0.1是一个IP地址,16是一个子网掩码)。这可以用于反向代理,如负载均衡器或web应用程序防火墙,在这些反向代理中,只有当请求来自由这些反向代理使用的可信IP地址列表时,才应该允许该请求。
常用断言演示
以上这么多的断言,我们不可能一一的去演示,我们挑出一些比较常用的来给大家做演示,这些具体的演示在官网上都有提供。
After
匹配在指定时间之后发生的请求,可以对应提前上线业务
首先编写一个测试类,来获取当前时间:

package com.example.cloudalibabagateway9999;
import org.springframework.boot.test.context.SpringBootTest;
import java.time.ZonedDateTime;
@SpringBootTest
public class TestDateTime {
public static void main(String[] args) {
// 默认时区
ZonedDateTime zbj = ZonedDateTime.now();
System.out.println(zbj);
}
}
得到的时间格式后,修改网关服务cloud-gateway-service-9999的application.yml配置:
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
#是否与服务发现组件进行结合,通过serviceId转发到具体的服务实例。默认为false,设为true便开启通过服务中心的自动根据 serviceId 创建路由的功能
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
- After=2022-07-20T15:19:09.951+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过,当前没有问题以后,故意改为1个小时以后
测试:
上面的配置修改之后,重启网关服务,我们访问地址:http://localhost:9999/demo/hello

接着,我们将上面配置的After的时间往后推迟一个小时,即改成在当前时间之后,重启网关服务,再次访问:

剩下的关于日期时间的设置Before、Between(中间使用逗号进行间隔)道理都是一样的,只不过是限定不同的日期时间区间:
- Before=2022-07-20T16:19:09.951+08:00[Asia/Shanghai]
- Between=2022-07-20T15:19:09.951+08:00[Asia/Shanghai], 2022-07-20T16:19:09.951+08:00[Asia/Shanghai]
Cookie
需要指定两个参数,分别为name和regexp(正则表达式),也可以理解Key和Value,匹配具有给定名称且其值与正则表达式匹配的Cookie。
简单理解就是路由规则会通过获取Cookie name值和正则表达式去匹配,如果匹配上就会执行路由,如果匹配不上则不执行。
我们可以分为两种情况演示,Cookie匹配,Cookie不匹配
修改网关服务cloud-gateway-service-9999的application.yml配置:
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
#是否与服务发现组件进行结合,通过serviceId转发到具体的服务实例。默认为false,设为true便开启通过服务中心的自动根据 serviceId 创建路由的功能
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
# - After=2022-07-20T16:19:09.951+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过,当前没有问题以后,故意改为1个小时以后
- Cookie=username, [a-z]+ # 匹配Cookie的key和value(正则表达式)
重启网关服务,我们可以通过postman来进行测试:
- 首先我们加一个collection,名称可以随便取,我这里取名Gateway

- 我们加一个请求,请求地址为:http://localhost:9999/demo/hello,点击send按钮,这时是无法请求成功的

- 我们增加一个Cookie,点击Cookies按钮,添加domian为localhost

点击Add Cookie, 修改Cookie_1=value; 为username=zhangsan; 并点击Save按钮

- 最后,我们再次点击Send按钮,发现请求成功

Header
需要两个参数header和regexp(正则表达式),也可以理解为Key和Value,匹配请求携带信息。
实际上就是请求头携带的信息,下面我们用这个是X-Request-Id来做测试
修改网关服务cloud-gateway-service-9999的application.yml配置:
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
#是否与服务发现组件进行结合,通过serviceId转发到具体的服务实例。默认为false,设为true便开启通过服务中心的自动根据 serviceId 创建路由的功能
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
# - After=2022-07-20T16:19:09.951+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过,当前没有问题以后,故意改为1个小时以后
# - Cookie=username, [a-z]+ # 匹配Cookie的key和value(正则表达式)
- Header=X-Request-Id, \d+ #表示数字
重启网关服务,我们还是通过postman来进行测试:
未加Header之前,无法请求成功:

加上Header之后,请求成功:

Host
匹配当前请求是否来自于设置的主机。
修改网关服务cloud-gateway-service-9999的application.yml配置:
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
#是否与服务发现组件进行结合,通过serviceId转发到具体的服务实例。默认为false,设为true便开启通过服务中心的自动根据 serviceId 创建路由的功能
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
# - After=2022-07-20T16:19:09.951+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过,当前没有问题以后,故意改为1个小时以后
# - Cookie=username, [a-z]+ # 匹配Cookie的key和value(正则表达式)
# - Header=X-Request-Id, \d+ #表示数字
- Host=**.gateway.com #匹配当前的主机地址发出的请求
重启网关服务,我们还是通过postman来进行测试:
未加Host之前,无法请求成功:

加上Host之后,请求成功:

Method
可以设置一个或多个参数,匹配HTTP请求,比如GET、POST
首先,修改网关服务cloud-gateway-service-9999的application.yml配置(只配置POST方法):
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
#是否与服务发现组件进行结合,通过serviceId转发到具体的服务实例。默认为false,设为true便开启通过服务中心的自动根据 serviceId 创建路由的功能
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
# - After=2022-07-20T16:19:09.951+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过,当前没有问题以后,故意改为1个小时以后
# - Cookie=username, [a-z]+ # 匹配Cookie的key和value(正则表达式)
# - Header=X-Request-Id, \d+ #表示数字
# - Host=**.gateway.com #匹配当前的主机地址发出的请求
- Method=POST
重启网关服务,我们还是通过postman来进行测试,由于我们配置的是POST方法,所以无法请求成功

然后,我们修改网关服务cloud-gateway-service-9999的application.yml配置(配置GET方法和POST方法):
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
#是否与服务发现组件进行结合,通过serviceId转发到具体的服务实例。默认为false,设为true便开启通过服务中心的自动根据 serviceId 创建路由的功能
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
# - After=2022-07-20T16:19:09.951+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过,当前没有问题以后,故意改为1个小时以后
# - Cookie=username, [a-z]+ # 匹配Cookie的key和value(正则表达式)
# - Header=X-Request-Id, \d+ #表示数字
# - Host=**.gateway.com #匹配当前的主机地址发出的请求
- Method=GET,POST
重启网关服务,我们再通过postman来进行请求,最终请求成功

Query
需要指定一个或者多个参数,一个必须参数和一个可选的正则表达式,匹配请求中是否包含第一个参数,如果有两个参数,则匹配请求中第一个参数的值是否符合正则表达式。
修改网关服务cloud-gateway-service-9999的application.yml配置:
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
#是否与服务发现组件进行结合,通过serviceId转发到具体的服务实例。默认为false,设为true便开启通过服务中心的自动根据 serviceId 创建路由的功能
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
# - After=2022-07-20T16:19:09.951+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过,当前没有问题以后,故意改为1个小时以后
# - Cookie=username, [a-z]+ # 匹配Cookie的key和value(正则表达式)
# - Header=X-Request-Id, \d+ #表示数字
# - Host=**.gateway.com #匹配当前的主机地址发出的请求
# - Method=GET,POST
- Query=id, 123. # 前缀为123,匹配请求参数,这里如果需要匹配多个参数,可以写多个Query
重启网关服务,我们还是通过postman来进行测试:
首先,用id=1来测试,由于不匹配,前缀不为123, 所以无法请求成功

然后我们将id的值改为1234,再次请求,请求成功

如果需要匹配多个参数,可以修改成如下配置:
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
#是否与服务发现组件进行结合,通过serviceId转发到具体的服务实例。默认为false,设为true便开启通过服务中心的自动根据 serviceId 创建路由的功能
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
# - After=2022-07-20T16:19:09.951+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过,当前没有问题以后,故意改为1个小时以后
# - Cookie=username, [a-z]+ # 匹配Cookie的key和value(正则表达式)
# - Header=X-Request-Id, \d+ #表示数字
# - Host=**.gateway.com #匹配当前的主机地址发出的请求
# - Method=GET,POST
- Query=id, 123. # 匹配请求参数,这里如果需要匹配多个参数,可以写多个Query
- Query=name, [a-z]+ # 匹配请求参数,这里如果需要匹配多个参数,可以写多个Query
测试如下:

Weight
需要两个参数group和weight(int),实现了路由权重功能,按照路由权重选择同一个分组中的路由
修改网关服务cloud-gateway-service-9999的application.yml配置:
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
#是否与服务发现组件进行结合,通过serviceId转发到具体的服务实例。默认为false,设为true便开启通过服务中心的自动根据 serviceId 创建路由的功能
routes: # 路由
- id: nacos-provider #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: http://localhost:9001 # 匹配提供服务的路由地址 lb://代表开启负载均衡
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
# - After=2022-07-20T16:19:09.951+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过,当前没有问题以后,故意改为1个小时以后
# - Cookie=username, [a-z]+ # 匹配Cookie的key和value(正则表达式)
# - Header=X-Request-Id, \d+ #表示数字
# - Host=**.gateway.com #匹配当前的主机地址发出的请求
# - Method=GET,POST
# - Query=id, 123. # 匹配请求参数,这里如果需要匹配多个参数,可以写多个Query
# - Query=name, [a-z]+ # 匹配请求参数,这里如果需要匹配多个参数,可以写多个Query
- Weight=group1, 8
- id: nacos-provider-low #路由ID,没有固定要求,但是要保证唯一,建议配合服务名
uri: http://localhost:9002 # 匹配提供服务的路由地址 lb://代表开启负载均衡
predicates: # 断言
- Path=/demo/** # 断言,路径相匹配进行路由
- Weight=group1, 2
该路由会将约 80% 的流量转发到http://localhost:9001,将约 20% 的流量转发到http://localhost:9002
重启服务,进行测试:

多刷新页面请求几次,就会请求到9002:

3076

被折叠的 条评论
为什么被折叠?



