公司目前使用的是dubbo方式实现微服务,想试水改造接口层服务为Spring Cloud, 以下是网络拓补图。

第一层负载均衡可以用nginx或者zuul(即有2层zuul), 本图画的是nginx。

SpringCloud学习笔记-zuul网关-LMLPHP

Zuul的作用就是路由转发和过滤, 即将请求转发到微服务或拦截请求; Zuul默认集成了负载均衡功能。

下面创建一个zuul工程:

打开IntelliJ Idea ---> New Project ---> 选择Spring Initializr ---> 设置包名 ---> 勾选web、zuul、Eureka Discovery -> 设置存储路径。

一、 路由:

在入口类添加注解@EnableZuulProxy, 即打开zuul功能;


  1. @SpringBootApplication
  2. @EnableEurekaClient
  3. @EnableZuulProxy
  4. public class SpringZuulDemoApplication {
  5. public static void main(String[] args) {
  6. SpringApplication.run(SpringZuulDemoApplication.class, args);
  7. }
  8. }

修改配置文件, 指定注册中心地址和路由规则zuul.routes, 建议使用微服务名称命名子节点。

SpringCloud学习笔记-zuul网关-LMLPHP

启动Eureka注册中心、service-hello1、service-ribbon-consumer1和当前服务。

SpringCloud学习笔记-zuul网关-LMLPHP

在浏览器输入:http://localhost:13000/servicehello1/hello?param=“test”

SpringCloud学习笔记-zuul网关-LMLPHP

以/servicehello1/开头的请求会被转发到service-hello1服务, 以/consumer1/开头的请求会被转发到service-ribbon-consumer1服务。 PS: 如果是集群服务, 那么会转发到不同的ip/port。

http://localhost:13000/servicehello1/hello?param=“test”最终会执行doHello函数。


  1. @RestController(value = "/servicehello1")
  2. public class ZuulTestController {
  3. @Value("${server.port}")
  4. String port; //在application.yml文件里赋的值
  5. @RequestMapping("helloworld")
  6. public String doHello(@RequestParam String param) {
  7. return "servicehello1! " + param + ":" + "port is " + port;
  8. }
  9. }

二、过滤,  zuul可以实现验签功能和自定义过滤功能, 功能跟SpringMVC的拦截器一样。

在zuuldemo工程里新建一个Java类, PS:可以定义多个过滤类,设置不同的filterOrder(即执行时序), 基类都是ZuulFilter;

下面定义2个拦截器类, filterOrder值为0和1。


  1. public class DemoFilter extends ZuulFilter {
  2. private static Logger logger = LoggerFactory.getLogger(DemoFilter.class);
  3. @Override
  4. public String filterType() {
  5. return "pre"; //枚举值:pre, routing, post, error
  6. }
  7. @Override
  8. public int filterOrder() {
  9. return 1; //优先级, 0是最高优先级即最先执行
  10. }
  11. @Override
  12. public boolean shouldFilter() {
  13. return true; //写逻辑,是否需要执行过滤。true会执行run函数,false不执行run函数
  14. }
  15. @Override
  16. public Object run() {
  17. logger.info("----------------this is DemoFilter----------");
  18. RequestContext ctx = RequestContext.getCurrentContext();
  19. HttpServletRequest request = ctx.getRequest();
  20. logger.info(String.format("%s %s", request.getMethod(), request.getRequestURL().toString()));
  21. Object accessToken = request.getParameter("token");
  22. if(accessToken == null) { //判断释放有token自动
  23. logger.warn("token is empty");
  24. ctx.setSendZuulResponse(false);
  25. ctx.setResponseStatusCode(401);
  26. try {
  27. ctx.getResponse().getWriter().write("token is empty");
  28. }catch (Exception e){}
  29. return null;
  30. }
  31. return null;
  32. }
  33. }


  1. @Component
  2. public class Demo1Filter extends ZuulFilter{
  3. private static Logger logger = LoggerFactory.getLogger(DemoFilter.class);
  4. @Override
  5. public String filterType() {
  6. return "pre"; //枚举值:pre, routing, post, error
  7. }
  8. @Override
  9. public int filterOrder() {
  10. return 0; //优先级, 0是最高优先级即最先执行
  11. }
  12. @Override
  13. public boolean shouldFilter() {
  14. return true; //写逻辑,是否需要执行过滤。true会执行run函数,false不执行run函数
  15. }
  16. @Override
  17. public Object run() {
  18. logger.info("----------------this is Demo1Filter----------");
  19. return null;
  20. }
  21. }

filterType:表示过滤类型。 pre表示路由之前, routing表示路由当中, post表示路由之后, error表示路由发生错误。

filterOrder: 执行时序, 值是0,1,2....N等自然数。 0的优先级最高,即最先执行。

shouldFilter: 是否需要执行run函数。

run:拦截器的具体实现;

在浏览器输入: localhost:13000/servicehello1/hello?param="test"会显示拦截器的返回值, 即请求被成功拦截。


  1. 2017-11-28 13:04:07.837 INFO 28824 --- [trap-executor-0] c.n.d.s.r.aws.ConfigClusterResolver : Resolving eureka endpoints via configuration
  2. 2017-11-28 13:05:31.720 INFO 28824 --- [io-13000-exec-3] com.example.springzuuldemo.DemoFilter : ----------------this is Demo1Filter----------
  3. 2017-11-28 13:05:31.720 INFO 28824 --- [io-13000-exec-3] com.example.springzuuldemo.DemoFilter : ----------------this is DemoFilter----------
  4. 2017-11-28 13:05:31.720 INFO 28824 --- [io-13000-exec-3] com.example.springzuuldemo.DemoFilter : GET http://localhost:13000/servicehello1/hello
  5. 2017-11-28 13:05:31.761 INFO 28824 --- [io-13000-exec-3] s.c.a.AnnotationConfigApplicationContext : Refreshing

SpringCloud学习笔记-zuul网关-LMLPHP

在浏览器输入: localhost:13000/servicehello1/hello?param="test"&param="123" , 即符合拦截器规则后执行了service-hello1服务的hello接口。

          SpringCloud学习笔记-zuul网关-LMLPHP

综上, zuul包装了微服务, 微服务对调用者是透明的, 即调用者不知道访问了哪个微服务。 zuul可以理解为路由器和过滤器的综合体。

参考代码:http://download.csdn.net/download/brycegao321/10138936

05-14 09:05