初识服务网关之Spring Cloud Gateway

可以实现接口或继承创建自定义过滤器。@ComponentConfig> {@Override// 检查请求头中是否存在 Authorizationif (!// 可以添加配置属性功能/特性ZuulNginxKongTraefik架构集成Spring Cloud 环境Spring Cloud 兼容独立架构独立架构独立架构AWS 云平台适用场景微服务、Spring Cloud 项目Netflix 微服

完颜振江

1137人浏览 · 2024-11-11 14:17:07

完颜振江 · 2024-11-11 14:17:07 发布

Spring Cloud Gateway 是 Spring Cloud 生态系统中提供的一种 API 网关解决方案，专为微服务架构设计。它主要用于路由请求、处理流量转发、增强安全性、以及应用内的负载均衡。Spring Cloud Gateway 旨在替代 Netflix Zuul，以更现代化的方式提供高效、可扩展的网关服务。

Spring Cloud Gateway 的特点

动态路由：基于请求参数、请求头、路径、权重等多种条件进行动态路由。
过滤器链：使用过滤器链的概念，允许在请求进入和返回时进行处理，比如身份验证、限流、监控等。
集成负载均衡：和 Spring Cloud LoadBalancer 集成，支持负载均衡。
性能优越：基于 Netty 的底层实现，性能优于基于 Servlet 的 Zuul。
实时配置更新：支持与 Spring Cloud Config 集成，实时动态更新路由配置。

Spring Cloud Gateway 核心概念

Route（路由）：定义了请求的转发路径，每个路由包含了目标 URI 和一组条件，当请求满足条件时就会被路由到相应的 URI。
Predicate（断言）：用来匹配请求条件，只有当请求满足断言时，才会被路由到指定的目标 URI。常见断言有路径匹配（Path）、请求头匹配（Header）、参数匹配（Query Param）等。
Filter（过滤器）：用于拦截和处理请求或响应，能够进行修改、增强请求，如身份认证、限流、日志记录等。可以使用内置的过滤器，也可以自定义。

Spring Cloud Gateway 使用示例

假设我们要实现一个简单的网关配置，以下是基于 Java 的代码配置方式：

import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class GatewayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route("example_route", r -> r.path("/example/**")
                        .filters(f -> f.addRequestHeader("X-Custom-Header", "Value"))
                        .uri("http://example.com"))
                .build();
    }
}

在这个示例中：

route：定义了一个 ID 为 example_route 的路由，当请求的路径以 /example/ 开头时，它会被转发到 http://example.com。
filters：添加了一个自定义请求头 X-Custom-Header。

常见的内置过滤器

Spring Cloud Gateway 提供了许多内置过滤器，以下是几个常见的过滤器：

AddRequestHeader：添加请求头。
AddRequestParameter：添加请求参数。
RewritePath：重写请求路径。
SetStatus：设置返回状态码。
RateLimiter：限流过滤器，配合 Redis 使用，控制流量。

自定义过滤器

可以实现 GatewayFilter 接口或继承 AbstractGatewayFilterFactory 创建自定义过滤器。例如，下面是一个自定义的身份验证过滤器示例：

import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;

@Component
public class AuthGatewayFilterFactory extends AbstractGatewayFilterFactory<AuthGatewayFilterFactory.Config> {

    public AuthGatewayFilterFactory() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            // 检查请求头中是否存在 Authorization
            if (!exchange.getRequest().getHeaders().containsKey("Authorization")) {
                exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
                return exchange.getResponse().setComplete();
            }
            return chain.filter(exchange);
        };
    }

    public static class Config {
        // 可以添加配置属性
    }
}

Spring Cloud Gateway 高级功能

集成熔断器：通过与 Resilience4j 或 Hystrix 集成实现熔断功能。
集成限流：内置的限流过滤器可以和 Redis 结合使用，进行 IP、用户级别的限流。
集成监控：支持与 Spring Boot Actuator 集成，可以提供丰富的网关指标监控。
灰度发布：可以基于路由的权重等实现简单的流量分配，实现灰度发布的功能。

配置 Spring Cloud Gateway

可以通过 application.yml 配置路由：

spring:
  cloud:
    gateway:
      routes:
        - id: example_route
          uri: http://example.com
          predicates:
            - Path=/example/**
          filters:
            - AddRequestHeader=X-Custom-Header, Value

应用案例

以下是几个 Spring Cloud Gateway 的应用案例，可以更好地理解它在实际项目中的应用方式：

1. 微服务 API 网关

在一个典型的微服务架构中，我们可以使用 Spring Cloud Gateway 作为统一的 API 入口，将请求分发到不同的微服务中。通过路由和过滤器，我们可以实现以下功能：

身份认证：在请求到达微服务之前进行身份验证，避免各个微服务重复实现。
流量控制：通过限流过滤器，实现基于 IP 或用户的请求限制，防止流量过大导致服务崩溃。
日志记录：在请求进入网关时记录日志，方便跟踪和分析请求。

示例配置：

spring:
  cloud:
    gateway:
      routes:
        - id: auth_service
          uri: lb://AUTH-SERVICE
          predicates:
            - Path=/auth/**
          filters:
            - StripPrefix=1
            - AddRequestHeader=Authorization, "Bearer my-token"
        - id: order_service
          uri: lb://ORDER-SERVICE
          predicates:
            - Path=/order/**
          filters:
            - StripPrefix=1
            - RequestRateLimiter=key-resolver=#bean(ipKeyResolver),redis-rate-limiter=2,1

在这个配置中：

auth_service 路由到 AUTH-SERVICE，路径以 /auth/ 开头的请求会转发到该服务，添加了 Authorization 请求头。
order_service 路由到 ORDER-SERVICE，对 /order/ 开头的请求进行限流，每秒 2 个请求，爆发容量为 1。

2. 电商平台灰度发布

在电商平台开发中，当一个新版本发布时，可能不希望所有用户同时访问新版本。可以使用 Spring Cloud Gateway 的权重路由和负载均衡功能进行灰度发布，比如按用户比例分流一部分请求到新版本。

示例代码：

spring:
  cloud:
    gateway:
      routes:
        - id: old_version
          uri: lb://SHOP-SERVICE-V1
          predicates:
            - Path=/shop/**
          filters:
            - Weight=shop-group, 80
        - id: new_version
          uri: lb://SHOP-SERVICE-V2
          predicates:
            - Path=/shop/**
          filters:
            - Weight=shop-group, 20

在这里，Weight 过滤器按权重将流量分配到两个不同的服务实例 SHOP-SERVICE-V1 和 SHOP-SERVICE-V2，其中 80% 流量进入旧版本，20% 流量进入新版本。

3. API 限流与安全防护

在金融、保险等行业的系统中，API 请求的频次通常需要进行限制，以防止恶意请求。Spring Cloud Gateway 提供的 RequestRateLimiter 过滤器可以配合 Redis 实现限流。此外，还可以通过自定义过滤器实现请求来源的 IP 白名单功能，以进一步增强安全性。

代码示例：

spring:
  cloud:
    gateway:
      routes:
        - id: payment_service
          uri: lb://PAYMENT-SERVICE
          predicates:
            - Path=/payment/**
          filters:
            - RequestRateLimiter=redis-rate-limiter,10,20
            - AddRequestParameter=source, gateway

该配置对 /payment/ 请求进行限流，允许每秒最多 10 个请求，爆发时最大并发量 20。AddRequestParameter 过滤器则添加了一个 source=gateway 参数，以便服务端能识别请求来自网关。

4. 请求路径重写

在一些应用场景中，我们需要将客户端的请求路径重写成适合后端的路径格式。例如，客户端请求路径为 /user/profile/{id}，而后端服务只接受 /profile/{id} 格式的请求。

配置如下：

spring:
  cloud:
    gateway:
      routes:
        - id: user_service
          uri: lb://USER-SERVICE
          predicates:
            - Path=/user/profile/**
          filters:
            - RewritePath=/user/profile/(?<id>.*), /profile/${id}

在此配置中，RewritePath 过滤器会将 /user/profile/{id} 转换为 /profile/{id}，从而兼容后端的路径结构。

5. 多租户支持

在 SaaS（Software as a Service）应用中，可能需要根据不同租户分发请求。Spring Cloud Gateway 可以根据请求的 Tenant-ID 请求头分发到不同的服务实例或租户数据库。例如，某些请求可能需要转发到专为 VIP 用户准备的服务。

示例配置：

spring:
  cloud:
    gateway:
      routes:
        - id: vip_service
          uri: lb://VIP-SERVICE
          predicates:
            - Header=TENANT-ID, vip
          filters:
            - AddRequestHeader=User-Type, VIP
        - id: general_service
          uri: lb://GENERAL-SERVICE
          predicates:
            - Path=/**

此配置中，如果请求头 TENANT-ID 的值为 vip，请求会被转发到 VIP-SERVICE；否则转发到 GENERAL-SERVICE。这实现了多租户支持。

6. 图像处理代理

有时需要将图像服务请求代理到后端服务，同时对图像大小、格式等进行调整。可以使用 Spring Cloud Gateway 配合图像处理 API 完成类似功能。

spring:
  cloud:
    gateway:
      routes:
        - id: image_service
          uri: lb://IMAGE-SERVICE
          predicates:
            - Path=/images/**
          filters:
            - ModifyResponseBody=application/json, application/json, "transformFunction"

在这里，我们对 /images/ 路径的请求应用 ModifyResponseBody 过滤器，使用指定的函数 transformFunction 对响应进行图像处理，例如修改图像格式或尺寸。

安装配置教程

要在 Spring Boot 项目中使用 Spring Cloud Gateway，需要进行安装和基本配置。下面是一个详细的安装配置教程，帮助您快速搭建并配置 Spring Cloud Gateway。

1. 环境准备

JDK：JDK 版本 8 或更高。
Spring Boot：Spring Boot 2.1 或更高版本。
Spring Cloud：Spring Cloud Hoxton 版本或更高。

2. 创建 Spring Boot 项目

可以通过以下三种方式创建 Spring Boot 项目：

Spring Initializr 网站：
- 访问 Spring Initializr。
- 选择项目类型为 Maven，语言为 Java，Spring Boot 版本为最新的稳定版本。
- 添加依赖项 Spring Cloud Gateway 和 Spring Boot Actuator（用于监控）。
- 点击 “Generate” 生成项目，解压下载的项目包。

Maven 配置（在已有项目中添加）：
在 pom.xml 文件中添加 Spring Cloud Gateway 的依赖项：

<dependencies>
    <!-- Spring Cloud Gateway -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <!-- Spring Boot Actuator -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Hoxton.SR9</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

Gradle 配置：
在 build.gradle 文件中添加依赖项：

dependencies {
    implementation 'org.springframework.cloud:spring-cloud-starter-gateway'
    implementation 'org.springframework.boot:spring-boot-starter-actuator'
}

dependencyManagement {
    imports {
        mavenBom "org.springframework.cloud:spring-cloud-dependencies:Hoxton.SR9"
    }
}

3. 配置应用程序

在 src/main/resources 下找到 application.yml 文件，配置 Spring Cloud Gateway 的路由。

配置示例

假设我们需要一个简单的路由，将 /get 的请求转发到 http://httpbin.org:80。

server:
  port: 8080

spring:
  cloud:
    gateway:
      routes:
        - id: example_route
          uri: http://httpbin.org:80
          predicates:
            - Path=/get
          filters:
            - AddRequestHeader=X-Request-Source, SpringCloudGateway

在此配置中：

id：每个路由的唯一标识符。
uri：转发的目标地址。
predicates：路由的断言，只有当请求路径符合 /get 时才会匹配此路由。
filters：定义了一个过滤器，为每个请求添加 X-Request-Source 请求头。

可用的 Predicates 和 Filters

Spring Cloud Gateway 提供了丰富的 Predicates 和 Filters，可以用来控制请求的流转。以下是一些常用的配置项：

Path：匹配请求路径。
Host：匹配请求的 Host。
Method：匹配请求方法，例如 GET、POST。
Header：匹配请求头内容。

常用的过滤器：

AddRequestHeader：添加请求头。
AddRequestParameter：添加请求参数。
RewritePath：重写请求路径。
SetStatus：设置响应状态码。
RemoveRequestHeader：删除请求头。

4. 启动项目

在项目根目录下，执行以下命令启动应用：

mvn spring-boot:run

或在 IDE 中运行 SpringBootApplication 类。

启动成功后，可以通过浏览器或 curl 测试网关服务。例如：

curl http://localhost:8080/get

5. 添加 Actuator 监控

Spring Cloud Gateway 支持与 Spring Boot Actuator 集成，提供健康检查和监控功能。

在 application.yml 中添加 Actuator 相关配置：

management:
  endpoints:
    web:
      exposure:
        include: gateway,health,info

Actuator 配置完成后，可以访问以下端点查看网关的监控信息：

/actuator/gateway/routes：查看当前网关的所有路由。
/actuator/gateway/refresh：刷新路由配置。
/actuator/health：查看应用健康状态。

6. 动态路由配置

如果需要动态路由功能，可以使用 Spring Cloud Config，将路由配置放在配置中心中，通过修改配置来实现动态更新。例如，将 application.yml 中的路由配置移到配置中心中，利用 Spring Cloud Config 和 @RefreshScope 实现路由更新。

7. 高级配置示例

以下是一些常见的高级配置示例：

配置限流

可以使用 Redis 来实现请求限流，以保护后端服务。

spring:
  cloud:
    gateway:
      routes:
        - id: rate_limited_route
          uri: http://httpbin.org:80
          predicates:
            - Path=/anything/**
          filters:
            - name: RequestRateLimiter
              args:
                redis-rate-limiter.replenishRate: 10
                redis-rate-limiter.burstCapacity: 20

此配置对 /anything/** 路由应用限流，每秒最多允许 10 个请求，突发时最大容量为 20。

配置负载均衡

当有多个微服务实例时，可以将 uri 设置为服务注册中心中的服务名，例如 lb://service-name，并结合 Eureka 或 Consul 进行服务发现和负载均衡。

spring:
  cloud:
    gateway:
      routes:
        - id: load_balanced_route
          uri: lb://USER-SERVICE
          predicates:
            - Path=/user/**

安装完毕

8. 对比其他的主流网关服务

在微服务架构中，API 网关作为系统的入口，负责请求转发、流量控制、安全性等功能。除了 Spring Cloud Gateway 外，其他常见的 API 网关有 Nginx、Kong、Zuul、API Gateway (如 AWS API Gateway) 和 Traefik 等。每种网关都有其特性，适合不同的使用场景。下面是 Spring Cloud Gateway 与这些主流网关的对比分析：

1. Spring Cloud Gateway

特点：基于 Spring Boot 和 Spring Cloud 生态，使用 Netty 底层支持高性能；具备动态路由、负载均衡、限流、熔断等功能，天然与 Spring 生态（如 Eureka、Spring Security）兼容。
适用场景：适合 Spring Cloud 微服务体系中的 API 网关。因为与 Spring Cloud 原生集成，配置和开发成本较低，适合对 Spring 生态有深度依赖的应用。
优势：
- 完整支持 Spring Cloud 微服务生态。
- 性能优越，非阻塞式 I/O 支持高并发。
- 灵活的过滤器和路由机制，容易扩展自定义功能。
- 支持动态配置更新，与 Spring Cloud Config 集成。
劣势：
- 需要对 Spring Boot 和 Spring Cloud 生态有所依赖。
- 独立部署时需要更复杂的配置。

2. Zuul（Netflix Zuul 1.x 和 Zuul 2）

特点：Zuul 是 Netflix 开源的 API 网关解决方案，Zuul 1.x 使用阻塞式 I/O，Zuul 2 引入非阻塞式 I/O。
适用场景：Zuul 1.x 适合中小型项目，Zuul 2 更适合 Netflix 内部非阻塞架构，性能提升明显。
优势：
- Zuul 1.x 和 Spring Cloud 结合较好，容易上手。
- Zuul 2 性能更好，支持非阻塞式请求。
- 提供丰富的过滤器 API，适合高度自定义。
劣势：
- Zuul 1.x 性能较差，不支持非阻塞式 I/O。
- Zuul 2 尚未完全整合到 Spring Cloud，支持力度不如 Spring Cloud Gateway。
- 功能相对较为基础，扩展性受限。

3. Nginx

特点：Nginx 是高性能的 HTTP 服务器和反向代理服务器，支持负载均衡、静态资源缓存、SSL、负载均衡等，是很多企业使用的通用反向代理。
适用场景：适合需要极高性能的场景，如静态内容的缓存、全局流量转发、轻量级 API 网关。
优势：
- 极高的性能和稳定性，在高并发场景表现出色。
- 配置简单，成熟的负载均衡、缓存支持。
- 丰富的社区和第三方插件，支持动态服务发现、SSL 加密等。
劣势：
- 缺少 API 网关特有的功能（如限流、熔断、身份认证等），需自行配置或使用第三方模块。
- 缺乏动态配置的管理能力，灵活性稍差。
- 基于配置文件管理，不像其他网关服务那样具备动态更新的 API 支持。

4. Kong

特点：基于 Nginx 构建的 API 网关，具有较好的可扩展性和插件体系；提供身份认证、流量控制、缓存等企业级 API 网关功能。
适用场景：适合大规模、复杂的微服务场景，可用于支持多租户的企业级 API 管理。
优势：
- 插件体系完善，支持 JWT、OAuth2、限流、日志记录等多种功能。
- 高性能，基于 Nginx 构建，性能极高。
- 具有管理界面和 CLI 工具，易于管理和配置。
- 支持数据库（如 Postgres、Cassandra）和无数据库模式。
劣势：
- Kong 自身架构复杂，使用需要学习成本。
- 插件和功能的高级特性依赖企业版。
- 社区版的实时更新、扩展能力相对有限。

5. Traefik

特点：Traefik 是一个现代化的、适合微服务的 API 网关，基于 Go 语言开发，原生支持 Docker、Kubernetes 和其他云原生服务发现机制。
适用场景：适合容器化环境（Docker、Kubernetes），尤其适用于 DevOps 流程，支持动态服务发现。
优势：
- 原生支持 Docker、Kubernetes 和 Consul 等主流服务发现。
- 动态更新能力强，能够实时更新配置。
- 内建的负载均衡、SSL 管理、WebSocket 支持。
- 配置简单，适合在云原生环境中快速部署。
劣势：
- 插件支持较少，功能不如 Kong 完善。
- 社区支持广泛，但企业级应用可能仍然不足。
- 对于传统应用支持稍弱，不如 Nginx 灵活。

6. AWS API Gateway

特点：AWS API Gateway 是亚马逊云服务提供的完全托管式 API 网关，支持创建、发布、管理和保护 RESTful API。
适用场景：适合 AWS 云平台上的应用，尤其是无服务器架构（Serverless）和 Lambda 的配合使用。
优势：
- 与 AWS 生态深度集成，支持与 Lambda、IAM、CloudWatch、DynamoDB 等服务配合使用。
- 完全托管，免去基础设施运维。
- 强大的身份认证和访问控制能力，支持 JWT、Cognito 等。
- 支持流量管理、缓存和高可用性。
劣势：
- 依赖 AWS 云环境，跨云平台适应性较差。
- 按请求收费，流量高时可能产生较高成本。
- 自定义和扩展能力相对有限。

对比总结

功能/特性	Spring Cloud Gateway	Zuul	Nginx	Kong	Traefik	AWS API Gateway
架构集成	Spring Cloud 环境	Spring Cloud 兼容	独立架构	独立架构	独立架构	AWS 云平台
适用场景	微服务、Spring Cloud 项目	Netflix 微服务	全局流量管理	大型微服务系统	云原生容器化环境	AWS 云上的 Serverless
动态配置	支持（Spring Cloud Config）	受限	支持第三方模块	支持（数据库模式）	原生支持	支持
性能	高性能，非阻塞式 I/O	Zuul 2 性能优越	性能极高	性能优越	较高	高
插件支持	支持部分插件	支持简单过滤器	依赖第三方	完整插件体系	插件较少	AWS 管理的内建插件
身份认证和授权	基于 Spring Security	自定义实现	自定义或第三方	内建 JWT、OAuth2 支持	自定义实现	AWS IAM、JWT 支持
流量管理	支持限流、熔断	需要扩展	自定义模块	内建限流	支持	内建流量管理
监控与日志	Actuator 支持	自定义实现	第三方支持	内建监控和日志	内建基本监控	与 CloudWatch 集成