SpringCloud入门学习笔记5--微服务网关Zuul

一、Zuul简介

1.1 Zuul是Netflix开源的微服务网关，他可以和Eureka,Ribbon,Hystrix等组件配合使用。Zuul组件的核心是一系列的过滤器，这些过滤器可以完成以下功能：
# 身份认证和安全：识别每一个资源的验证要求，并拒绝那些不符的请求
# 审查与监控：在服务边界追踪并统计数据，提供精确的生产视图
# 动态路由：动态将请求路由到不同后端集群
# 压力测试：逐渐增加指向集群的流量，以了解性能
# 负载分配：为每一种负载类型分配对应容量，并弃用超出限定值的请求
# 静态响应处理：边缘位置进行响应，避免转发到内部集群
# 多区域弹性：跨域AWS Region进行请求路由，旨在实现ELB(ElasticLoad Balancing)使用多样化
Spring Cloud对Zuul进行了整合和增强。
使用Zuul后，架构图演变为以下形式：

1.2 为什么需要微服务网关

不同的微服务一般有不同的网络地址，而外部的客户端可能需要调用多个服务的接口才
能完成一个业务需求。比如一个电影购票的收集APP,可能回调用电影分类微服务，用户
微服务，支付微服务等。如果客户端直接和微服务进行通信，会存在一下问题：
# 客户端会多次请求不同微服务，增加客户端的复杂性
# 存在跨域请求，在一定场景下处理相对复杂
# 认证复杂，每一个服务都需要独立认证
# 难以重构，随着项目的迭代，可能需要重新划分微服务，如果客户端直接和微服务通信，那么重构会难以实施
# 某些微服务可能使用了其他协议，直接访问有一定困难
上述问题，都可以借助微服务网关解决。微服务网关是介于客户端和服务器端之间的中间层，所有的外部请求都会先经过微服务网关。

二、Zuul路由转发实现

（1）右键点击父工程>new>module创建demo_zuul模块

（2）pom.xml添加依赖

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
    </dependencies>

 （3）创建application.yml

server:
  port: 9004
spring:
  application:
    name: demo-zuul
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:8888/eureka #Eureka客户端与Eureka服务端进行交互的地址
  instance:
    prefer-ip-address: true
zuul:
  routes:
    demo-base:
      path: /service/** #凡是类似../service/**这样的请求都会被转发到demo-service来进行处理
      serviceId: demo-service #指定Eureka注册中心中的服务id   
      
      #其他服务也是通过这样的方式配置进来

（4）编写启动类 ZuulApplication，添加注解 @EnableZuulProxy

（5） 先启动 demo_eureka，再启动 demo_ribbon_service，我们先测试直接访问demo_ribbon_service的情况。启动完成，Eureka界面目前只有demo_ribbon_service这个服务

浏览器输入  http://localhost:9003/test?param=111,访问成功，返回结果如下

 （6）接下来我测试通过zuul网关转发路由去访问demo_ribbon_service服务：

启动 demo_zuul，将服务注册到Eureka

修改之前访问链接的端口为zuul的端口 9004，并加上匹配规则  service

浏览器访问链接：http://localhost:9004/service/test?param=222，返回结果如下，路由转发成功

 

三、 Zuul过滤器实现

（1）zuul包下新建包 filter，编写 Filter类，注意：需要继承 ZuulFilter类

package zuul.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.springframework.stereotype.Component;

@Component
public class Filter extends ZuulFilter {
    /**
     * 在请求前或者请求后执行  pre  psot
     * @return
     */
    @Override
    public String filterType() {
        return "pre";// 前置过滤器 请求前执行
    }

    /**
     * 过滤器执行的优先级 数字越小，优先级越高
     * @return
     */
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     * 是否开启过滤器
     * @return
     */
    @Override
    public boolean shouldFilter() {
        return true;// 此处为true，说明需要过滤;
    }

    /**
     * 过滤器执行的操作 return null 表示过滤完成后继续执行后续操作 放行
     * setSendZuulResponse(false) 则会终止运行 不对其进行路由
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {
        System.out.println("经过zuul过滤器了...");
        return null;
    }
}

filterType：返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：
pre ：可以在请求被路由之前调用
route ：在路由请求时候被调用
post ：在route和error过滤器之后被调用
error ：处理请求时发生错误时被调用
filterOrder ：通过int值来定义过滤器的执行顺序
shouldFilter ：返回一个boolean类型来判断该过滤器是否要执行，所以通过此函数可实现过滤器的开关。在上例中，我们直接返回true，所以该过滤器总是生效 

（2）测试 在请求前执行 zuul过滤器

重启demo_zuul，浏览器重新访问 http://localhost:9004/service/test?param=222

后台打印出我们之前编写的内容，说明zuul过滤器触发成功。到实际应用中，我们可以通过该过滤能做很多操作，比如权限验证，token获取等等

（3）接下来我们测试请求经过zuul过滤器不被放行的情况（setSendZuulResponse(false) 则会终止运行 不对其进行路由

）

修改之前的run()方法：

public Object run() throws ZuulException {
        System.out.println("经过zuul过滤器了...");
        RequestContext requestContext = RequestContext.getCurrentContext();
        requestContext.setSendZuulResponse(false);//终止运行，不对其进行路由
        requestContext.setResponseStatusCode(403);
        requestContext.setResponseBody("验证不通过，不允许进行后续操作");
        requestContext.getResponse().setContentType("text/html;charset=UTF-8");
        return null;
    }

重启服务，再次访问 http://localhost:9004/service/test?param=222

后台日志打印：

前端页面返回结果如下：

请求经过zuul过滤器后直接被拦截了，没有被转发到demo_ribbon_service服务。

下一篇：集中配置组件SpringCloudConfig