Spring Cloud Gateway实现API限流的完整配置方案

要在spring cloud gateway中实现api限流，核心步骤包括：1. 添加依赖：引入spring-cloud-starter-gateway和spring-boot-starter-data-redis-reactive模块，并可选支持lua脚本的redis配置；2. 配置限流策略：使用redisratelimiter工厂类，在application.yml中定义replenishrate（每秒补充令牌数）、burstcapacity（最大突发容量）及key-resolver（限流维度）等参数；3. 定义限流维度：通过编写keyresolver实现类，如基于用户ip地址返回mono类型的限流键值；4. 可选优化：启用lua脚本方式，通过配置script-location指向lua限流脚本，以原子操作提升并发下的准确性。以上步骤完成后，结合合理的redis配置与业务参数调整，即可实现稳定高效的api限流功能。

API限流是微服务架构中保障系统稳定性的关键手段之一，而Spring Cloud Gateway作为新一代网关组件，内置了对限流的完整支持。要实现API限流，核心在于合理配置Redis和Gateway的联合使用，利用Redis的高性能来记录请求次数，从而控制访问频率。

下面从几个关键环节入手，讲讲怎么在Spring Cloud Gateway中完成限流配置。

1. 添加依赖：引入Redis与Gateway限流模块

要在Spring Cloud Gateway中启用限流功能，首先要确保项目中引入了相关的依赖包。主要用到的是spring-cloud-starter-gateway和spring-boot-starter-data-redis-reactive这两个模块。

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
</dependency>

如果要用Lua脚本提升限流准确性（推荐），还需要确保Redis版本支持Lua脚本执行，并且项目能正常连接Redis服务器。

2. 配置限流策略：使用RedisRateLimiter工厂类

Spring Cloud Gateway提供了一个内置的限流过滤器工厂——RedisRateLimiter，它基于令牌桶算法实现限流逻辑。

在application.yml中配置一个路由并应用限流策略：

spring:
  cloud:
    gateway:
      routes:
        - id: user-service
          uri: lb://user-service
          predicates:
            - Path=/api/user/**
          filters:
            - name: RequestRateLimiter
              args:
                redis-rate-limiter.replenishRate: 10
                redis-rate-limiter.burstCapacity: 20
                key-resolver: "#{@userKeyResolver}"

上面的配置含义如下：

• replenishRate：每秒补充的令牌数，即允许的平均请求数。
• burstCapacity：令牌桶的最大容量，即突发请求最多能处理多少个。
• key-resolver：指定用于区分限流维度的Bean名称，比如按用户ID、IP等进行限流。

3. 定义限流维度：编写KeyResolver实现类

限流的关键在于“谁被限流”，这就需要定义一个KeyResolver Bean。例如根据用户的IP地址进行限流：

@Configuration
public class RateLimiterConfig {

    @Bean
    public KeyResolver userKeyResolver() {
        return exchange -> Mono.just(exchange.getRequest().getRemoteAddress().getHostName());
    }
}

你也可以根据实际需求扩展成更复杂的规则，比如从Header或Token中提取用户ID做限流。

注意：这个KeyResolver必须是一个Spring Bean，并且返回值为Mono类型。

4. 可选优化：使用Lua脚本避免并发问题

默认情况下，Spring Cloud Gateway的限流机制通过多次Redis命令实现，这可能在高并发下出现竞争条件。为了更精确地控制限流行为，可以启用Lua脚本方式。

开启方式很简单，只需要添加以下配置：

spring:
  cloud:
    gateway:
      redis:
        rate-limiter:
          script-location: "classpath:scripts/request_rate_limiter.lua"

然后在资源目录下放置标准的Lua限流脚本（可以从官方示例中复制）。这样每次限流判断都通过一个原子操作完成，避免多个Redis命令之间的状态不一致问题。

基本上就这些。只要把Redis配好，Key维度设计清楚，再结合业务场景调整速率参数，就能实现比较稳定的API限流能力了。

以上就是Spring Cloud Gateway实现API限流的完整配置方案的详细内容，更多请关注php中文网其它相关文章！