（十五）SpringCloud学习笔记之微服务网关Zuul

淩亂°似流年 2023-07-22 03:50 27阅读 0赞

### 微服务网关Zuul ###

*  1 Zuul简介
 *  2 搭建Zuul网关服务器
 *  3 Zuul中的路由转发
 *   *  3.1 面向服务的路由
     *  3.2 简化的路由配置
     *  3.3 默认的路由规则
 *  4 Zuul中的过滤器
 *   *  4.1 ZuulFilter简介
     *  4.2 生命周期
     *  4.3 自定义过滤器
 *  5 Zuul网关存在的问题
 *  6 Zuul网关的替换方案

# 1 Zuul简介 #

ZUUL是Netflix开源的微服务网关，它可以和Eureka、Ribbon、Hystrix等组件配合使用，Zuul组件的核心是一系列的过滤器，这些过滤器可以完成以下功能：

*  动态路由：动态将请求路由到不同后端集群
 *  压力测试：逐渐增加指向集群的流量，以了解性能
 *  负载分配：为每一种负载类型分配对应容量，并弃用超出限定值的请求
 *  静态响应处理：边缘位置进行响应，避免转发到内部集群
 *  身份认证和安全: 识别每一个资源的验证要求，并拒绝那些不符的请求。  
    Spring Cloud对Zuul进行了整合和增强。

# 2 搭建Zuul网关服务器 #

**（1）创建工程导入依赖**  
在IDEA中创建ZUUL网关工程api\_ zuul\_server ，并添加相关依赖

<dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
         <version>2.1.0.RELEASE</version>
    </dependency>

**（2）编写启动类**  
创建启动类 ZuulServerApplication

@EnableZuulProxy //开启Zuul的网关功能
    @SpringBootApplication
    public class ZuulSeverApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(ZuulSeverApplication.class,args);
        }
    }

**（3）编写配置**  
创建配置文件 application.yml ，并添加相应配置

server:
      port: 8080
    spring:
      application:
        name: api-zuul-server
    zuul:
      routes:
        product-service: # 路由id随意写
          path: /product-service/** # 这里是映射路径
          url: http://127.0.0.1:9011 # 映射路径对应的实际url地址

（4） 测试，在浏览器中输入 http://localhost:8080/product- service/product/1 ，即可访问到订单微服务。

# 3 Zuul中的路由转发 #

最直观的理解：“路由”是指根据请求URL，将请求分配到对应的处理程序。在微服务体系中，Zuul负责接收所有的请求。根据不同的URL匹配规则，将不同的请求转发到不同的微服务处理。

## 3.1 面向服务的路由 ##

**（1）添加Eureka客户端依赖**

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

**（2）开启Eureka客户端发现功能**

@EnableDiscoveryClient //开启Eureka客户端发现功能
    @EnableZuulProxy //开启Zuul的网关功能
    @SpringBootApplication
    public class ZuulSeverApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(ZuulSeverApplication.class,args);
        }
    }

**（3）添加Eureka配置，获取服务信息**

eureka:
      client:
        register-with-eureka: true
        fetch-registry: true
        service-url:
          defaultZone: http://127.0.0.1:9000/eureka/
      instance:
        prefer-ip-address: true

（4）修改映射配置，通过服务名称获取

zuul:
      routes:
        product-service: # 路由id随意写
          path: /product-service/** # 这里是映射路径
    # url: http://127.0.0.1:9011 # 映射路径对应的实际url地址
          serviceId: product-service # 需要转发的服务名称

## 3.2 简化的路由配置 ##

zuul:
      routes:
    # product-service: # 路由id随意写
    # path: /product-service/** # 这里是映射路径
    ## url: http://127.0.0.1:9011 # 映射路径对应的实际url地址
    # serviceId: product-service # 需要转发的服务名称
        product-service: /product-service/** # 当路由id 与 服务名称 相同时，可简写为

## 3.3 默认的路由规则 ##

在使用Zuul的过程中，上面讲述的规则已经大大的简化了配置项。但是当服务较多时，配置也是比较繁琐的。因此Zuul就指定了默认的路由规则：

*  默认情况下，一切服务的映射路径就是服务名本身,无需配置。  
    例如服务名为： service-product ，则默认的映射路径就是： /service-product/\*\*

# 4 Zuul中的过滤器 #

## 4.1 ZuulFilter简介 ##

Zuul 中的过滤器跟我们之前使用的 javax.servlet.Filter 不一样，javax.servlet.Filter 只有一种类型，可以通过配置 urlPatterns 来拦截对应的请求。而 Zuul 中的过滤器总共有 4 种类型，且每种类型都有对应的使用场景。

1.  PRE：这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
2.  ROUTING：这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求，并使用Apache HttpClient或Netfilx Ribbon请求微服务。
3.  POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTPHeader、收集统计信息和指标、将响应从微服务发送给客户端等。
4.  ERROR：在其他阶段发生错误时执行该过滤器。

Zuul提供了自定义过滤器的功能实现起来也十分简单，只需要编写一个类去实现zuul提供的接口

public class LoginFilter extends ZuulFilter {

## 4.2 生命周期 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU5NjkwNQ_size_16_color_FFFFFF_t_70]

## 4.3 自定义过滤器 ##

接下来我们来自定义一个过滤器，模拟一个登录的校验。基本逻辑：如果请求中有access-token参数，则认为请求有效，放行。

/** * 自定义的zuul过滤器 * 继承抽象父类 */
    @Component
    public class LoginFilter extends ZuulFilter { 
    
        /** * 定义过滤器类型 * pre * routing * post * error */
        public String filterType() { 
            return "pre";
        }
    
    
        /** * 指定过滤器的执行顺序 * 返回值越小,执行顺序越高 */
        public int filterOrder() { 
            return 1;
        }
    
    
        /** * 当前过滤器是否生效 * true : 使用此过滤器 * flase : 不使用此过滤器 */
        public boolean shouldFilter() { 
            return true;
        }
    
    
        /** * 指定过滤器中的业务逻辑 * 身份认证: * 1.所有的请求需要携带一个参数 : access-token * 2.获取request请求 * 3.通过request获取参数access-token * 4.判断token是否为空 * 4.1 token==null : 身份验证失败 * 4.2 token!=null : 执行后续操作 * 在zuul网关中,通过RequestContext的上下问对象,可以获取对象request对象 */
        public Object run() throws ZuulException { 
            //System.out.println("执行了过滤器");
            //1.获取zuul提供的上下文对象RequestContext
            RequestContext ctx = RequestContext.getCurrentContext();
            //2.从RequestContext中获取request
            HttpServletRequest request = ctx.getRequest();
            //3.获取请求参数access-token
            String token = request.getParameter("access-token");
            //4.判断
            if (token ==null) { 
                //4.1 如果token==null ,拦截请求,返回认证失败
                ctx.setSendZuulResponse(false); // 拦截请求
                ctx.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
            }
            //4.2 如果token!=null ,继续后续操作
            return null;
        }
    }

*  RequestContext：用于在过滤器之间传递消息。它的数据保存在每个请求的ThreadLocal中。它用于存储请求路由到哪里、错误、HttpServletRequest、HttpServletResponse都存储在RequestContext中。RequestContext扩展了ConcurrentHashMap，所以，任何数据都可以存储在上下文中

# 5 Zuul网关存在的问题 #

在实际使用中我们会发现直接使用Zuul会存在诸多问题，包括：

*  **性能问题**  
    Zuul1x版本本质上就是一个同步Servlet，采用多线程阻塞模型进行请求转发。简单讲，每来一个请求，Servlet容器要为该请求分配一个线程专门负责处理这个请求，直到响应返回客户端这个线程才会被释放返回容器线程池。如果后台服务调用比较耗时，那么这个线程就会被阻塞，阻塞期间线程资源被占用，不能干其它事情。我们知道Servlet容器线程池的大小是有限制的，当前端请求量大，而后台慢服务比较多时，很容易耗尽容器线程池内的线程，造成容器无法接受新的请求。
 *  不支持任何长连接，如websocket

# 6 Zuul网关的替换方案 #

*  Zuul2.x版本
 *  SpringCloud Gateway

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU5NjkwNQ_size_16_color_FFFFFF_t_70]: /images/20230528/b5684fb62fdb4b1db0c791c57edf0183.png