目录
一、简介
cloud全家桶中有个很重要的组件就是网关,在1.x版本中都是采用zuul网关,但是在2.新版本中,zuul一直跳票,springcloud最后自己研发了一个网关代替zuul那就是springcloud gateway,一句话,gateway就是zuul1.x版本的替代
提供一种简单有效的方式对API进行路由,以及提供一些强大的过滤器功能,例如:熔断、限流、重试等
gateway可以提供反向代理、鉴权、流量控制、熔断、日志监控。。。
SpringCloud Gateway具有如下特性
- 基于Spring Framework5、Project Reactor、SpringBoot2.0进行构建
- 动态路由:能够匹配任何请求属性
- 可以对路由指定Predicate(断言)和Filter(过滤器)
- 集成Hystrix的断路器功能
- 集成SpringCloud服务发现功能
- 易于编写的Predicate(断言)和Filter(过滤器)
- 请求限流功能
- 支持路径重写
二、三大核心概念
-
Route(路由)
路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如果断言为
true则匹配该路由
-
Predicate(断言)
参考java8的java.util.function.Predicate,开发人员可以匹配HTTP请求中的所有内容(例如
请求头或者请求参数),如果请求与断言相匹配则进行路由
-
Filter(过滤器)
指的是spring框架中GatewayFilter的实例,使用过滤器,可以在请求北路有前或者之后对请
求进行修改
总结:
web请求,通过一次额匹配条件,定位到真正的服务节点,并在这个转发过程的前后,进行一些精细化控制
Predicate就是我们的匹配条件;而Filter就可以理解为一个无所不能的拦截器。有了这2个元素,再加上目标uri,就可以实现一个具体的路由
三、gateway工作流程
客户端向SpringCloud Gateway发出请求,然后再Gateway Handler Mapping中找到与请求相匹配的路由,将其发送到Gateway Web Handler,handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑,然后返回
过滤器之间用须先分开是因为过滤器可能会在发送代理请求之前(“Pre”)或者之后(“Post”)执行业务逻辑
Filter在“Pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等
Filter在"Post"类型的过滤器可以做相应内容、响应头的修改、日志的输出、流量监控等有着非常重要的作用
核心逻辑:路由转发+执行过滤器链
四、入门配置
1、pom文件
gateway不需要spring-boot-starter-web,否则会报错
<dependency>
<groupId>org.springframework.cloud</groupId>
<actifactId>spring-cloud-starter-gateway</actifactId>
</dependency>
2、修改启动类
网关也要注册在Eureka注册中心,添加注解@EnableEurekaClient
3、添加yml文件
server:
port: 9527
spring:
cloud:
gateway:
routes:
#路由的Id,没有固定规则但要求唯一,建议配合服务名
- id: payment_routh
uri: http://localhost:8001 #匹配后提供的服务的路由地址
predicates:
- Path=/paymeny/** #断言,路径相匹配就进行路由
#路由的Id,没有固定规则但要求唯一,建议配合服务名
- id: payment_order
uri: http://localhost:8002 #匹配后提供的服务的路由地址
predicates:
- Path=/paymentOrder/** #断言,路径相匹配就进行路由
erkeua:
instance:
hostname: cloud-gateway-service
client:
service-url:
registry-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka
五、通过微服务名实现动态路由
默认情况下Gateway会根据注册中心注册的服务列表以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由的功能
修改yml文件
spring:
cloud:
gateway:
discovery:
locator:
enables: true #开启动态创建路由的功能,利用微服务名进行路由
routes:
#路由的Id,没有固定规则但要求唯一,建议配合服务名
- id: payment_routh
uri: lb://cloud-payment-service #lb代表负载均衡
#uri: http://localhost:8001 #匹配后提供的服务的路由地址
predicates:
- Path=/paymeny/** #断言,路径相匹配就进行路由
六、Predicate的使用
精确匹配,不止可以配置path
predicates:
- After: 2020-02-15T15:51:23.484+08:00[Asia/Shanghai] #就是实际在这个之后的才放行
- Between: 2020-02-15T15:51:23.484+08:00[Asia/Shanghai],2020-06-15T15:51:23.484+08:00[Asia/Shanghai]
- Cookie=username,zzyy #Cookie Route Predicate需要2个参数,一个是Cookie name,一个是正则表达式,路由规则会通过获取对应的Cookie name值和正则表达式去匹配,如果匹配上就会执行路由,如果没有匹配上就不执行
#curl http://localhost:9527/payment/get/31 --cookie "username=zzyy"
- Header=X-Request-Id, \d+ #带请求头参数
- Host: www.atguigu.com
- Method: GET,PUT,POST
- Query: username #要有查询条件的 带username参数
七、Filter的使用
1、常用的GateWayFilter
spring:
cloud:
routes:
filters:
- AddRequestParamaeter-X -Request_Id,1024 #过滤器工厂会在匹配的请求头加上一对请求头,名称为X-Request-Id值为1024
2、自定义全局过滤器GlobalFilter
两个主要接口介绍 implements Global Filter,Ordered
做全局日志记录、统一网关鉴权。。。
@Component
@slf4j
public class MyLogGatewatFilter implements GlobalFilter,Ordered{
@Override
public Mono<void> filter(ServerWebExchange exchange,GatewayFilterChain chain){
log.info("#*****come in MylogGatewayFilter");
String uname=exchange,getRequest().getQueryParams().getFirst("uname");
if(uname==null){
log.info("#用户名为null,非法用户")
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange,getResponse().setComplete();
}
return chain.filter(exchange);
}
@Override
public int getOrder(){
return 0; #过滤器加载顺序, 从小到大
}
}