Spring Cloud:网关Gateway

拼搏现实的明天。 2024-04-21 08:09 79阅读 0赞

> #### ✨ Spring Cloud:网关Gateway ####
> 
>  *  微服务网关概述
>  *   *  为什么需要微服务网关
>      *  服务网关的介绍
>  *  Getway
>  *   *  基本介绍
>      *  微服务架构中网关所处位置
>      *  三大核心概念
>      *  工作流程
>  *  入门案例搭建
>  *   *  新建模块\*\*cloud-gateway-gateway9527\*\*
>      *  导入依赖
>      *  application.yml
>      *  主启动类
>      *  实现动态路由
>      *  测试
>  *  Predicate 断言
>  *   *  基本介绍
>      *  Route Predicate Factories
>      *  常用的Route Predicate
>      *   *  
>  *  Filter过滤器
> 
>   
> **?个人主页:[不断前进的皮卡丘][Link 1]**  
> **?博客描述:梦想也许遥不可及，但重要的是追梦的过程，用博客记录自己的成长，记录自己一步一步向上攀登的印记**  
> **?个人专栏:[微服务专栏][Link 2]**

## 微服务网关概述 ##

### 为什么需要微服务网关 ###

不同的微服务一般来说会有不同的网络地址，客户端在访问的时候，如果需要记住这些地址的话，其实是很复杂的，而且也很难进行维护  
![在这里插入图片描述][2a3e71abf72c4e9ea17cb2caee54e8f6.png]  
  
如果让客户端直接与各个微服务通讯，可能会有很多问题：

*  客户端会请求多个不同的服务，需要维护不同的请求地址，增加开发难度
 *  在某些场景下存在跨域请求的问题
 *  加大身份认证的难度，每个微服务需要独立认证

**因此，我们需要一个微服务网关，介于客户端与服务器之间的中间层，所有的外部请求都会先经过微服 务网关。客户端只需要与网关交互，只知道一个网关地址即可，这样简化了开发还有以下优点：**  
1、易于监控  
2、易于认证  
3、减少了客户端与各个微服务之间的交互次数  
![在这里插入图片描述][5056b702499a4350823b3f9d2bf9532f.png]

### 服务网关的介绍 ###

*  API网关是一个服务器，是系统对外的唯一入口。API网关封装了系统内部架构，为每个客户端提供 一个定制的API。API网关方式的核心要点是，所有的客户端和消费端都通过统一的网关接入微服务，在 网关层处理所有的非业务功能。通常，网关也是提供REST/HTTP的访问API。服务端通过API-GW注册和 管理服务。
 *  API 网关就像整个微服务系统的门面一样，是系统对外的唯一入口。有了它，客户端会先将请求发送到 API 网关，然后由 API 网关根据请求的标识信息将请求转发到微服务实例。
 *  网关具有的职责，如身份验证、监控、负载均衡、缓存、请求分片与管理、静态响应处理。当然，最主 要的职责还是与“外界联系”。

> **对于服务数量众多、复杂度较高、规模比较大的系统来说，使用 API 网关具有以下好处：**
> 
>  *  **客户端通过 API 网关与微服务交互时，客户端只需要知道 API 网关地址即可，而不需要维护大量的服务地址，简化了客户端的开发。**
>  *  **客户端直接与 API 网关通信，能够减少客户端与各个服务的交互次数。**
>  *  **客户端与后端的服务耦合度降低。**
>  *  **节省流量，提高性能，提升用户体验。**
>  *  **API 网关还提供了安全、流控、过滤、缓存、计费以及监控等 API 管理功能。**

> **常见的 API 网关实现方案主要有以下 5 种：**
> 
>  *  **Spring Cloud Gateway**
>  *  **Spring Cloud Netflix Zuul**
>  *  **Kong**
>  *  **Nginx+Lua**
>  *  **Traefik**

## Getway ##

### 基本介绍 ###

官网:[https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/][https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html]  
![在这里插入图片描述][7b8b378cc71d48498138b029ed3a67a8.png]  
  
**Geteway是原Zuul1.x版的替代**  
![在这里插入图片描述][18751d6d88cf4d9489ad12919e5b971c.png]

*  Gateway是在spring生态系统之上构建的API网关服务，基于Spring5，SpringBoot2和Project Reactor等技术。
 *  Gateway旨在提供一种简单而有效的方式来对API进行路由，以及提供一些强大的过滤器功能，例如：熔断、限流、重试等
 *  SpringCloud Gateway是SpringCloud的一个全新项目，基于Spring5.0+SpringBoot2.0和Project Reactor等技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的API路由管理方式。
 *  为了提升网关的性能，SpringCloud Gatway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的**Reactor**模式通讯框架**Netty**。
 *  SpringCloud Gateway的目标提供统一的路由方式且基于Filter链的方式提供了网关基本的功能，例如：安全、监控/指标、和限流。
 *  可以用来做反向代理、 鉴权、 流量控制、熔断、日志监控。

### 微服务架构中网关所处位置 ###

![在这里插入图片描述][8e229e38014d4fcbabfdf850b3b80545.png]

### 三大核心概念 ###

![在这里插入图片描述][f2db6f59ed84492b8f1965bd625655cd.png]

1.  路由（route） 路由是网关最基础的部分，路由信息由一个ID、一个目的URL、一组断言工厂和一  
    组Filter组成。如果断言为真，则说明请求URL和配置的路由匹配。
2.  断言（predicates） 参考Java8中的断言函数，Spring Cloud Gateway中的断言函数输入类型是  
    Spring5.0框架中的ServerWebExchange。Spring Cloud Gateway中的断言函数允许开发者去定  
    义匹配来自Http Request中的任何信息，比如请求头和参数等。
3.  过滤器（filter） 一个标准的Spring webFilter，Spring Cloud Gateway中的Filter分为两种类型，  
    分别是Gateway Filter和Global Filter。过滤器Filter可以对请求和响应进行处理。

**Web请求，通过一些匹配条件，定位到真正的服务节点。并在这个转发过程的前后，进行一些精细化控制。Predicate就是我们的匹配条件： 而Filter，就是可以理解为一个无所不能的拦截器。有了这两个元素，再加上目标uri,就可以实现一个具体的路由了。**

### 工作流程 ###

官网:[https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/\#gateway-how-it-works][https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html_gateway-how-it-works]  
![在这里插入图片描述][4bd9c27f78764f2eb743675ef56996d2.png]

*  客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping中找到与请求匹配的路由，将其发送到Gateway Web Handler。
 *  Handler再通过指定的过滤器链来将请求发送给我们实际的服务执行业务逻辑，然后返回。
 *  过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前（“pre”）或之后(“post”)执行业务逻辑。
 *  Filter在\*\*"pre"类型**的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等，在**"post"类型\*\*的过滤器中可以做响应内容、响应头的修改，日志的输出，流量控制等有着非常重要的作用
 *  Predicate 就是路由的匹配条件，而 Filter 就是对请求和响应进行精细化控制的工具。有了这两个元素，再加上目标 URI，就可以实现一个具体的路由了。

## 入门案例搭建 ##

### 新建模块**cloud-gateway-gateway9527** ###

### 导入依赖 ###

<?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>cloud2022</artifactId>
            <groupId>com.zyh.springcloud</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>cloud-gateway-gateway9527</artifactId>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
    
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-gateway</artifactId>
            </dependency>
            <dependency>
                <groupId>com.zyh.springcloud</groupId>
                <artifactId>cloud-api-commons</artifactId>
                <version>1.0-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <scope>runtime</scope>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    </project>

### application.yml ###

server:
      port: 9527
    spring:
      application:
        name: cloud-gateway
    
    eureka:
      instance:
        hostname: cloud-gateway-service
      client:
          register-with-eureka: true
          fetch-registry: true
          service-url:
              defaultZone: http://localhost:7001/eureka

### 主启动类 ###

![在这里插入图片描述][5ce0fdae62c74582b00f39874be72af3.png]

### 实现动态路由 ###

如果说这个时候，我们不想暴露8001端口，希望在8001外面套一层9527，我们可以在yml中进行配置

server:
      port: 9527
    spring:
      application:
        name: cloud-gateway
      cloud:
        gateway:
          routes:
            - id: payment_routh #路由的ID，没有固定规则但要求唯一，建议配合服务名
              uri: http://localhost:8001   #匹配后提供服务的路由地址
              predicates:
                - Path=/payment/get/**   #断言,路径相匹配的进行路由
                -
            - id: payment_routh2
              uri: http://localhost:8001
              predicates:
                - Path=/payment/lb/**   #断言,路径相匹配的进行路由
    
    eureka:
      instance:
        hostname: cloud-gateway-service
      client:
        register-with-eureka: true
        fetch-registry: true
        service-url:
          defaultZone: http://localhost:7001/eureka

### 测试 ###

启动7001：cloud-eureka-server7001  
启动8001：cloud-provider-payment8001  
启动9527网关：cloud-gateway-gateway9527  
![在这里插入图片描述][b779369d84124fe2b52d5ca2922c8854.png]  
  
添加网关前： [http://localhost:8001/payment/get/31][http_localhost_8001_payment_get_31]  
![在这里插入图片描述][fb1e174a2bbf4a9cab8ee4a5f0bc4915.png]  
  
添加网关后： [http://localhost:9527/payment/get/31][http_localhost_9527_payment_get_31]  
![在这里插入图片描述][ece022b1791e4591b1cfc2de77c3f92e.png]  
  
我们知道，肯定会有负载均衡的情况，所以端口号不应该写死，应该写成服务的名字。  
![在这里插入图片描述][8a257fb4bb754b599d236dae73cab7f0.png]

## Predicate 断言 ##

### 基本介绍 ###

Spring Cloud Gateway 通过 Predicate 断言来实现 Route 路由的匹配规则。  
也就是说Predicate 是路由转发的判断条件，请求只有满足了 Predicate 的条件，才会被转发到指定的服务上进行处理。

使用 Predicate 断言需要注意以下 3 点：

*  Route 路由与 Predicate 断言的对应关系为“一对多”，一个路由可以包含多个不同断言。
 *  一个请求想要转发到指定的路由上，就必须同时匹配路由上的所有断言。
 *  当一个请求同时满足多个路由的断言条件时，请求只会被首个成功匹配的路由转发。
 *  ![在这里插入图片描述][9f30174d8bd74304a41e11d0844ccfff.png]

### Route Predicate Factories ###

![在这里插入图片描述][0b4c2e427fad4f65a44ae85d396682c9.png]  
  
Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapper基础框架的一部分。  
Spring Cloud Gateway包括许多内置的Route Predicate工厂。所有这些Predicate都与HTTP请求的不同属性匹配。多个Route Predicate工厂可以进行组合  
Spring Cloud Gateway创建Route对象时，使用RoutePredicateFactory创建Predicate对象，Predicate对象可以赋值给 Route。Spring Cloud Gateway包含许多内置的Route Predicate Factories。  
所有这些谓词都匹配HTTP请求的不同属性。多种谓词工厂可以组合，并通过逻辑and 。

### 常用的Route Predicate ###

####  ####

server:
      port: 9527
    
    spring:
      application:
        name: cloud-gateway
      cloud:
        gateway:
          discovery:
            locator:
              enabled: true  #开启从注册中心动态创建路由的功能，利用微服务名进行路由
          routes:
            - id: payment_routh #路由的ID，没有固定规则但要求唯一，建议配合服务名
              #uri: http://localhost:8001   #匹配后提供服务的路由地址
              uri: lb://cloud-payment-service
              predicates:
                - Path=/payment/get/**   #断言,路径相匹配的进行路由
    
            - id: payment_routh2
              #uri: http://localhost:8001   #匹配后提供服务的路由地址
              uri: lb://cloud-payment-service
              predicates:
                - Path=/payment/lb/**   #断言,路径相匹配的进行路由
                #- After=2020-03-08T10:59:34.102+08:00[Asia/Shanghai]
                #- Cookie=username,zhangshuai #并且Cookie是username=zhangshuai才能访问
                #- Header=X-Request-Id, \d+ #请求头中要有X-Request-Id属性并且值为整数的正则表达式
                #- Host=**.atguigu.com
                #- Method=GET
                #- Query=username, \d+ #要有参数名称并且是正整数才能路由
    
    
    eureka:
      instance:
        hostname: cloud-gateway-service
      client:
        service-url:
          register-with-eureka: true
          fetch-registry: true
          defaultZone: http://localhost:7001/eureka

![在这里插入图片描述][91c5c54008d94c2ebd8b68a459528bf4.png]

## Filter过滤器 ##

[Spring Cloud : Gateway 网关过滤器 GatewayFilter][Spring Cloud _ Gateway _ GatewayFilter]

[Link 1]: https://blog.csdn.net/qq_52797170?spm=1010.2135.3001.5343
[Link 2]: https://blog.csdn.net/qq_52797170/category_11917770.html?spm=1001.2014.3001.5482
[2a3e71abf72c4e9ea17cb2caee54e8f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/09f0d2a2c7464b2a8d4f4bf6f6988ae8.png
[5056b702499a4350823b3f9d2bf9532f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/cd88e2ed106a476885f9bb096dcbcfb9.png
[https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html]: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/
[7b8b378cc71d48498138b029ed3a67a8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/e5f68b9fe77b4e7b87b208353a3bcdf2.png
[18751d6d88cf4d9489ad12919e5b971c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/aaf9ed10e386480b992ac49d1cb0af0c.png
[8e229e38014d4fcbabfdf850b3b80545.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/3bd8ba79a63541fcb6766337e0c1b1c2.png
[f2db6f59ed84492b8f1965bd625655cd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/5f18f609e7044b52b157dd97bd71a9b8.png
[https_cloud.spring.io_spring-cloud-static_spring-cloud-gateway_2.2.1.RELEASE_reference_html_gateway-how-it-works]: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/#gateway-how-it-works
[4bd9c27f78764f2eb743675ef56996d2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/3bf4e9512126464b8f5a9bd200ad459c.png
[5ce0fdae62c74582b00f39874be72af3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/b806acd3f4d24956ae3f78d5262c5400.png
[b779369d84124fe2b52d5ca2922c8854.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/62d653acf6c74b9da48809e3bfb1ea54.png
[http_localhost_8001_payment_get_31]: http://localhost:8001/payment/get/31
[fb1e174a2bbf4a9cab8ee4a5f0bc4915.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/ba4b7a6f1b0446fa81adf6460378af25.png
[http_localhost_9527_payment_get_31]: http://localhost:9527/payment/get/31
[ece022b1791e4591b1cfc2de77c3f92e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/8dfceb194eda4bb7897633063c73f152.png
[8a257fb4bb754b599d236dae73cab7f0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/9f650fc8c119492f9cff91b7731ccb55.png
[9f30174d8bd74304a41e11d0844ccfff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/7dd1187526ca430d8badc7602691b760.png
[0b4c2e427fad4f65a44ae85d396682c9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/9940d5494edc4d518733521999bd4950.png
[91c5c54008d94c2ebd8b68a459528bf4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/f560822261df4c8b89060725e61c21f5.png
[Spring Cloud _ Gateway _ GatewayFilter]: https://blog.csdn.net/zouliping123456/article/details/116128179