前面我们依次学习了 Eureka、Ribbon、Feign、Hystrix、Hystrix Dashboard、Turbine 等。可以说一些主要的组件我们都已经学完了,现在我们想一想前面学习的组件,你绝对还缺些什么?或者说架构是否已经完美无缺了?答案当然是否定的。那么还缺些什么呢?且看本系列教程一一的给你讲解。
回顾前面的内容,你会发现“我们所有的消费者服务都是直接去调用提供者的服务的”。这样会发生任何在 Eureka 中注册了的服务,都可以互相调用。不需要请求我的,也可以来访问我,那么对安全就会产生一定的影响,我现在需要对每个访问我的服务做一个权限控制。Spring Cloud 的 zuul 组件就可以派上用场了,Zuul 是 Netflix 开源的微服务网关,他可以和 Eureka,Ribbon,Hystrix 等组件配合使用。Zuul 组件的核心是一系列的过滤器,这些过滤器可以完成以下功能:
- 身份认证和安全: 识别每一个资源的验证要求,并拒绝那些不符的请求
- 审查与监控:
- 动态路由:动态将请求路由到不同后端集群
- 压力测试:逐渐增加指向集群的流量,以了解性能
- 负载分配:为每一种负载类型分配对应容量,并弃用超出限定值的请求
- 静态响应处理:边缘位置进行响应,避免转发到内部集群
- 多区域弹性:跨域AWS Region进行请求路由,旨在实现ELB(ElasticLoad Balancing)使用多样化
看到 zuul 有这么多的好处,你是不是非常的期待了。下面我们一起开始 zuul 组件的学习吧。
首先,我们还是新建一个工程 xttblog-cloud-zuul。pom.xml 的配置如下:
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.13.RELEASE</version> </parent> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Edgware.SR4</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-eureka-server</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-zuul</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies>
然后是 application.yml 配置文件内容:
server: port: 8765 eureka: instance: hostname: localhost client: serviceUrl: defaultZone: http://${eureka.instance.hostname}:8761/eureka/ spring: application: name: xttblog-cloud-zuul
启动类,我们需要配置上 @EnableZuulProxy 注解:
@SpringBootApplication @EnableZuulProxy public class ZuulApplication { public static void main(String[] args) { SpringApplication.run(ZuulApplication.class, args); } }
主要代码已经写完了,然后我们依次启动各个工程:xttblog-eureka-server、xttblog-cloud-producer、xttblog-cloud-consumer、xttblog-cloud-zuul。然后在浏览器中访问 http://localhost:8765/xttblog-cloud-consumer/test/radd?a=44&b=88,即可访问到 xttblog-cloud-consumer。
application.yml 配置文件中可以做一下变更:
zuul.routes.baidu.path=/cal/** zuul.routes.baidu.url=http://localhost:7777/
http://localhost:8765/cal/* 都会被路由到 http://localhost:7777/ 服务上。
一开始我们没有配置 zuul 组件的路由规则,它默认的是根据微服务的名字来路由的。因为 zuul 注册到了 Eureka,它能获取到所有的服务列表,就能接管整个路由。
实际在生产中也是这样做的,我们的微服务成千上百个,不可能每个都给配置一下路由。
网关的默认路由规则
Spring Cloud Zuul已经帮我们做了默认配置。默认情况下,Zuul 会代理所有注册到 Eureka Server 的微服务,并且 Zuul 的路由规则如下:http://ZUUL_HOST:ZUUL_PORT/ 微服务在 Eureka 上的 serviceId/** 会被转发到 serviceId 对应的微服务。
zuul 还有很多高级用法,比如借助 PatternServiceRouteMapper 实现从微服务到映射路由的正则配置:
@Bean publicPatternServiceRouteMapper serviceRouteMapper(){ // servicePattern: 指的是微服务的pattern // routePattern: 指的是路由的pattern // 当你访问/xttblog/v1 其实就是 // localhost:8040/v1/xttblog/page/1 return newPatternServiceRouteMapper( "(?<name>^.+)-(?<version>v.+$)","${version}/${name}" ); }
Zuul 的核心
Filter 是 Zuul 的核心,用来实现对外服务的控制。Filter 的生命周期有4个,分别是“PRE”、“ROUTING”、“POST”、“ERROR”。
Zuul大部分功能都是通过过滤器来实现的,这些过滤器类型对应于请求的典型生命周期。
- PRE: 这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
- ROUTING:这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求,并使用Apache HttpClient或Netfilx Ribbon请求微服务。
- POST:这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。
- ERROR:在其他阶段发生错误时执行该过滤器。 除了默认的过滤器类型,Zuul还允许我们创建自定义的过滤器类型。例如,我们可以定制一种STATIC类型的过滤器,直接在Zuul中生成响应,而不将请求转发到后端的微服务。
Zuul 中默认实现的 Filter
类型 | 顺序 | 过滤器 | 功能 |
---|---|---|---|
pre | -3 | ServletDetectionFilter | 标记处理Servlet的类型 |
pre | -2 | Servlet30WrapperFilter | 包装HttpServletRequest请求 |
pre | -1 | FormBodyWrapperFilter | 包装请求体 |
route | 1 | DebugFilter | 标记调试标志 |
route | 5 | PreDecorationFilter | 处理请求上下文供后续使用 |
route | 10 | RibbonRoutingFilter | serviceId请求转发 |
route | 100 | SimpleHostRoutingFilter | url请求转发 |
route | 500 | SendForwardFilter | forward请求转发 |
post | 0 | SendErrorFilter | 处理有错误的请求响应 |
post | 1000 | SendResponseFilter | 处理正常的请求响应 |
zuul 默认实现的 filter 我们也可以进行禁用:
zuul: FormBodyWrapperFilter: pre: disable: true
如果我们要进行权限验证,就可以实现自己的 Filter。
public class XttblogTokenFilter extends ZuulFilter { private final Logger logger = LoggerFactory.getLogger(XttblogTokenFilter.class); @Override public String filterType() { return "pre"; // 可以在请求被路由之前调用 } @Override public int filterOrder() { return 0; // filter执行顺序,通过数字指定 ,优先级为0,数字越大,优先级越低 } @Override public boolean shouldFilter() { return true;// 是否执行该过滤器,此处为true,说明需要过滤 } @Override public Object run() { RequestContext ctx = RequestContext.getCurrentContext(); HttpServletRequest request = ctx.getRequest(); logger.info("--->>> TokenFilter {},{}", request.getMethod(), request.getRequestURL().toString()); String token = request.getParameter("token");// 获取请求的参数 if (StringUtils.isNotBlank(token)) { ctx.setSendZuulResponse(true); //对请求进行路由 ctx.setResponseStatusCode(200); ctx.set("isSuccess", true); return null; } else { ctx.setSendZuulResponse(false); //不对其进行路由 ctx.setResponseStatusCode(400); ctx.setResponseBody("token is not empty"); ctx.set("isSuccess", false); return null; } } }
再将 XttblogTokenFilter 加入到请求拦截队列,在启动类中添加以下代码:
@Bean public XttblogTokenFilter xttblogTokenFilter() { return new XttblogTokenFilter(); }
然后,我们再访问 http://localhost:8765/xttblog-cloud-consumer/test/radd?a=44&b=88&token=xttblog 就必须要带 token 了,不带 token,就会被拦截,返回被拦截后的结果。
本文源代码已共享至:https://github.com/xmt1139057136/xttblog-cloud
: » Spring Cloud 教程第十二章 zuul(API服务网关)使用教程
原创文章,作者:3628473679,如若转载,请注明出处:https://blog.ytso.com/tech/java/251833.html