【Spring Cloud 基础设施搭建系列】Spring Cloud Demo项目使用Zuul构建微服务网关

本是古典何须时尚 2023-08-17 16:51 115阅读 0赞

### 文章目录 ###

*   *  Zuul简介
     *  编写Zuul微服务网关
     *  Zuul集成Hystrix
     *  Zuul的负载均衡
     *  Zuul的路由端点
     *  Zuul路由配置详解
     *  Zuul的安全与Header
     *  参考
     *  源代码

如果让客户端直接与各个微服务通信，会有以下的问题：

*  客户端会多次请求不同的微服务，增加了客户端的复杂性。
 *  存在跨域请求，在一定场景下处理相对复杂。
 *  认证复杂，每个服务都需要独立认证。
 *  难以重构，随着项目的迭代，可能需要重新划分微服务。例如，可能将多个服务合并成一个或者将一个服务拆分成多个。如果客户端直接与微服务通信，那么重构将会很难实施。
 *  某些微服务可能使用了防火墙/浏览器不友好的协议，直接访问会有一定的困难。

以上问题可借助微服务网关解决。微服务网关是介于客户端和服务器端之间的中间层，所有的外部请求都会先经过微服务网关。

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

微服务网关封装了应用程序的内部结构，客户端只须跟网关交互，而无须直接调用特定微服务的接口。这样，开发就可以得到简化。不仅如此，使用微服务网关还有以下优点：

*  易于监控。可在微服务网关收集监控数据并将其推送到外部系统进行分析。
 *  易于认证。可在微服务网关上进行认证，然后再将请求转发到后端的微服务，而无须在每个微服务中进行认证。
 *  减少了客户端与各个微服务之间的交互次数。

## Zuul简介 ##

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

*  身份认证与安全：识别每个资源的验证要求，并拒绝那些与要求不符的请求。
 *  审查与监控：在边缘位置追踪有意义的数据和统计结果，从而带来精确的生产视图。
 *  动态路由：动态地将请求路由到不同的后端集群。。压力测试：逐渐增加指向集群的流量，以了解性能。
 *  负载分配：为每一种负载类型分配对应容量，并弃用超出限定值的请求。
 *  静态响应处理：在边缘位置直接建立部分响应，从而避免其转发到内部集群。
 *  多区域弹性：跨越AWS Region进行请求路由，旨在实现ELB（Elastic Load Balancing）  
    使用的多样化，以及让系统的边缘更贴近系统的使用者。

Spring Cloud对Zuul进行了整合与增强。目前，Zuul使用的默认HTTP客户端是Apache HTTP Client，也可以使用RestClient或者okhttp3.OkHttpClient 。 如果想要使用RestClient，可以设置`ribbon.restclient.enabled=true` ；想要使用okhttp3.OkHttpClient ，可以设置`ribbon.okhttp.enabled=true`。

参考：[https://github.com/Netflix/zuul][https_github.com_Netflix_zuul]

## 编写Zuul微服务网关 ##

我们先新建一个module：cloud-zuul，然后在pom文件中加入依赖。

<?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">
        <parent>
            <artifactId>spring-cloud-demo</artifactId>
            <groupId>com.cc.cloud</groupId>
            <version>1.0</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>cloud-zuul</artifactId>
    
        <dependencies>
            <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>
        </dependencies>
    
    </project>

`<artifactId>spring-cloud-starter-zuul</artifactId>`已经过期，推荐使用`<artifactId>spring-cloud-starter-netflix-zuul</artifactId>`

添加启动类,加入注解@EnableZuulProxy。

package com.cc.cloud.zuul;
    
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
    
    @SpringBootApplication
    @EnableEurekaClient
    @EnableZuulProxy
    public class ZuulApp { 
        public static void main(String[] args) { 
            SpringApplication.run(ZuulApp.class, args);
        }
    
    }

在启动类上添加注解 @EnableZuulProxy，声明一个 Zuul 代理。该代理使用 Ribbon 来定位注册在 Eureka Server 中的微服务；同时，该代理还整合了 Hystrix，从而实现了容错，所有经过 Zuul 的请求都会在 Hystrix 命令中执行。

然后我们加入配置文件。

eureka:
      client:
        serviceUrl:
          defaultZone: http://localhost:8888/eureka/
    server:
      port: 8769
    spring:
      application:
        name: cloud-zuul

然后我们就可以启动我们的eureka，order，member还有zuul服务了，然后通过[http://localhost:8769/cloud-service-order/order/members][http_localhost_8769_cloud-service-order_order_members]就可以访问我们的order服务了。其中cloud-service-order是我们的order微服务的application name。然后我们的zuul就会帮我们转发到order服务上去。

默认情况下，Zuul 会代理所有注册到 Eureka Server 的微服务，并且 Zuul 的路由规则如下  
`http: //ZUUL-HOST:ZUUL_PORT/微服务在Eureka上的serviced/**`会被转发到serviced 对应的微服务。

## Zuul集成Hystrix ##

Zuul已经整合hystrix，我们只需要在配置文件中开启endpoints即可。

eureka:
      client:
        serviceUrl:
          defaultZone: http://localhost:8888/eureka/
    server:
      port: 8769
    spring:
      application:
        name: cloud-zuul
    management:
      endpoints:
        web:
          exposure:
            include: "*"
      endpoint:
        health:
          show-details: always

然后我们在hystrix dashboard 中访问:http://localhost:8765/actuator/hystrix.stream

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

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

## Zuul的负载均衡 ##

Zuul可以使用Ribbon达到负载均衡的效果。

因为`<artifactId>spring-cloud-starter-netflix-zuul</artifactId>`中依赖了ribbon。

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

所以我们稍微改造一下我们的cloud-service-member服务。我们改造一下我们的controller。

package com.cc.cloud.member.controller;
    
    import com.cc.cloud.member.feign.OrderFeign;
    import com.google.common.collect.Lists;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.http.HttpStatus;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseStatus;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.List;
    
    @RestController
    @RequestMapping("/member")
    public class MemberController { 
    
        private OrderFeign orderFeign;
    
        @Value("${server.port}")
        private String port;
    
    
        @Autowired
        public void setOrderFeign(OrderFeign orderFeign) { 
            this.orderFeign = orderFeign;
        }
    
        @RequestMapping("/orders")
        @ResponseStatus(HttpStatus.OK)
        public List<String> getOrderList() { 
            return orderFeign.getAllOrderList();
        }
    
        @RequestMapping("/members")
        @ResponseStatus(HttpStatus.OK)
        public List<String> getMemberList() { 
            List<String> memberList = Lists.newArrayList();
            memberList.add("member 1");
            memberList.add("member 2");
            memberList.add("member 3");
            System.out.println(port);
            return memberList;
        }
    
    }

加入如下代码去区分我们的端口，并打印在控制台。

@Value("${server.port}")
     private String port;

然后我们分别启动member服务在8762和8763端口。然后通过Zuul代理访问我们的member服务。http://localhost:8769/cloud-service-member/member/members  
然后就可以看到我们的控制台分别打印了8762和8763。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 4]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 5]  
说明Zuul可以使用Ribbon达到负载均衡的效果。

## Zuul的路由端点 ##

当@EnableZuulProxy 与 Spring Boot Actuator 配合使用时，Zuul 会暴露一个路由管理端点/ routes。借助这个端点，可以方便、直观地査看以及管理 Zuul 的路由。

/ routes 端点的使用非常简单，使用 GET 方法访问该端点，即可返回 Zuul 当前映射的路由列表；使用 POST 方法访问该端点就会强制刷新 Zuul 当前映射的路由列表（尽管路由会自动刷新，Spring Cloud 依然提供了强制立即刷新的方式）。

由于spring-cloud-starter-netflix-zuul已经包含了 spring-boot-starter-actuator，因此之前编写的 cloud-zuul 已具备路由管理的能力。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 3]  
我们通过访问：http://localhost:8769/actuator/routes 就可以看到效果。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 6]

## Zuul路由配置详解 ##

我们已经编写了一个简单的 Zuul 网关，并让该网关代理了所有注册到 Eureka Server 的微服务。但在现实中可能只想让 Zuul 代理部分微服务，又或者需要对 URL 进行更加精确的控制。

Zuul 的路由配置非常灵活、简单，下面详细讲解 Zuul 的路由配置。

1.  自定义指定微服务的访问路径。

配置 zuul.routes.指定微服务的serviceId=指定路径即可。例如

zuul:
      routes:
        cloud-service-member: /api-member/**
        cloud-service-order: /api-order/**

这样`http://localhost:8769/api-member/**`就会被代理到`http://CLOUD-SERVICE-MEMBER-HOST:CLOUD-SERVICE-ORDER-PORT/**`

然后我们重启zuul服务，访问http://localhost:8769/api-member/member/orders 即可。

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

1.  忽略指定微服务

忽略服务非常简单，可以使用 zuul.ignored-services配置需要忽略的服务，多个用逗号分隔。例如

zuul:
      ignored-services: cloud-service-member,cloud-service-order

这样就可以让zuul忽略cloud-service-member和cloud-service-order微服务，只代理其他的服务。

1.  忽略所有微服务，只路由指定微服务

很多场景下，可能只想要让 Zuul 代理指定的微服务，此时可以将 zuul.ignored-services 设为’\*’。

zuul:
      routes:
        cloud-service-member: /api-member/**
        cloud-service-order: /api-order/**
        #默认情况下，只要引入了zuul后，就会自动一个默认的路由配置，但有些时候我们可能不想要默认的路由配置规则，想自己进行定义
        #忽略所有微服务，只路由指定的微服务
        ignored-services: "*"

这样就可以让zuul只路由cloud-service-member和cloud-service-order。

1.  同时指定微服务的 serviceId 和对应路径。例如

zuul:
      routes:
        api-member: #在该配置中，api-member只是给路由取得一个名称，可以任意起名。
          path: /cloud-member/**
          service-id: cloud-service-member
        api-order:
          path: /cloud-order/**
          service-id: cloud-service-order

这样`http://localhost:8769/cloud-member/**`就会被代理到`http://CLOUD-SERVICE-MEMBER-HOST:CLOUD-SERVICE-ORDER-PORT/**`

然后我们就可以通过： http://localhost:8769/cloud-member/member/orders 来访问我们的服务。

还有很多的路由匹配规则，比如直接配置url，正则表达式匹配等等，这里就不一一赘述了。有兴趣的同学可以参考一下：SpringCloud与Docker微服务架构实战-完整版.pdf  
或者可以参考一下如下的博文：

[springcloud-zuul 路由配置][springcloud-zuul]

[Spring Cloud Zuul中路由配置细节][Spring Cloud Zuul]

1.  路由前缀  
    配置`zuul.prefix`。例如：

zuul:
      #默认情况下，只要引入了zuul后，就会自动一个默认的路由配置，但有些时候我们可能不想要默认的路由配置规则，想自己进行定义
      #忽略所有微服务，只路由指定的微服务
      ignored-services: '*'
      routes:
        api-member:
          path: /cloud-member/**
          service-id: cloud-service-member
        api-order:
          path: /cloud-order/**
          service-id: cloud-service-order
      #为所有路由都增加一个通过的前缀
      #需要访问/api/path...
      prefix: /api

然后我们就可以通过http://localhost:8769/api/cloud-order/order/members 访问我们的服务了。

这里还要提到一个配置就是strip-prefix，默认是true，表示全局配置去掉前缀。  
前面我们通过`zuul.prefix`配置使得我们访问`http://localhost:8769/api/cloud-order/**`的时候会代理到`http://CLOUD-SERVICE-ORDER-HOST:CLOUD-SERVICE-ORDER-PORT/**`，如果我们把strip-prefix 配置成false，那么就会使得`http://localhost:8769/api/cloud-order/**` 代理到`http://CLOUD-SERVICE-ORDER-HOST:CLOUD-SERVICE-ORDER-PORT/api/**`

例如:

我们的application.yml的配置如上，然后我们在controller中更改做如下配置：

package com.cc.cloud.order.controller;
    
    import com.cc.cloud.order.feign.MemberFeign;
    import com.google.common.collect.Lists;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.HttpStatus;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseStatus;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.List;
    @RestController
    @RequestMapping("/api/order")
    public class OrderController { 
    
        private MemberFeign memberFeign;
    
        @Autowired
        public void setMemberFeign(MemberFeign memberFeign) { 
            this.memberFeign = memberFeign;
        }
    
        @RequestMapping("/members")
        @ResponseStatus(HttpStatus.OK)
        public List<String> getMemberList() { 
            return memberFeign.getAllMemberList();
        }
    
    
        @GetMapping("/orders")
        @ResponseStatus(HttpStatus.OK)
        public List<String> getOrders() { 
            List<String> orders = Lists.newArrayList();
            orders.add("order 1");
            orders.add("order 2");
            return orders;
        }
    }

我们的`@RequestMapping("/order")`需要更改为`@RequestMapping("/api/order")`，这样我们才能访问到我们的服务。

现在我们通过访问http://localhost:8769/api/cloud-order/order/members 即可访问到我们的服务。

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

1.  忽略某些路径  
    有时需要更细粒度的路由控制。例如，想让 Zuul 代理某个微服务，同时又想保护该微服务的某些敏感路径。此时，可使用ignored-patterns，指定忽略的正则。例如：

zuul:
     ignored-patterns: /**/admin/**

表示忽略所有包含admin的路径，具体的代码演示这里就不展示了。

## Zuul的安全与Header ##

这个可以参考： [Spring Cloud之Zuul(四)：Zuul的安全与Header及使用Zuul上传文件][Spring Cloud_Zuul_Zuul_Header_Zuul] ，这里就不做代码的展示了。

关于zuul的内容还有很多，比如zuul的过滤器，文件上传，Header设置等等，这里就不做过多的介绍了。感兴趣的可以看看：SpringCloud与Docker微服务架构实战-完整版.pdf

## 参考 ##

[【微服务】Zuul的必要性][Zuul]

[使用Zuul构建API Gateway][Zuul_API Gateway]

[使用Zuul聚合微服务][Zuul 1]

[Spring Cloud微服务（3）之网关Zuul][Spring Cloud_3_Zuul]

[zuul实现Cors跨域的两种方式（https）][zuul_Cors_https]

[Spring Cloud Zuul中路由配置细节][Spring Cloud Zuul]

## 源代码 ##

[https://gitee.com/cckevincyh/spring-cloud-demo/tree/zuul][https_gitee.com_cckevincyh_spring-cloud-demo_tree_zuul]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70]: /images/20230809/b38fa6eb42054722a5c2b0bffbb227b0.png
[https_github.com_Netflix_zuul]: https://github.com/Netflix/zuul
[http_localhost_8769_cloud-service-order_order_members]: http://localhost:8769/cloud-service-order/order/members
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 1]: /images/20230809/6bc317041069488e90c0862b1effec28.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 2]: /images/20230809/3c44338130a8463bbc38c3359ad2ab76.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 3]: /images/20230809/b9c3957d5696451594459ede150339de.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 4]: /images/20230809/f4e60e8b89cf46af9f60f9385a3247da.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 5]: /images/20230809/170c2479017f40f9b35b93520eb292c3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 6]: /images/20230809/53957b07aa9340c68ebb151d1e1a17d7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 7]: /images/20230809/f00960139e5446b1b0d4fdc9932efca8.png
[springcloud-zuul]: https://www.jianshu.com/p/4c3bc42640d8
[Spring Cloud Zuul]: https://blog.csdn.net/u012702547/article/details/78399406
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nja2V2aW5jeWg_size_16_color_FFFFFF_t_70 8]: /images/20230809/c3236bc3a94c493697c2565bea186120.png
[Spring Cloud_Zuul_Zuul_Header_Zuul]: https://blog.csdn.net/starskyboy/article/details/85012223
[Zuul]: https://blog.csdn.net/hongwei15732623364/article/details/82050304
[Zuul_API Gateway]: https://blog.csdn.net/zhanglh046/article/details/78651993/
[Zuul 1]: https://blog.csdn.net/chengqiuming/article/details/80860981
[Spring Cloud_3_Zuul]: https://blog.csdn.net/u013084910/article/details/76383184
[zuul_Cors_https]: https://segmentfault.com/a/1190000015870281
[https_gitee.com_cckevincyh_spring-cloud-demo_tree_zuul]: https://gitee.com/cckevincyh/spring-cloud-demo/tree/zuul