SpringCloudGateway网关原理与配置

缺乏、安全感 2024-03-16 23:00 78阅读 0赞

一、概述

二、基本术语与工作原理

三、网关的配置与使用

四、路由谓语和过滤器的配置方式

五、附录

1. 示例代码

分布式系统中，微服务网关是很重要的组件，面向入口流量的 API 网关可以实现路由管理、权限验证、熔断限流等功能。

### 一、概述 ###

Spring Cloud Gateway 是 SpringCloud 官方提供的网关组件，只需通过简单的配置就可以实现强大的路由管理功能。

### 二、基本术语与工作原理 ###

Spring Cloud Gateway 包含三个重要的部分：

*  **路由（Route）**：网关的基础部分，路由包含 ID、URI、一组谓语和一组过滤器，通过谓语返回 `true` 来匹配路由。
 *  **谓语（Predicate）**：通过 Java 8 的 `Predicate<T>` 接口实现，可以通过任何方式匹配路由，例如请求头、参数等。
 *  **过滤器（Filter）**：通常以过滤器链的形式存在，可以访问和修改请求和响应，业务逻辑一般在过滤器中实现。

当客户端请求 Spring Cloud Gateway，首先通过网关的 Handler Mapping 匹配路由，匹配通过后该请求会发送到网关的 Web Handler，这个 Handler 会运行一组特定的过滤器链。

过滤器会在代理请求之前（`pre` 阶段）或响应之后（`post` 阶段）运行代码逻辑。

![1593d4d8f2b2ebbd98c4fde6d2174c69.png][]

### 三、网关的配置与使用 ###

在 Spring 项目中集成 Spring Cloud Gateway 需要配置下面依赖：

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

可以使用 `spring.cloud.gateway.enabled=false` 配置禁用网关功能。

> Spring Cloud Gateway 是基于 Spring WebFlux 实现的，不是传统的 Servlet 容器框架。

### 三、路由谓语和过滤器的配置方式 ###

Spring Cloud Gateway 配置谓语和过滤器提供了两种方式。

**快捷配置**

快捷方式使用 `=` 连接谓语或过滤器名称和参数，参数按顺序使用 `,` 分隔。

spring.cloud.gateway.routes:
      - id: shortcut
        uri: https://example.org
        predicates:
          - Path=/red/**
        filters:
          - RewritePath=/red(?<segment>/?.*), $\{segment}

**参数展开配置**

参数展开方式使用 `name` 属性来指定谓语或过滤器名称，使用 `args` 属性来指定参数。

spring.cloud.gateway.routes:
      - id: full
        uri: https://example.org
        predicates:
          - name: Path
            args:
              patterns: /red/**
        filters:
          - name: RewritePath
            args:
              regexp: /red(?<segment>/?.*)
              replacement: $\{segment}

两种方式实现功能一致，按个人爱好选择配置。

谓语和过滤器都是有序的，也能说是有优先级的，优先级高的 `pre` 部分先执行，`post` 部分后执行。

### 四、附录 ###

#### 1. 示例代码 ####

Gitee 仓库：

https://gitee.com/code\_artist/springcloud

Github 仓库：

https://github.com/AiJiangnan/springcloud

[1593d4d8f2b2ebbd98c4fde6d2174c69.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/fce0da1cd8884279a419bab07d38e750.png