SpringCloud 的Zuul理论和使用Zuul构建微服务网关以及Zuul网关使用熔断器

本篇博客主要讲微服务网关，和Zuul相关理论知识以及怎么样使用Zuul实现网关。

微服务网关

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

不同的微服务一般会有不同的网络地址，而外部客户端可能需要调用多个服务的接口才能完成一个业务需求，如果让客户端直接与各个微服务通信，会有以下问题：

1、客户端会多次请求不同的微服务，增加了客户端的复杂性。

2、存在跨域请求，在一定场景下处理相对复杂。

3、认证复杂，每个服务都需要独立认证。

4、难以重构，随着项目的迭代，可能需要重新划分微服务。

5、某些微服务可能使用了防火墙或浏览器不友好协议，直接访问会有一定的困难。

如图：

为了解决这些问题，需使用微服务网关。微服务网关是介于客户端和服务器端之间的中间层，所有的外部请求都会先经过微服务网关，如图：

微服务网关封装了应用程序的内部结构，客户端只跟网关交互，无需直接调用特定微服务的接口，其优点：

1、易于监控：可在微服务网关收集监控数据并将其推送到外部系统进行分析。

2、易于认证：可在微服务网关上进行认证，在将请求转发到后端的微服务，无需在每个微服务中进行认证。

3、减少了客户端和各个微服务之间的交互次数。

在微服务架构中，需要几个基础的服务治理组件，包括服务注册与发现、服务消费、负载均衡、断路器、智能路由、配置管理等，由这几个基础组件相互协作，共同组建了一个简单的微服务系统。一个简答的微服务系统如下图：

注意：A服务和B服务是可以相互调用的，作图的时候忘记了。并且配置服务也是注册到服务注册中心的。

在Spring Cloud微服务系统中，一种常见的负载均衡方式是，客户端的请求首先经过负载均衡（zuul、Ngnix），再到达服务网关（zuul集群），然后再到具体的服。，服务统一注册到高可用的服务注册中心集群，服务的所有的配置文件由配置服务管理（下一篇文章讲述），配置服务的配置文件放在git仓库，方便开发人员随时改配置。

以上理论来自 https://blog.csdn.net/fivehundredyearsago/article/details/80730119 感谢

Zuul

Zuul简介

Zuul是Netflix开源的微服务网关，可以和Eureka、Ribbon、Hystrix等组件配合使用，Spring Cloud对Zuul进行了整合与增强，Zuul默认使用的HTTP客户端是Apache HTTPClient，也可以使用RestClient或okhttp3.OkHttpClient。 Zuul的主要功能是路由转发和过滤器。路由功能是微服务的一部分，比如／api/user转发到到user服务，/api/shop转发到到shop服务。zuul默认和Ribbon结合实现了负载均衡的功能。

Zuul的核心是一系列的过滤器，这些过滤器可以完成以下功能：

1、身份认证与安全：识别每个资源的验证要求，并拒绝那些与要求不符的请求。

2、审查与监控：在边缘位置追踪有意义的数据和统计结果，从而带来精确的生产视图。

3、动态路由：动态地将请求路由到不同的后端集群。

4、压力测试：逐渐增加指向集群的流量，以了解性能。

5、负载分配：为每一种负载类型分配对应容量，并启用超出限定值的请求。

6、静态响应处理：在边缘位置直接建立部分响应，从而避免其转发到内部集群。

7、多区域弹性：跨越AWS Region进行请求路由，旨在实现ELB(Elastic Load Balancing)使用的多样化，以及让系统的边缘更贴近系统的使用者。

zuul有以下功能：

Authentication
Insights
Stress Testing
Canary Testing
Dynamic Routing
Service Migration
Load Shedding
Security
Static Response handling
Active/Active traffic management

使用Zuul构建微服务网关

本次操作还是在之前的博客项目上改进实现 https://blog.csdn.net/weixin_42236165/article/details/92842773 https://blog.csdn.net/weixin_42236165/article/details/93159034

1.首先再创建一个创建eureka-zuul项目

pom.xml文件如下:

<?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 http://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.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.szh</groupId>
    <artifactId>eureka-zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>eureka-zuul</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.SR1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <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>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </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>

2.在启动类EurekaZuulApplication加上注解@EnableZuulProxy，开启zuul的功能：

package com.szh.eurekazuul;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;


@EnableZuulProxy
@EnableDiscoveryClient
@SpringBootApplication
public class EurekaZuulApplication {

    public static void main(String[] args) {
        SpringApplication.run(EurekaZuulApplication.class, args);
    }

}

3.在配置文件application.yml加上以下的配置代码：

路由转发
zuul.routes.api-student.service-id=eureka-student转发到到eureka-student服务，zuul.routes…api-grade.service-id=eureka-grade转发到到eureka-grade服务

spring.application.name=eureka-zuul
server.port=8089
eureka.client.serviceUrl.defaultZone=http://localhost:8080/eureka/

zuul.routes.api-student.path=/student/**
zuul.routes.api-student.service-id=eureka-student

zuul.routes.api-grade.path=/grade/**
zuul.routes..api-grade.service-id=eureka-grade

首先指定服务注册中心的地址为http://localhost:8089/，服务的端口为8089，服务名为service-zuul；以/api-student/ 开头的请求都转发给eureka-student服务；以/api-grade/开头的请求都转发给eureka-grade服务；

4.测试(路由转发)
依次启动springcloud-eureka-server、springcloud-eureka-grade、spring-eureka-student，springcloud-eureka-zuul四个项目。

打开浏览器访问：http://localhost:8089/student/grades ;浏览器显示：

服务过滤

5.zuul不仅只是路由，并且还能过滤，做一些安全验证。继续改造工程；

增加一个MyZuulFilter类

package com.szh.eurekazuul.filter;

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

import javax.servlet.http.HttpServletRequest;

@Component
public class MyZuulFilter extends ZuulFilter{

    private Logger log = LoggerFactory.getLogger(MyZuulFilter.class);

    @Override
    public String filterType() {
        //路由之前要做的处理
        return "pre";
    }

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

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

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

filterType：返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：
pre：路由之前
routing：路由之时
post： 路由之后
error：发送错误调用
filterOrder：过滤的顺序
shouldFilter：这里可以写逻辑判断，是否要过滤，本文true,永远过滤。
run：过滤器的具体逻辑。可用很复杂，包括查sql，nosql去判断该请求到底有没有权限访问。

6.测试
关闭springcloud-eureka-zuul项目在打开

打开浏览器访问：http://localhost:8089/student/grades ;浏览器显示：
token is empty

访问http://localhost:8089/student/grades?token=dfssf ； 显示

成功！

然后用网关去尝试上篇写的熔断器的时候会遇到一些问题

依次启动完项目后
先访问 http://localhost:8089/student/grades?token=dfssf

接下来我们手动停止springcloud-eureka-grade项目再次测试：
在浏览器中输入：http://localhost:8089/student/grades?token=dfssf

报错！

解决方法如下在service-zuul项目中的application.properties中加入代码

hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 6000
hystrix.command.default.execution.timeout.enabled: true
feign.hystrix.enabled: true
spring.cloud.loadbalancer.retry.enabled: true
ribbon.ReadTimeout: 6000
ribbon.ConnectTimeout: 6000

在依次启动一遍项目测试
访问 http://localhost:8089/student/grades?token=dfssf

接下来我们手动停止springcloud-eureka-grade项目再次测试：
在浏览器中输入：http://localhost:8089/student/grades?token=dfssf