Spring Cloud Alibaba - Gateway 入门案例(三)(断言 / 过滤器)(自定义 断言 / (全局 / 局部)过滤器)(非阿里组件)
回溯
在上一篇博客的 SpringCloud Gateway 讲解中 ,我们讲述到了,企业选择配置多的方式来使用 SpringCloud Gateway ,是因为这种方式比较灵活,之所以灵活,最最最主要,是体现在了两个参数上 断言(predicates)/ 过滤器(filters) 。
断言(predicates)
Spring Cloud Gateway matches routes as part of the Spring WebFlux HandlerMapping infrastructure. Spring Cloud Gateway includes many built-in route predicate factories. All of these predicates match on different attributes of the HTTP request. You can combine multiple route predicate factories with logical and statements.
Predicate(断言, 谓词) 用于进行条件判断,只有断言都返回真,才会真正的执行路由。
断言就是说: 在 什么条件下 才能进行路由转发
SpringCloud Gateway包括许多内置的断言工厂,所有这些断言都与HTTP请求的不同属性匹配。具体如下:
- 基于Datetime类型的断言工厂,此类型的断言根据时间做判断,主要有三个:
AfterRoutePredicateFactory: 接收一个日期参数,判断请求日期是否晚于指定日期
BeforeRoutePredicateFactory: 接收一个日期参数,判断请求日期是否早于指定日期
BetweenRoutePredicateFactory: 接收两个日期参数,判断请求日期是否在指定时间段内
例:Before=2020-07-09T00:00:00.000+08:00
- 基于远程地址的断言工厂 RemoteAddrRoutePredicateFactory:接收一个IP地址段,判断请求主机地址是否在地址段中
例:-RemoteAddr=192.168.5.1/24
- 基于Cookie的断言工厂
CookieRoutePredicateFactory:接收两个参数,cookie 名字和一个正则表达式。 判断请求cookie是否具有给定名称且值与正则表达式匹配。
例:-Cookie=chocolate, ch.
- 基于Header的断言工厂
HeaderRoutePredicateFactory:接收两个参数,标题名称和正则表达式。 判断请求Header是否具有给定名称且值与正则表达式匹配。
例:-Header=X-Request-Id, \d+
- 基于Host的断言工厂
HostRoutePredicateFactory:接收一个参数,主机名模式。判断请求的Host是否满足匹配规则。
例:-Host=**.testhost.org
- 基于Method请求方法的断言工厂
MethodRoutePredicateFactory:接收一个参数,判断请求类型是否跟指定的类型匹配。
例:-Method=GET
- 基于Path请求路径的断言工厂
PathRoutePredicateFactory:接收一个参数,判断请求的URI部分是否满足路径规则。
例:-Path=/foo/{segment}
- 基于Query请求参数的断言工厂
QueryRoutePredicateFactory :接收两个参数,请求param和正则表达式, 判断请求参数是否具有给定名称且值与正则表达式匹配。
例:-Query=baz, ba.
这边附上文档地址,有需要可以去详细翻阅,博主的举例仅供参考。
点击 spring-cloud-gateway/2.2.3.RELEASE/reference/html/#gateway-request-predicates-factories 进入文档地址。
简单测试:配置文件如下
ps ( 此测试基于上一篇博文,若有疑问,请参考上一篇博文 )
server:
port: 7777
spring:
application:
name: api-gateway
cloud:
gateway:
discovery:
locator:
enabled: true #让gateway可以发现nacos中的微服务
routes: # 路由数组 指当请求满足什么样的条件的时候,转发到哪个微服务上
- id: nacosxfz_route #当前路由标识,要求唯一 (默认值uuid,一般不用,需要自定义)
uri: lb://test-scz #请求最终要被转发的地址 lb指的是从nacos中按照名称获取微服务,并遵循负载均衡策略
order: 1 #路由优先级,数字越小,优先级越高
predicates: #断言 判断条件,返回值是boolean 转发请求要返回的条件 (可以写多个)、
- Path=/scz_server/** #当请求路径满足path指定的规则时,此路由信息才会正常转发
- Method=POST
filters: #过滤器(在请求传递过程中,对请求做一些手脚)
- StripPrefix=1 # 在请求转发之前去掉一层路径
nacos:
discovery:
server-addr: 127.0.0.1:8848
证明:当请求方法为Get的时候是无法成功地。
自定义断言
有很多情况下,这些断言并不能满足我们的业务需求,需要自定义断言。
比如,现在我希望参数中 name 带有 huge 或者 liuyifei 或者 pengyuyan 才能进行转发,那么就需要自定义断言。
首先需要在yam总添加自定义断言名称。
为了开发方便,添加插件