SpringCloud中Zuul网关原理及其配置,看它就够了
!
网关有以下几个作用:
统一入口:未全部为服务提供一个唯一的入口,网关起到外部和内部隔
离的作用,保障了后台服务的安全性。
鉴权校验:识别每个请求的权限,拒绝不符合要求的请求。
动态路由:动态的将请求路由到不同的后端集群中。
减少客户端与服务端的耦合:服务可以独立发展,通过网关层来做映射
。
二、Zuul网关的应用
1、网关访问方式
通过zuul访问服务的,URL地址默认格式为:http://zuulHostIp:port/要
访问的服务名称/服务中的URL
服务名称:properties配置文件中的spring.application.name。
服务的URL:就是对应的服务对外提供的URL路径监听。
2、网关依赖注入
<!-- spring cloud Eureka Client 启动器 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-zuul</artifactId>
</dependency>
<!-- zuul网关的重试机制,不是使用ribbon内置的重试机制
是借助spring-retry组件实现的重试
开启zuul网关重试机制需要增加下述依赖
-->
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
</dependency>
3、网关启动器
/**
* @EnableZuulProxy - 开启Zuul网关。
* 当前应用是一个Zuul微服务网关。会在Eureka注册中心中注册当前服务。并发现其他的服务
。
* Zuul需要的必要依赖是spring-cloud-starter-zuul。
*/
@SpringBootApplication
@EnableZuulProxy
public class ZuulApplication {
public static void main(String[] args) {
SpringApplication.run(ZuulApplication.class, args);
}
}
4、网关全局变量配置
4.1 URL路径匹配
# URL pattern
# 使用路径方式匹配路由规则。
# 参数key结构:zuul.routes.customName.path=xxx
# 用于配置路径匹配规则。
# 其中customName自定义。通常使用要调用的服务名称,方便后期管理
# 可使用的通配符有: * ** ?
# ? 单个字符
# * 任意多个字符,不包含多级路径
# ** 任意多个字符,包含多级路径
zuul.routes.eureka-application-service.path=/api/**
# 参数key结构:zuul.routes.customName.url=xxx
# url用于配置符合path的请求路径路由到的服务地址。
zuul.routes.eureka-application-service.url=http://127.0.0.1:8080/
4.2 服务名称匹配
# service id pattern 通过服务名称路由
# key结构 :zuul.routes.customName.path=xxx
# 路径匹配规则
zuul.routes.eureka-application-service.path=/api/**
# key结构 :zuul.routes.customName.serviceId=xxx
# serviceId用于配置符合path的请求路径路由到的服务名称。
zuul.routes.eureka-application-service.serviceId=eureka-application-service
服务名称匹配也可以使用简化的配置:
# simple service id pattern 简化配置方案
# 如果只配置path,不配置serviceId。则customName相当于服务名称。
# 符合path的请求路径直接路由到customName对应的服务上。
zuul.routes.eureka-application-service.path=/api/**
4.3 路由排除配置
# ignored service id pattern
# 配置不被zuul管理的服务列表。多个服务名称使用逗号','分隔。
# 配置的服务将不被zuul代理。
zuul.ignored-services=eureka-application-service
# 此方式相当于给所有新发现的服务默认排除zuul网关访问方式,只有配置了路由网关的服务才
可以通过zuul网关访问
# 通配方式配置排除列表。
zuul.ignored-services=*
# 使用服务名称匹配规则配置路由列表,相当于只对已配置的服务提供网关代理。
zuul.routes.eureka-application-service.path=/api/**
# 通配方式配置排除网关代理路径。所有符合ignored-
patterns的请求路径都不被zuul网关代理。
zuul.ignored-patterns=/**/test/**
zuul.routes.eureka-application-service.path=/api/**
4.4 路由前缀配置
# prefix URL pattern 前缀路由匹配
# 配置请求路径前缀,所有基于此前缀的请求都由zuul网关提供代理。
zuul.prefix=/api
# 使用服务名称匹配方式配置请求路径规则。
# 这里的配置将为:http://ip:port/api/appservice/**的请求提供zuul网关代理,可以将
要访问服务进行前缀分类。
# 并将请求路由到服务eureka-application-service中。
zuul.routes.eureka-application-service.path=/appservice/**
5 Zuul网关配置总结
网关配置方式有多种,默认、URL、服务名称、排除|忽略、前缀。
网关配置没有优劣好坏,应该在不同的情况下选择合适的配置方案。扩展
:大公司为什么都有API网关?聊聊API网关的作用
zuul网关其底层使用ribbon来实现请求的路由,并内置Hystrix,可选择性
提供网关fallback逻辑。使用zuul的时候,并不推荐使用Feign作为applic
ation
client端的开发实现。毕竟Feign技术是对ribbon的再封装,使用Feign本
身会提高通讯消耗,降低通讯效率,只在服务相互调用的时候使用Feign来
简化代码开发就够了。而且商业开发中,使用Ribbon+RestTemplate来
开发的比例更高。
三、Zuul网关过滤器
Zuul中提供了过滤器定义,可以用来过滤代理请求,提供额外功能逻辑。
如:权限验证,日志记录等。
Zuul提供的过滤器是一个父类。父类是ZuulFilter。通过父类中定义的抽象
方法filterType,来决定当前的Filter种类是什么。有前置过滤、路由后过
滤、后置过滤、异常过滤。
前置过滤:是请求进入Zuul之后,立刻执行的过滤逻辑。
路由后过滤:是请求进入Zuul之后,并Zuul实现了请求路由后执行的过
滤逻辑,路由后过滤,是在远程服务调用之前过滤的逻辑。
后置过滤:远程服务调用结束后执行的过滤逻辑。
异常过滤:是任意一个过滤器发生异常或远程服务调用无结果反馈的时
候执行的过滤逻辑。无结果反馈,就是远程服务调用超时。
3.1 过滤器实现方式
继承父类ZuulFilter。在父类中提供了4个抽象方法,分别是:filterType,
filterOrder, shouldFilter, run。其功能分别是:
filterType:方法返回字符串数据,代表当前过滤器的类型。可选值有-
pre, route, post, error。
pre -
前置过滤器,在请求被路由前执行,通常用于处理身份认证,日志记录
等;
route - 在路由执行后,服务调用前被调用;
error -
任意一个filter发生异常的时候执行或远程服务调用没有反馈的时候执行
(超时),通常用于处理异常;
post -
在route或error执行后被调用,一般用于收集服务信息,统计服务性能
指标等,也可以对response结果做特殊处理。