Zuul已过时,详细看Xmind,或者参考十三、GateWay———新一代网关

1. 简介

网关的作用相当于一个过滤器、拦截器,它可以拦截多个系统的请求。

1.1 什么是Zuul?

Spring Cloud Zuul是整合Netflix公司的Zuul开源项目实现的微服务网关,它实现了请求路由、负载均衡、校验过滤等功能。

1.2 什么是服务网关?

服务网关是在微服务前边设置一道屏障,请求先到服务网关,网关会对请求进行过滤、校验、路由等处理。有了服务网关可以提高微服务的安全性,网关校验请求的合法性,请求不合法将被拦截,拒绝访问。

1.3 Zuul与Nginx怎么配合使用?

Zuul与Nginx在实际项目中需要配合使用,如下图,Nginx的作用是反向代理、负载均衡,Zuul的作用是保障微服务的安全访问,拦截微服务请求,校验合法性及负载均衡。
Zuul与Nginx结合使用.png

2. 原理

Zuul网关具有代理的功能,根据请求的url路由转发到微服务,如下图: Zuul原理.png 客户端请求网关/api/learning,通过路由转发到/learning 客户端请求网关/api/course,通过路由转发到/course

3. 配置

3.1@EnableZuulProxy

在启动类上使用此注解标识此工程为Zuul网关

3.2 application.yml

  1. zuul:
  2. routes:
  3. managecourse: #路由名称,名称任意,保持所有路由名称唯一
  4. path: /course/**
  5. serviceId: xcservicemanagecourse #指定服务id,从Eureka中找到服务的ip和端口
  6. #url: http://localhost:31200 #也可指定url
  7. stripprefix: false #true:代理转发时去掉前缀,false:代理转发时不去掉前缀
  8. sensitiveHeaders: #默认zuul会屏蔽cookie,cookie不会传到下游服务,这里设置为空则取消默认的黑名单,如果设置了具体的头信息则不会传到下游服务
  9. # ignoredHeaders: Authorization

serviceId :推荐使用serviceId,zuul会从Eureka中找到服务id对应的ip和端口。
strip-prefix : false #true:代理转发时去掉前缀,false:代理转发时不去掉前缀,例如,为true请求 /course/coursebase/get/..,代理转发到/coursebase/get/,如果为false则代理转发到/course/coursebase/get
sensitiveHeaders :敏感头设置,默认会过滤掉cookie,这里设置为空表示不过滤
ignoredHeaders :可以设置过滤的头信息,默认为空表示不过滤任何头

4. ZuulFilter

Zuul的核心就是过滤器,通过过滤器实现请求过滤,身份校验等

自定义过滤器需要继承 ZuulFilter,ZuulFilter是一个抽象类,需要覆盖它的四个方法,如下:
  • shouldFilter :返回一个Boolean值,判断该过滤器是否需要执行。返回true表示要执行此过滤器,否则不执行。
  • run :过滤器的业务逻辑。
  • filterType :返回字符串代表过滤器的类型,如下 pre:请求在被路由之前执行 routing:在路由请求时调用 post:在routing和errror过滤器之后调用 error:处理请求时发生错误调用
  • filterOrder :此方法返回整型数值,通过此数值来定义过滤器的执行顺序,数字越小优先级越高。