Zuul

一时失言乱红尘 2021-11-02 04:24 270阅读 0赞

Zuul 简介

https://www.liangzl.com/get-article-detail-20957.html  
Zuul是Netflix开源的微服务网关，他可以和Eureka,Ribbon,Hystrix等组件配合使用。Zuul组件的核心是一系列的过滤器，这些过滤器可以完成以下功能：

身份认证和安全: 识别每一个资源的验证要求，并拒绝那些不符的请求  
审查与监控：  
动态路由：动态将请求路由到不同后端集群  
压力测试：逐渐增加指向集群的流量，以了解性能  
负载分配：为每一种负载类型分配对应容量，并弃用超出限定值的请求  
静态响应处理：边缘位置进行响应，避免转发到内部集群  
多区域弹性：跨域AWS Region进行请求路由，旨在实现ELB(ElasticLoad Balancing)使用多样化  
\---------------------  
作者：菜鸡旭旭  
来源：CSDN  
原文：https://blog.csdn.net/fengyuhan123/article/details/82835482  
版权声明：本文为博主原创文章，转载请附上博文链接！

## 前言 ##

> 介绍完分布式配置中心，结合前面的文章。我们已经有了一个微服务的框架了，可以对外提供api接口服务了。但现在试想一下，在微服务框架中，每个对外服务都是独立部署的，对外的api或者服务地址都不是不尽相同的。对于内部而言，很简单，通过注册中心自动感知即可。但我们大部分情况下，服务都是提供给外部系统进行调用的，不可能同享一个注册中心。同时一般上内部的微服务都是在内网的，和外界是不连通的。而且，就算我们每个微服务对外开放，对于调用者而言，调用不同的服务的地址或者参数也是不尽相同的，这样就会造成消费者客户端的复杂性，同时想想，可能微服务可能是不同的技术栈实现的，有的是`http`、`rpc`或者`websocket`等等，也会进一步加大客户端的调用难度。所以，一般上都有会有个api网关，根据请求的url不同，路由到不同的服务上去，同时入口统一了，还能进行统一的身份鉴权、日志记录、分流等操作。接下来，我们就来了解今天要讲解的`路由服务：zuul`。

## 一点知识 ##

### 为什么要使用微服务网关 ###

简单来说，微服务网关是微服务架构中一个不可或缺的部分。通过服务网关统一向外系统提供REST API的过程中，除了具备服务路由、均衡负载功能之外，它还具备了权限控制等功能。

在未加入网关时，一般上会在服务外网架设一个负载均衡，如nginx等。此时，微服务的组成为：

![20181015104055_784.jpg][]

此时，对于`Open Service`而言可能需要提供权限控制等和业务无关的能力，这样本身就破坏了微服务服务单一的原则。所以，一般上在`Open Service`之上，还有一层服务提供诸如通用的权限校验、参数校验等功能，此服务就是网关了。之后，对于内部微服务而言，只需要关系各自微服务提供的业务功能即可，无需去关心其他非业务相关的功能。

#### API网关是什么 ####

> API网关可以提供一个单独且统一的API入口用于访问内部一个或多个API。简单来说嘛就是一个统一入口，比如现在的支付宝或者微信的相关api服务一样，都有一个统一的api地址，统一的请求参数，统一的鉴权。

#### 客户端和服务端直连的弊端 ####

*  客户端会对此请求不同的微服务，增加客户端复杂性
 *  存在跨域请求时，需要进行额外处理
 *  认证服务，每个服务需要独立认证
 *  UI端和微服务耦合

#### 网关的优缺点 ####

优点：

*  减少api请求次数
 *  限流
 *  缓存
 *  统一认证
 *  降低微服务的复杂度
 *  支持混合通信协议(前端只和api通信，其他的由网关调用)
 *  ……

缺点：

*  网关需高可用，可能产生单点故障
 *  管理复杂

### 网关的选择 ###

现在市场上有很多的网关可供选择：

*  Spring Cloud Zuul：本身基于`Netflix`开源的微服务网关,可以和`Eureka`,`Ribbon`,`Hystrix`等组件配合使用。
 *  Kong : 基于OpenResty的 API 网关服务和网关服务管理层。
 *  Spring Cloud Gateway：是由`spring`官方基于`Spring5.0`,`Spring Boot2.0`,`Project Reactor`等技术开发的网关，提供了一个构建在`Spring Ecosystem`之上的API网关，旨在提供一种简单而有效的途径来发送API，并向他们提供交叉关注点，例如：安全性，监控/指标和弹性。目的是为了替换`Spring Cloud Netfilx Zuul`的。

在`Spring cloud`体系中，一般上选择`zuul`或者`Gateway`。当然，也可以综合自己的业务复杂性，自研一套或者改在一套符合自身业务发展的api网关的，最简单做法是做个`聚合api服务`，通过`SpringBoot`构建对外的api接口，实现统一鉴权、参数校验、权限控制等功能，说白了就是一个`rest`服务。

## Zuul介绍和使用 ##

### 何为Zuul ###

> `Zuul`是`Netflix`开源的微服务网关，可以和`Eureka`、`Ribbon`、`Hystrix`等组件配合使用，`Spring Cloud`对`Zuul`进行了整合与增强，`Zuul`的主要功能是路由转发和过滤器。

![20181015104055_285.jpg][]

`Zuul`基于JVM的路由器和服务器端负载均衡器。同时，`Zuul`的规则引擎允许规则和过滤器基本上用任何JVM语言编写，内置支持`Java`和`Groovy`。这个功能，就可以实现动态路由的功能了。当需要添加某个新的对外服务时，一般上不停机更新是通过数据缓存配置或者使用`Groovy`进行动态路由的添加的。

`Zuul`的核心一系列的过滤器：

*  身份认证与安全：识别每个资源的验证要求，并拒绝那些与要求不符的请求。
 *  审查与监控：在边缘位置追踪有意义的数据和统计结果，从而带来精确的生产视图。
 *  动态路由：动态地将请求路由到不同的后端集群。
 *  压力测试：逐渐增加指向集群的流量，以了解性能。
 *  负载分配：为每一种负载类型分配对应容量，并启用超出限定值的请求。
 *  静态响应处理：在边缘位置直接建立部分相应，从而避免其转发到内部集群。

加入`Zuul`网关后：

![20181015104055_340.jpg][]

### Zuul实践 ###

创建工程：`spring-cloud-zuul`。 这里直接加入了注册中心进行服务化模式。

0.加入pom依赖。

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

注意：这里的`Eureka`不是必须的。在没有注册中心的情况下，也是可以进行zuul使用的。

1.配置文件，配置注册中心相关信息、路由规则等。

spring.application.name=zuul-server
    server.port=8888
    
    # 注册中心地址 -此为单机模式
    eureka.client.service-url.defaultZone=http://127.0.0.1:1000/eureka
    # 启用ip配置 这样在注册中心列表中看见的是以ip+端口呈现的
    eureka.instance.prefer-ip-address=true
    # 实例名称  最后呈现地址：ip:15678
    eureka.instance.instance-id=${spring.cloud.client.ip-address}:${server.port}
    
    ## 路由规则
    ## 传统路由配置：不依赖服务发现。
    ## 所有以myapi开头的url路由至http://127.0.0.1:2000/下
    ## 如http://127.0.0.1:8888/myapi/hello --> http://127.0.0.1:2000/hello
    zuul.routes.myApi.path=/myapi/**
    zuul.routes.myApi.url=http://127.0.0.1:2000
    
    #forward模式 直接转发至zuul提供的rest服务
    zuul.routes.myDemo.path=/myDemo/**
    zuul.routes.myDemo.url=forward:/demo
    
    ## 服务发现模式
    # 路由地址
    zuul.routes.myEureka.path=/eureka/**
    #为具体服务的名称
    zuul.routes.myEureka.service-id=eureka-client

友情提示： 默认情况下：Zuul代理所有注册到EurekaServer的微服务，路由规则： `http://ZUUL_HOST:ZUUL_PORT/微服务实例名(serverId)/**` 转发至serviceId对应的微服务。

如：[http://127.0.0.1:8888/eureka-client/hello?name=oKong][http_127.0.0.1_8888_eureka-client_hello_name_oKong] 最后就是转发至：[http://127.0.0.1:2000//hello?name=oKong][http_127.0.0.1_2000_hello_name_oKong]

2.启动类加入`@EnableZuulProxy`注解，声明一个Zuul代理。

/** * zuul 示例 * * @author oKong * */ @SpringBootApplication @EnableZuulProxy @EnableDiscoveryClient @Slf4j public class SpringCloudZuulApplication { public static void main(String[] args) throws Exception { SpringApplication.run(SpringCloudZuulApplication.class, args); log.info("spring-cloud-zuul启动!"); } }

3.编写一个控制类，测试`forward`功能。

/**
     * zuul 内部提供对外服务示例
     * @author oKong
     *
     */
    @RestController
    @RequestMapping("/demo")
    public class DemoController {
    
        @GetMapping("/hello")
        public String hello(String name) {
            return "hi," + name + ",this is zuul api! ";
        }
    }

4.启动`spring-cloud-eureka-server`和`spring-cloud-eureka-client`服务，之后再启动`spring-cloud-zuul`服务。

此时，我们来访问zuul内部服务：[http://127.0.0.1:8888/demo/hello?name=oKong][http_127.0.0.1_8888_demo_hello_name_oKong]

![20181015104055_49.jpg][]

然后访问：[http://127.0.0.1:8888/myDemo/hello?name=oKong][http_127.0.0.1_8888_myDemo_hello_name_oKong] 效果和上面直接方式是一样的，最后都是访问`/demo/**`api地址的。

访问：[http://127.0.0.1:8888/myapi/hello?name=oKong][http_127.0.0.1_8888_myapi_hello_name_oKong] 和 [http://127.0.0.1:8888/eureka/hello?name=oKong][http_127.0.0.1_8888_eureka_hello_name_oKong] 最后效果都是一样的，都是访问[http://127.0.0.1:2000/hello?name=oKong][http_127.0.0.1_2000_hello_name_oKong 1] 。

![20181015104055_55.jpg][]

![20181015104055_127.jpg][]

直接以默认形式访问:[http://127.0.0.1:8888/eureka-client/hello?name=oKong][http_127.0.0.1_8888_eureka-client_hello_name_oKong] 最后效果也是一样的。

![20181015104055_848.jpg][]

其实，从控制台输出日志也是可以一窥究竟的：

![20181015104055_199.jpg][]

### 路由规则说明 ###

简单说明下关于路由规则的一些说明：

#### 传统路由配置：不依赖服务发现，如nginx ####

*  单例实例配置：通过`zuul.routes.<route>.path`和`zuul.routes.<route>.url`参数对的方式来配置

# 传统路由配置
    zuul.routes.server-provide.path=/server-provide/**
    zuul.routes.server-provide.url=http://127.0.0.1:1001/

*  多实例配置：通过一组`zuul.routes.<route>.path`与`zuul.routes.<route>.serviceId`参数对的方式配置

# 多实例
    zuul.routes.server-provide.path=/user-service/**
    zuul.routes.server-provide.serviceId=user-service
    ribbon.eureka.enabled=false
    server-provide.ribbon.listOfServers=http://127.0.0.1:1001/,http://127.0.0.1:1001/

#### 服务路由配置：依赖服务发现，结合Eureka ####

*  默认规则：http://ZUUL\_HOST:ZUUL\_PORT/微服务实例名(serverId)/\*\* ，转发至serviceId对应的微服务。
 *  自定义路由规则：通过一组`zuul.routes.<route>.path`与`zuul.routes.<route>.serviceId`参数对的方式配置

# 自定义路由
    zuul.routes.server-provide.path=/server-api/**
    zuul.routes.server-provide.serviceId=server-provide

比如:

![20181015104055_229.jpg][]

而且，要注意，这些过滤器是`path`进行最佳路径匹配的，所以，一般上在一些历史系统上，我们会在最后后面加上一个路径/\*\*的匹配规则，以保证历史api可以使用，做到最大兼容性,避免类似404的异常。

zuul.routes.legacy.path=/**

## 参考资料 ##

1.  [https://cloud.spring.io/spring-cloud-static/Finchley.SR1/single/spring-cloud.html\#\_router\_and\_filter\_zuul][https_cloud.spring.io_spring-cloud-static_Finchley.SR1_single_spring-cloud.html_router_and_filter_zuul]

## 总结 ##

> 本章节主要简单介绍了关于`Zuul`的一些简单使用以及一些路由规则的简单说明。开头也说过了，`Zuul`的核心是一系列的过滤器。介于篇幅问题，关于过滤器的介绍、自定义过滤器、异常处理、熔断降级等放在下一章节来讲解。而相关的其他配置，大家可以去官网进行查看，或者自行搜索下，也可以查看下：`org.springframework.cloud.netflix.zuul.filters.ZuulProperties`类，相关配置信息都在里面了。

## 最后 ##

> 目前互联网上大佬都有分享`SpringCloud`系列教程，内容可能会类似，望多多包涵了。原创不易，码字不易，还希望大家多多支持。若文中有错误之处，还望提出，谢谢。

转载于:https://www.cnblogs.com/handsome1013/p/10938607.html

[20181015104055_784.jpg]: /images/20211102/89546e5bfbfa4e3480798d18543e2467.png
[20181015104055_285.jpg]: /images/20211102/dd6c82796d1644bea32c226aea572aba.png
[20181015104055_340.jpg]: /images/20211102/016ddca8234c418ca7dff7a99ce8d0e2.png
[http_127.0.0.1_8888_eureka-client_hello_name_oKong]: http://127.0.0.1:8888/eureka-client/hello?name=oKong
[http_127.0.0.1_2000_hello_name_oKong]: http://127.0.0.1:2000//hello?name=oKong
[http_127.0.0.1_8888_demo_hello_name_oKong]: http://127.0.0.1:8888/demo/hello?name=oKong
[20181015104055_49.jpg]: /images/20211102/cefa12d12cd04c3a9113d809f25c0ad4.png
[http_127.0.0.1_8888_myDemo_hello_name_oKong]: http://127.0.0.1:8888/myDemo/hello?name=oKong
[http_127.0.0.1_8888_myapi_hello_name_oKong]: http://127.0.0.1:8888/myapi/hello?name=oKong
[http_127.0.0.1_8888_eureka_hello_name_oKong]: http://127.0.0.1:8888/eureka/hello?name=oKong
[http_127.0.0.1_2000_hello_name_oKong 1]: http://127.0.0.1:2000/hello?name=oKong
[20181015104055_55.jpg]: /images/20211102/94d296b298564df3be0045779c15f556.png
[20181015104055_127.jpg]: /images/20211102/a06ef9ea83f0433f950572c979032dcc.png
[20181015104055_848.jpg]: /images/20211102/0db5a718ae594af4b9c53ee84ed7c485.png
[20181015104055_199.jpg]: /images/20211102/89efe8c5a87c42368231e4a743f8719e.png
[20181015104055_229.jpg]: /images/20211102/6c679d1d8a9f4d2187eb1cb4196aedc2.png
[https_cloud.spring.io_spring-cloud-static_Finchley.SR1_single_spring-cloud.html_router_and_filter_zuul]: https://cloud.spring.io/spring-cloud-static/Finchley.SR1/single/spring-cloud.html#_router_and_filter_zuul