SpringCloud Zuul 网关搭建及配置

 

目录

一.Zuul网关

二.Zuul服务的前期准备

2.1 注册中心EurekaServer的搭建

2.2 EurekaService的搭建

三.Zuul服务搭建

五.Zuul的访问

六.Zuul的更多功能

---

前言：博主一直力求做到写博客尽量的详细来减少大家花在踩坑上的时间，若有写的不好或错误的地方，还需各方大佬指正。

一.Zuul网关

    网关，是一种网络关口，既然是关口，就需要知道哪些东西能通过哪些东西不能通过。

    在微服务中，Zuul是SpringCloud众多组件中的一个，用于微服务的网关。在微服务中，各自服务之间的调用不可能都在各自服务中来实现安全与认证功能，因此需要一个专门的微服务来提供这些功能。当请求从客服端发到服务器，如果经过网关的一系列验证和过滤符合访问要求，那么在之后访问其他微服务或由网关路由转发之后的访问时，不需要再做同样的安全认证。这是网关的主要功能。

    实际上，Zuul给我们提供的网关服务种类是很多的。后面会介绍他的一些功能。如果你已经搭建了注册中心那么可以直接看第三节:Zuul服务搭建

二.Zuul服务的前期准备

2.1 注册中心EurekaServer的搭建

为了搭建好网关后，能通过网关来访问各模块微服务来证明网关的搭建成功，因此这里需要提前搭建一些可用的微服务。第一步我们先新建一个Project

选择Springboot作为启动器，微服务的标配。当然你用Maven的骨架来搭建也完全可以，构建项目并没有非要用哪一种方式搭建。重要的是后面你知道pom里应该引入那些依赖，application.yml怎么配置。这些才是搭建微服务需要主要的地方。这里我使用Spring Initializr

idea给你默认的内容如下：

Group和Artifact我们已经见得太多了，当我们指定这两个参数时，项目名和包名应该与之适配。不过当然可以不一样。

比如默认值 Group为com.example，Artifact为demo，那么项目名应该为demo和Artifact一致，包名Package应该为com.example.demo，为Group和Artifact的合体 。当然这里不强制，只是一种规范，比如别人看见你的包名为com.example.demo时，立马可以知道他属于com.example组下的demo项目。一些使用语言，Java版本，项目类型啥的。

在这里因为我是作为测试springcloud相关组件的目的，那么我这里设置如下：

细心的朋友会发现，当我们改完1和2，idea会自动给我们修改3和4选项，既然是规范idea当然希望大家准守。改完1和2，我们点击Next。这一步相当于选择这个项目需要的一些组件，比如这个项目你需要用到springmvc？Mybatis？MySQL？那么在这里选择后，idea会去加载这些相关的依赖并在pom里为大家自动引入这些依赖。

这里我们要搭建一些测试的微服务，首先搭建1个Eureka注册中心。 所有的微服务都需要在这里注册。微服务的注册与发现详细的搭建过程可以参考上一篇博文：https://blog.csdn.net/qq_29519041/article/details/85238270

如上图选择Eureka Server，点Next，如下图，项目为zuul，而模组这里我们先搭建微服务的注册中心Eureka Server，所以这里我把模组名命名为eurekaserver，继续点Next。改了模组名，idea会默认在项目目录下建立模组的文件夹，因此可以看见第二个红框自动变化。继续点下一步。

因为我之前有项目所以这里选择开启新的idea窗口。New Window

点击import change之后等待idea加载依赖

查看项目结构：

此时我习惯把application.properties后缀改为yml。这样配置书写的格式符合yml的风格，比较好看。

现在需要做下面几件事，由于我们开始构建项目时选择了Eureka Server，所以pom.xml中不需要手动添加依赖了。

首先在启动类SpringcloudApplication中添加EurekaServer的注解： @EnableEurekaServer

然后在application.yml中添加相关配置：

server:
  port: 9000  #eureka注册中心服务端口

eureka:
  instance:
    hostname: localhost
  client:
    register-with-eureka: false #不向eureka注册中心注册。也就是为了关闭自己向自己注册，eureka默认要向自己注册
    fetch-registry: false
    service-url:
      defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/

就可以启动服务了:

访问注册中心：按照配置的端口号访问。我这里配了9000，端口随意，如下图代表Eureka注册中心部署成功了。

显示没有实例在此中心注册。没事接下来我们开始配置zuul网关，它也是一个服务需要注册到此注册中心来。

 

2.2 EurekaService的搭建

有了注册中心，我们现在需要搭建服务的真正提供者，EurekaService，第四节我们建四个。

eurekaservice01，eurekaservice02，eurekaservice03，eurekaservice04，第一个如下，第二三四个按着第一个的建，修改一下名字，端口号还有方法返回值。

需要用到mvc

服务提供者同样需要注册到注册中心。

改名你懂得

 

完成：

接下来是同样的套路，改yml，启动类添加注解：@EnableEurekaClient

yml配置如下（因为是测试所有很简陋）：

server:
  port: 8900 # 服务提供方

# 指定当前eureka客户端的注册地址,
eureka:
  client:
    service-url:
      defaultZone: http://${eureka.instance.hostname}:9000/eureka/
  instance:
    hostname: localhost

#当前服务名称
spring:
  application:
    name: eurekaservice1

注意当前服务名称。这里用于注册到注册中心的名字，还可以启动很多同样为eurekaservice1的名字的微服务到注册中心，zuul从注册中心Eureka Server获取所有服务名为eurekaservice01的服务列表后，会采用负载均衡策略访问其中一台服务提供者获取资源。

下图我们之前zuul中的配置serviceId就是指向这里的服务名称，这是微服务调用的精髓，通过服务名调用。

 

既然是服务提供者 ，这里要编写controller类了：新建controller包，新建Test01类，编写REST的方法。返回服务1

按照服务提供者1的搭建方式，现在搭建服务提供者2：

同样是新建模组，名字改为...02，yml配置文件中端口号与服务1要不同，服务名称相同，为了测试负载均衡，REST方法返回值设为服务2。

yml：

server:
  port: 8901 # 服务提供方

# 指定当前eureka客户端的注册地址,
eureka:
  client:
    service-url:
      defaultZone: http://${eureka.instance.hostname}:9000/eureka/
  instance:
    hostname: localhost

#当前服务名称
spring:
  application:
    name: eurekaservice1

同样的方法再建两个服务提供者3和4，服务名称都为eurekaservice2，端口号分别为8902，和8903。REST方法返回值分别为，服务3和服务4。

 

三.Zuul服务搭建

有了第二节的准备，搭建了注册中心，和服务的提供者，我们现在开始搭建Zuul网关服务，最后通过zuul访问注册中心获取服务列表，然后访问服务提供者。

新建模组：

 这里模组名设为zuul。包名设置为zuul，等会生成的启动类就会是带有zuul了。EurekaServer也可以这样只是我开始搭的时候没有注意到。

需要Eureka的客户端组件，和zuul组件，点next

 模组名设为zuul，不强制

 项目结构：

在启动类配置注解 @EnableEurekaClient，@EnableZuulProxy，@EnableZuulProxy可以称为@EnableZuulServer的增强版，当Zuul与Eureka、Ribbon等组件配合使用时，我们使用@EnableZuulProxy。 

配置pom文件:

server:
   port: 9100

spring:
  application:
    name: zuul

eureka:
  client:
    service-url:
        defaultZone: http://localhost:9000/eureka/ #当前zuul网关想要注册到哪个注册中心这里注册到之前搭的9000上。

#路由规则定义。这里定义两种路由规则route1和route2
#，代表访问网关/test01/**或/test02/**时。
#路由到服务名为 eurekaservice1或 eureka
#service2中的服务集群去。
zuul:
  routes:
    route1:
      path: /test01/**
      serviceId: eurekaservice1
    route2:
      path: /test02/**
      serviceId: eurekaservice2

启动项目：

聪明的你再去注册中心看就能看见zuul服务已经被注册到注册中心了

有了网关，

五.Zuul的访问

我们有一个网关服务zuul，一个注册中心eurekaserver，4个服务提供者eurekaservice，4个服务提供者，其中两个提供

服务名为eurekaservice1的服务，另外两个提供eurekaservice2的服务，现在我们来启动4个服务提供者，在注册中心查看，并通过网关访问测试网关的服务是否正常。

总项目结构：

启动后注册中心查看：

如之前所想，两个服务名下各两台服务提供者。

现在回想之前zuul的路由配置：

那么我访问zuul网关的test01/**下的任何服务都会给我转发到服务名为eurekaservice1下的01和02服务下。我们来试试

第一次访问：test01

第二次访问：test01

可以看见zuul网关做了转发和负载均衡，使用的是ribbon轮询的方式负载均衡。

那么可以猜想到我们访问test02，zuul网关会在服务名为eurekaservice2的服务3和服务4之间去访问了。我们来看看：

至此我们已经实践完成zuul网关的基本功能转发和负载均衡。第三节会在yml中继续配置一些参数，来实践zuul的更多功能。

六.Zuul的功能介绍

6.1 传统路由配置

6.1.1 传统路由配置

 

6.1.2 单实例配置

 

6.1.3 多实例配置

 

6.2 服务路由配置

6.3 服务路由的默认规则

6.4 自定义路由映射规则

6.5 路径匹配

6.6 忽略表达式

6.7 路由前缀