Gateway动态路由
Gateway路由配置分为 基于配置的静态路由设置和 基于代码动态路由配置,静态路由是指在application.yml中把路由信息配置好了,而动态路由则是从数据库中加载而来,我们接下来把这2种路由操作都实现一次。
业务说明
- 用户所有请求以/order开始的请求,都路由到 hailtaxi-order服务
- 用户所有请求以/driver开始的请求,都路由到 hailtaxi-driver服务
- 用户所有请求以/pay开始的请求,都路由到 hailtaxi-pay服务
基于配置路由设置
网关服务的application.yml:
如上图所示,正是Gateway静态路由配置:
1:用户所有请求以/order开始的请求,都路由到 hailtaxi-order服务
2:用户所有请求以/driver开始的请求,都路由到 hailtaxi-driver服务
3:用户所有请求以/pay开始的请求,都路由到 hailtaxi-pay服务
配置参数说明:
routes:路由配置
- id:唯一标识符
uri:路由地址,可以是 lb://IP:端口 也可以是 lb://${spring.application.name}
predicates:断言,是指路由条件
- Path=/driver/**:路由条件。Predicate 接受一个输入参数,返回一个布尔值结果。这里表示匹配所有以driver开始的请求。
测试
此时去访问网关的服务地址就能访问到driver的方法
基于代码路由配置
我们同样实现上面的功能,但这里基于代码方式实现。所有路由规则我们可以从数据库中读取并加载到程序中。基于代码的路由配置我们只需要创建RouteLocator
并添加路由配置即可,代码如下:(代码是写在网关服务的主启动类中)
/***
* 路由配置
* @param builder
* @return
*/
@Bean
public RouteLocator routeLocator(RouteLocatorBuilder builder) {
return builder.routes()
.route(r -> r.path("/driver/**").uri("lb://hailtaxi-driver"))
.route(r -> r.path("/order/**").uri("lb://hailtaxi-order"))
//使用GatewayFilter过滤器
.route(r -> r.path("/pay/**").uri("lb://hailtaxi-pay").filter(new PayFilter()))
.build();
}
在真实场景中,基于配置文件的方式更直观、简介,但代码的路由配置是更强大,可以实现很丰富的功能,可以把路由规则存在数据库中,每次直接从数据库中加载规则,这样的好处是可以动态刷新路由规则,通常应用于权限系统动态配置新系统。
Gateway-Predicate
上面路由匹配规则中我们都用了- Path
方式,其实就是路径匹配方式,除了路径匹配方式,Gateway还支持很多丰富的匹配方式,我们对这些方式分别进行讲解。
关于Predicate
学习地址,可以参考官网https://docs.spring.io/spring-cloud-gateway/docs/2.2.5.RELEASE/reference/html/#gateway-request-predicates-factories
routes下面的属性含义如下:
- id:我们自定义的路由 ID,保持唯一
- uri:目标服务地址
- predicates:路由条件,Predicate 接受一个输入参数,返回一个布尔值结果。该属性包含多种默认方法来将 Predicate 组合成其他复杂的逻辑(比如:与,或,非)
在 Spring Cloud Gateway 中 Spring 利用 Predicate 的特性实现了各种路由匹配规则,通过 Header、请求参数等不同的条件来作为条件匹配到对应的路由。
下面的一张图总结了 Spring Cloud 内置的几种 Predicate 的实现:
我们在这里讲解几个断言匹配 方式。
Cookie:
Gateway的Cookie匹配接收两个参数:一个是 Cookie name ,一个是正则表达式。路由规则就是通过获取对应的 Cookie name 值和正则表达式去匹配,如果匹配上就会执行路由,如果没有匹配上则不执行。如下配置:(还是网关服务的application.yml中来写配置)
gateway:
routes:
- id: hailtaxi-driver
uri: lb://hailtaxi-driver
predicates:
- Path=/driver/**
#这里表示请求携带了cookie为username的数据,并且值为itheima,就允许通过。
- Cookie=username,itheima
Header 匹配:
Header 匹配 和 Cookie 匹配 一样,也是接收两个参数,一个 header 中属性名称和一个正则表达式,这个属性值和正则表达式匹配则执行。配置如下:(还是网关服务的application.yml中来写配置)
gateway:
routes:
- id: hailtaxi-driver
uri: lb://hailtaxi-driver
predicates:
- Path=/driver/**
- Header=token,^(?!\d+$)[\da-zA-Z]+$
上面的匹配规则,就是请求头要有token属性,并且值必须为数字和字母组合的正则表达式,例如携带token=19and30
就可以通过访问。
请求方式匹配:
通过请求的方式是 POST、GET、PUT、DELETE 等进行路由。配置如下:
(还是网关服务的application.yml中来写配置)
gateway:
routes:
- id: hailtaxi-driver
uri: lb://hailtaxi-driver
predicates:
- Path=/driver/**
#只允许get方法的请求通过
- Method=GET