前言

在上两篇博客中为大家介绍了一下SpringCloud中的两个组件 Eureka 和断路器（Hystrix），咱们书接上文，今天给大家介绍SpringCloud中的第三个组件 —— 路由网关（zuul）。

什么是路由网关（zuul）

还是老规矩，先给大家介绍一下什么是路由网关（zuul）。

Zuul 包含了对请求的路由和过滤这两个最主要的功能，其中路由负责将外部请求转发到具体的微服务实例上，是实现外部访问统一入口的基础；而过滤器功能则负责请求的处理过程进行干预，是实现请求校验、服务聚合等功能的基础。
Zuul和Eureka进行整合，将Zuul自身注册为Eureka服务治理下的应用，同时从Eureka中获得其他微服务的消息，也即以后的访问微服务都是通过Zuul跳转后获得。

秉承着“繁琐问题必有猥琐解法”的一贯宗旨，下面用大白话为大家解释一下。在这里插入图片描述上面这张图是官方贴出来的一个架构图，图中框起来的部分就是由路由网关（Zuul）实现的API Gateway。说白了网关就是SpringCloud微服务对外的窗口，在对外提供服务接口的时候，起到了请求的路由和过滤作用，因此也能够隐藏内部服务的接口细节，从来有利于保护系统的安全性。

==需要注意的是Zuul服务最终还是会注册进Eureka服务端，从而提供代理+路由+过滤这三大功能==

下面直接上代码，给大家具体介绍一下路由网关该怎么使用。

路由网关（Zuul）

咱们继续沿用上两篇博客中创建的工程（Eureka-Server服务注册中心、两个Eureka-Client客户端），首先还是先启动这三个项目（注意启动顺序哦，先启动服务注册中心，再启动两个客户端），启动后咱们可以看到Eureka-Server服务注册中心出现了一条注册信息，一条信息中包含了两个Eureka-Client客户端的注册信息。在这里插入图片描述接下来咱们新建一个Zuul工程，新建Zuul工程的步骤跟上两篇博客中的步骤是一致的，咱们主要还是看看代码。

首先先说pom.xml文件，pom.xml文件和客户端的pom.xml文件是类似的，唯一不同的是新增了spring-cloud-starter-netflix-zuul依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.zuul</groupId>
    <artifactId>service-zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>service-zuul</name>
    <description>Demo project for service-zuul</description>
    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-cloud.version>Hoxton.SR10</spring-cloud.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>

        <!-- SpringBoot Web容器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

接下来咱们再看看appication.yml文件。

eureka:
  client:
    serviceUrl:
      defaultZone: http://127.0.0.1:8081/eureka/
server:
  port: 8009
spring:
  application:
    name: service-zuul
zuul:
  routes:
    api-a:
      path: /api-a/**
      serviceId: service-provider_a
    api-b:
      path: /api-b/**
      serviceId: service-provider_b

appication.yml文件中需要注意的地方是zuul下的相关配置，path代表的含义是请求地址，serviceId所配置的是请求转发给的某个具体服务。所以上面的配置描述的就是：以/api-a/ 开头的请求都转发给service-provider_a服务；以/api-b/开头的请求都转发给service-provider_b服务。（为了方便区分，我们需要把两个客户端下的appication.yml文件中的name值分别改成service-provider_a和service-provider_b，如下图所示）在这里插入图片描述

在这里插入图片描述

最后我们再在启动类文件中新增一个@EnableZuulProxy注解，表示这个工程是一个路由网关。在这里插入图片描述 Zuul工程都配置完成后，我们分别启动两个客户端工程和Zuul工程，启动成功后我们可以看到Eureka-Server服务注册中心出现了三条注册信息，分别是两个客户端工程和路由网关工程的注册信息。工程成功启动后咱们打开浏览器，分别访问一下http://localhost:8009/api-a/getUser?id=1和http://localhost:8009/api-b/getUser?id=1这两个地址。在这里插入图片描述咱们可以看到返回的结果中name值是不同的，这也就证明了Zuul起到了路由的作用，上述两个请求被转发到了两个不同的客户端。

Zuul的另一功能——服务过滤

Zuul不只是一个路由网关，他还能做服务过滤、安全验证。下面我们继续改造Zuul工程，增加一个MyFilter过滤器。

@Component
public class MyFilter extends ZuulFilter {

    private static Logger log = LoggerFactory.getLogger(MyFilter.class);
    @Override
    public String filterType() {
        return "pre";
    }

    @Override
    public int filterOrder() {
        return 0;
    }

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        log.info(String.format("%s >>> %s", request.getMethod(), request.getRequestURL().toString()));
        Object accessToken = request.getParameter("id");
        if(accessToken == null) {
            log.warn("id is empty");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            try {
                ctx.getResponse().getWriter().write("id is empty !!!");
            }catch (Exception e){}

            return null;
        }
        log.info("success!!");
        return null;
    }
}

首先先解释一下过滤器中的各个方法：

filterType：返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：
1. pre：路由之前（可用来做限流、鉴权、参数校验调整等）
2. routing：路由之时
3. post：路由之后（可用来做统计、日志等）
4. error：发送错误调用
filterOrder：过滤的顺序。
shouldFilter：这里可以写逻辑判断，是否要过滤，本文true,永远过滤。
run：过滤器的具体逻辑。可用很复杂，包括查sql去判断该请求到底有没有权限访问。这里只是一个简单的判断参数是否为空的示例。

接下来咱们打开浏览器访问一下http://localhost:8009/api-b/getUser地址，我们可以看到浏览器中输出了一句id is empty !!!，此时也证明了咱们的过滤器正常生效了。

结语

zuul的出现，极大的降低了编码的复杂度。它易于监控（可在微服务网关收集监控数据并将其推送到外部系统进行分析）；易于认证（可在微服务网关上进行认证，然后再将请求转发到后端的微服务，而无须在每个微服务中进行认证）；减少了客户端与各个微服务之间的交互次数。并且它支持groovy脚本编写Filter，也就是能够不停机的动态控制 Load Filter ，但有一点也是需要注意的，就是在使用Zuul的时候还是要多关注一下性能损耗的。

本人经验有限，有些地方可能讲的没有特别到位，如果您在阅读的时候想到了什么问题，欢迎在评论区留言，我们后续再一一探讨🙇‍

希望各位小伙伴动动自己可爱的小手，来一波点赞+关注 (✿◡‿◡) 让更多小伙伴看到这篇文章~ 蟹蟹呦(●'◡'●)

如果文章中有错误，欢迎大家留言指正；若您有更好、更独到的理解，欢迎您在留言区留下您的宝贵想法。

爱你所爱行你所行听从你心无问东西

大聪明教你学Spring Cloud核心组件 | 第三篇：路由网关（Zuul）

前言

什么是路由网关（zuul）

路由网关（Zuul）

Zuul的另一功能——服务过滤

结语