Zuul和Gateway的背景故事
Zuul是Netflix公司的网关组件,在1.x版本中,Cloud都是采用的Zuul网关,但是随着技术发展,Netflix公司发现需要对Zuul进行升级,但这时发生了意外,Zuul的核心开发成员跳槽,公司内部对Zuul的升级产生分歧,导致Zuul2一次又一次的推迟上线。目前Zuul停止维护,Zuul2正在研发中,技术迟迟未定。
所以SpringCloud不再等待Zuul2的发布,借鉴Zuul的思想,直接自研了一套网关组件,就是今天的主角Gateway。两者功能都是一样的,但是由于Zuul的自身问题,加上Gateway的优势巨大,多方面考虑我们选择后者。
Gateway简介
Gateway是SpringCloud的一个全新项目,基于Spring 5.0+Spring Boot 2.0和Project Reactor等技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的API路由管理方式。
Gateway作为SpringCloud生态系统中的网关,目标是替代Zuul。在Cloud 2.0以上版本中,没有对新版本的Zuul 2.0以上最新高性能版本进行集成,仍然还是使用的Zuul 1.x非Reactor模式的老版本。而为了提升网关的性能,Gateway基于WebFlux框架实现,而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。
Gateway的目标是提供统一的路由方式且基于Filter链的方式提供了网关基本的功能,例如:安全,监控/指标,限流。
Gateway能做什么?
反向代理、鉴权、流量控制、熔断、日志监控
Gateway在微服务架构中的位置
Gateway三大核心概念
· Route(路由)
路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如果断言为true则匹配该路由。
· Predicate(断言)
开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与断言相匹配则进行路由。
· Filter(过滤)
使用过滤器,可以在请求被路由前或者之后对请求进行修改。
Gateway工作流程
官网gateway工作流程图
1. 客户端向Gateway发出请求,然后在Gateway Handler Mapping中找到与请求相匹配的路由,将其发送到Gateway Web Handler。
2. Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行逻辑,然后返回。
过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前("pre")或之后("post")执行业务逻辑。
3. Filter在"pre"类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等,在"post"类型的过滤器中可以做响应内容、响应头的修改,日志的输出,流量监控等有着非常重要的作用。一句话总结:路由转发+执行过滤器链
一、配置路由的两种方式
- 通过yml文件配置
1. 新建一个工程,专门用来做网关服务
工程名:cloud-gateway-server
2. pom文件添加gateway依赖
注意:pom中不要把spring-boot-starter-web依赖加进去,不然启动会报错。
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
3. 修改yml文件,添加如下内容
server:
port: 9527
spring:
application:
name: cloud-gateway-server
eureka:
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka8761.com:8761/eureka
4. 接下来实现通过网关访问cloud-provider-payment,调用里面的两个接口
5. yml新增网关配置,重点!!!
spring:
application:
name: cloud-gateway-server
cloud:
gateway:
routes:
- id: payment_route #payment_route 路由的id,没有固定规则但要求唯一,建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_route2 #payment_route 路由的id,没有固定规则但要求唯一,建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
6. 按顺序启动eureka8761,服务端8001,网关9527三个微服务,在浏览器测试,通过网关可以访问到8001的数据。
- 注入RouteLocator的Bean配置
1. 新建GatewayConfig.java类
public class GatewayConfig {
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
routes.route("path_route",
r -> r.path("/guonei")
.uri("http://news.baidu.com/guonei")).build();
return routes.build();
}
}
2. 请求地址http://localhost:9527/guonei,发现它自动跳转到了百度国内的网址。
这种java配置的方式不太推荐,简单了解一下就行,工作中也很少用。
二、动态路由的配置
上述路由配置有个问题,地址都是写死的,如果服务提供方是一个集群,或者会动态扩容,上述方式则不能满足需求,所以需要动态的去配置。
通过微服务名实现动态路由
默认情况下Gateway会根据注册中心注册的服务列表,以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由的功能。
1. 启动一个eureka8761,两个服务提供者8001/8002
2. 修改网关服务9527yml配置
需要注意的是uri的协议为lb,表示启用Gateway负载均衡功能。
lb://serviceName是gateway在微服务中自动为我们创建的负载均衡uri。
spring:
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创建路由的功能,利用微服务名进行路由
routes:
- id: payment_route #payment_route 路由的id,没有固定规则但要求唯一,建议配合服务名
uri: lb://cloud-provider-payment
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_route2 #payment_route 路由的id,没有固定规则但要求唯一,建议配合服务名
uri: lb://cloud-provider-payment
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
3. 重启网关9527服务,地址栏测试,发现通过网关服务可以访问8001/8002两个服务,且自带负载均衡。
三、Predicate与Filter
1. Predicate断言
简单理解就是if-else判断,符合规则就通过,不符合就进入下一步。断言规则除了上述配置的Path之外,还有很多其他类型,都是根据不同的规则匹配,适用于不同的业务场景。使用也比较简单,这里就不挨着演示了,有需求的直接看官网。https://docs.spring.io/spring-cloud-gateway/docs/2.2.5.RELEASE/reference/html/#gateway-request-predicates-factories">https://docs.spring.io/spring-cloud-gateway/docs/2.2.5.RELEASE/reference/html/#gateway-request-predicates-factories
2. Filter过滤器
在gateway的工作流程中,断言通过,下一步就是过滤器,过滤器就像sql中的where语句,可以配置多个Filter,层层过滤,形成一个过滤链。Gateway也内置了多种过滤器(地址如下),但是还是比较少用,常用的一般都是自定义过滤器。
https://docs.spring.io/spring-cloud-gateway/docs/2.2.5.RELEASE/reference/html/#gatewayfilter-factories">https://docs.spring.io/spring-cloud-gateway/docs/2.2.5.RELEASE/reference/html/#gatewayfilter-factories自定义过滤器
两个主要接口:GlobalFilter,Ordered
1. 新建一个过滤器类MyLogFilter.java
public class MyLogFilter implements GlobalFilter, Ordered {
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("come in MyLogFilter:"+ new Date());
String name = exchange.getRequest().getQueryParams().getFirst("name");
if (name == null){
log.info("*****用户名为空,非法用户******");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
public int getOrder() {
//返回值代表加载过滤器的顺序,值越小,优先级越低
return 0;
}
}
以上代码的意思就是在请求地址中,如果存在name且不为空,则通过,如果不存在,则返回错误编码。
2. 在地址栏中测试,看到如下内容则代表配置成功
如果name存在且不为空
如果name不存在,则跳转error界面
到这里,Gateway的基本知识就学完了
接下来开始学习下个组件:分布式配置中心Config
本项目已上传到gitee和github,地址在公众号窗口 我的->git 查看相关内容