一 spring cloud zuul 简介
- Spring Cloud Zuul 是 Spring Cloud Netflix 子项目的核心组件之一，可以作为微服务架构中的 API 网关使用，支持动态路由与过滤功能
- API 网关为微服务架构中的服务提供了统一的访问入口，客户端通过 API 网关访问相关服务。
- API 网关的定义类似于设计模式中的门面模式，它相当于整个微服务架构中的门面，所有客户端的访问都通过它来进行路由及过滤。
- 它实现了请求路由、负载均衡、校验过滤、服务容错、服务聚合等功能。
二 原理
a、 zuul是什么
zuul 是netflix开源的一个API Gateway 服务器, 本质上是一个web servlet应用
b、zuul的工作原理
b-1 过滤器机制
- zuul的核心是一系列的filters, 其作用可以类比Servlet框架的Filter，或者AOP。
- zuul把Request route到 用户处理逻辑 的过程中，这些filter参与一些过滤处理，比如Authentication，Load Shedding等。
- Zuul提供了一个框架，可以对过滤器进行动态的加载，编译，运行。
- Zuul的过滤器之间没有直接的相互通信，他们之间通过一个RequestContext的静态类来进行数据传递的。RequestContext类中有ThreadLocal变量来记录每个Request所需要传递的数据。
- Zuul的过滤器是由Groovy写成，这些过滤器文件被放在Zuul Server上的特定目录下面，Zuul会定期轮询这些目录，修改过的过滤器会动态的加载到Zuul Server中以便过滤请求使用。
b-2 下面有几种标准的过滤器类型：
Zuul大部分功能都是通过过滤器来实现的。Zuul中定义了四种标准过滤器类型，这些过滤器类型对应于请求的典型生命周期。
- PRE：这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
- ROUTING 务。这种过滤器用于构建发送给微服务的请求，并使用Apache HttpClient或Netfilx Ribbon请求微服务。
- POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。
- ERROR：在其他阶段发生错误时执行该过滤器。
b-3 内置的特殊过滤器
zuul还提供了一类特殊的过滤器，分别为：StaticResponseFilter和SurgicalDebugFilter
- StaticResponseFilter：StaticResponseFilter允许从Zuul本身生成响应，而不是将请求转发到源。
- SurgicalDebugFilter：SurgicalDebugFilter允许将特定请求路由到分隔的调试集群或主机。
b-4 自定义的过滤器
例如，可以定制一种STATIC类型的过滤器，直接在Zuul中生成响应，而不将请求转发到后端的微服务。
b-5 过滤器调度过程
在ZuulServlet类中
c、zuul 能做什么？
Zuul可以通过加载动态过滤机制，从而实现以下各项功能：
- 验证与安全保障: 识别面向各类资源的验证要求并拒绝那些与要求不符的请求。
- 审查与监控: 在边缘位置追踪有意义数据及统计结果，从而为我们带来准确的生产状态结论。
- 动态路由: 以动态方式根据需要将请求路由至不同后端集群处。
- 压力测试: 逐渐增加指向集群的负载流量，从而计算性能水平。
- 负载分配: 为每一种负载类型分配对应容量，并弃用超出限定值的请求。
- 静态响应处理: 在边缘位置直接建立部分响应，从而避免其流入内部集群。
- 多区域弹性: 跨越AWS区域进行请求路由，旨在实现ELB使用多样化并保证边缘位置与使用者尽可能接近。
- 除此之外，Netflix公司还利用Zuul的功能通过金丝雀版本实现精确路由与压力测试。
d、zuul 与应用的集成方式
d-1 处理请求
- ZuulServlet - 处理请求（调度不同阶段的filters，处理异常等） ZuulServlet类似SpringMvc的DispatcherServlet，所有的Request都要经过ZuulServlet的处理
- 三个核心的方法preRoute(),route(), postRoute()，zuul对request处理逻辑都在这三个方法里
- ZuulServlet交给ZuulRunner去执行。由于ZuulServlet是单例，因此ZuulRunner也仅有一个实例。
- ZuulRunner直接将执行逻辑交由FilterProcessor处理，FilterProcessor也是单例，其功能就是依据filterType执行filter的处理逻辑
- FilterProcessor对filter的处理逻辑。
1⃣️ 首先根据Type获取所有输入该Type的filter，Listlist。
2⃣️ 遍历该list，执行每个filter的处理逻辑，processZuulFilter(ZuulFilter filter)
3⃣️ RequestContext对每个filter的执行状况进行记录，应该留意，此处的执行状态主要包括其执行时间、以及执行成功或者失败，如果执行失败则对异常封装后抛出。
4⃣️ 到目前为止，zuul框架对每个filter的执行结果都没有太多的处理，它没有把上一filter的执行结果交由下一个将要执行的filter，仅仅是记录执行状态，如果执行失败抛出异常并终止执行。
三 实战
1 引入依赖
2 配置application.yml
3 在启动类上添加@EnableZuulProxy注解来启用Zuul的API网关功能
4 启动相关服务
通过启动eureka-server，两个user-service，feign-service和zuul-proxy来演示Zuul的常用功能，启动后注册中心显示如下。
5 配置规则路径
a 自定义路由配置
将匹配/userService/**的请求路由到user-service服务上去，匹配/feignService/**的请求路由到feign-service上去。
- 访问http://localhost:8801/userService/user/1路由到 userService
- 访问http://localhost:8801/feignService/user/1陆游到 feignService
b 默认路由规则
Zuul和Eureka结合使用，可以实现路由的自动配置，自动配置的路由以服务名称为匹配路径，相当于如下配置：
- 访问http://localhost:8801/user-service/user/1同样可以路由到了user-service上了；
- 访问http://localhost:8801/feign-service/user/1同样可以路由到了feign-service上了。
如果不想使用默认的路由规则，可以添加以下配置来忽略默认路由配置：
6 负载均衡功能
多次调用http://localhost:8801/user-service/user/1进行测试，可以发现运行在8201和8202的user-service服务交替打印如下信息。
7 配置访问前缀
通过以下配置来给网关路径添加前缀，此处添加了/proxy前缀，这样我们需要访问http://localhost:8801/proxy/user-service/user/1才能访问到user-service中的接口。
8 Header过滤及重定向添加Host
- Zuul在请求路由时，默认会过滤掉一些敏感的头信息，以下配置可以防止路由时的Cookie及Authorization的丢失：
- Zuul在请求路由时，不会设置最初的host头信息，以下配置可以解决：
9 查看路由信息
我们可以通过SpringBoot Actuator来查看Zuul中的路由信息。
a 在pom.xml中添加相关依赖：
b 修改application.yaml配置文件，开启查看路由的端点：
c 查看简单路由信息：
通过访问http://localhost:8801/actuator/routes查看简单路由信息：
d 查看详细路由信息：
通过访问http://localhost:8801/actuator/routes/details查看详细路由信息：
10 过滤器
- 路由与过滤是Zuul的两大核心功能，
- 路由功能负责将外部请求转发到具体的服务实例上去，是实现统一访问入口的基础，
- 过滤功能负责对请求过程进行额外的处理，是请求校验过滤及服务聚合的基础。
a 过滤器类型
Zuul中有以下几种典型的过滤器类型。
- pre：在请求被路由到目标服务前执行，比如权限校验、打印日志等功能；
- routing：在请求被路由到目标服务时执行，这是使用Apache HttpClient或Netflix Ribbon构建和发送原始HTTP请求的地方；
- post：在请求被路由到目标服务后执行，比如给目标服务的响应添加头信息，收集统计数据等功能；
- error：请求在其他阶段发生错误时执行。
b 过滤器的生命周期
下图描述了一个HTTP请求到达API网关后，如何在各种不同类型的过滤器中流转的过程。
c 自定义过滤器
c-1 添加PreLogFilter类继承ZuulFilter
这是一个前置过滤器，用于在请求路由到目标服务前打印请求日志。
c-2 开启过滤器
添加过滤器后，我们访问http://localhost:8801/user-service/user/1测试下，会打印如下日志。
c-3 禁用过滤器
c-4 核心过滤器
11 Ribbon和Hystrix的支持
由于Zuul自动集成了Ribbon和Hystrix，所以Zuul天生就有负载均衡和服务容错能力，我们可以通过Ribbon和Hystrix的配置来配置Zuul中的相应功能。
- 可以使用Hystrix的配置来设置路由转发时HystrixCommand的执行超时时间：
- 可以使用Ribbon的配置来设置路由转发时请求连接及处理的超时时间：
12 常用配置
使用到的模块
项目源码地址
https://gitee.com/pingfanrenbiji/springcloud-learning
参考文章
https://mp.weixin.qq.com/s/ttL5gm_ZLAQL_uJ4iNtqsQ
