Spring Cloud Gateway

4.0.5

该项目提供了一个构建在 Spring 生态系统之上的 API 网关，包括：Spring 6、Spring Boot 3 和 Project Reactor。 Spring Cloud Gateway 旨在提供一种简单而有效的方法来路由到 API，并为它们提供横切关注点，例如：安全性、监控/指标和弹性。

如何包含Spring Cloud Gateway

要在您的项目中包含 Spring Cloud Gateway，请使用组 ID 为 org.springframework.cloud 和工件 ID 为 spring-cloud-starter-gateway 的启动器。有关使用当前 Spring Cloud Release Train 设置构建系统的详细信息，请参阅 Spring Cloud 项目页面。

如果包含启动器，但不希望启用网关，请设置 spring.cloud.gateway.enabled=false 。

词汇表

• Route：网关的基本构建块。它由 ID、目标 URI、谓词集合和过滤器集合定义。如果聚合谓词为真，则路由匹配。
• Predicate：这是一个 Java 8 Function Predicate。输入类型是 Spring Framework ServerWebExchange 。这使您可以匹配 HTTP 请求中的任何内容，例如标头或参数。
• Filter：这些是使用特定工厂构建的 GatewayFilter 的实例。在这里，您可以在发送下游请求之前或之后修改请求和响应。

它是如何工作的

下图提供了 Spring Cloud Gateway 工作原理的高级概述：

客户端向 Spring Cloud Gateway 发出请求。如果 Gateway Handler Mapping 确定请求与路由匹配，则将其发送到 Gateway Web Handler。此处理程序通过特定于请求的过滤器链运行请求。过滤器被虚线分开的原因是过滤器可以在发送代理请求之前和之后运行逻辑。执行所有“预”过滤器逻辑。然后进行代理请求。发出代理请求后，运行“post”过滤器逻辑。

配置路由谓词工厂和网关过滤器工厂

有两种配置谓词和过滤器的方法：快捷方式和完全扩展的参数。下面的大多数示例都使用快捷方式。

名称和参数名称在每个部分的第一句或第二句中列为 code 。这些参数通常按快捷方式配置所需的顺序列出。

快捷方式配置

快捷方式配置由过滤器名称识别，后跟等号 ( = )，然后是用逗号分隔的参数值 ( , )。

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: https://example.org
        predicates:
        - Cookie=mycookie,mycookievalue

前面的示例使用两个参数定义了 Cookie Route Predicate Factory，cookie 名称 mycookie 和匹配 mycookievalue 的值。

完全扩展的参数

完全扩展的参数看起来更像是带有名称/值对的标准 yaml 配置。通常，会有一个 name 键和一个 args 键。 args 键是键值对的映射，用于配置谓词或过滤器。

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: https://example.org
        predicates:
        - name: Cookie
          args:
            name: mycookie
            regexp: mycookievalue

这是上面显示的 Cookie 谓词的快捷方式配置的完整配置。

路由谓词工厂

Spring Cloud Gateway 将路由作为 Spring WebFlux HandlerMapping 基础设施的一部分进行匹配。 Spring Cloud Gateway 包含许多内置的路由谓词工厂。所有这些谓词都匹配 HTTP 请求的不同属性。您可以将多个路由谓词工厂与逻辑 and 语句结合起来。

GatewayFilter Factories

路由过滤器允许以某种方式修改传入的 HTTP 请求或传出的 HTTP 响应。路由过滤器的范围是特定路由。 Spring Cloud Gateway 包括许多内置的 GatewayFilter 工厂。

全局过滤器

GlobalFilter 接口与 GatewayFilter 具有相同的签名。这些是有条件地应用于所有路由的特殊过滤器。