SpringBoot 分布式令牌桶限流：集成 Bucket4j + Redis

SpringBoot 分布式令牌桶限流集成 Bucket4j Redis一、pom.xml版本号Redis 客户端二、Bucket4j 配置三、配置 JedisPool一、pom.xml本文使用的 SpringBoot 版本为 4.0.3JDK 版本为 25以下是集成 Bucket4j 需要引入的相关依赖!-- springboot相关依赖 --dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-web/artifactId/dependencydependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-aspectj/artifactId/dependency!-- bucket4j的springboot 依赖 --dependencygroupIdcom.giffing.bucket4j.spring.boot.starter/groupIdartifactIdbucket4j-spring-boot-starter/artifactIdversion0.14.0/version/dependency!-- bucket4j的redis-jedis依赖 --dependencygroupIdcom.bucket4j/groupIdartifactIdbucket4j_jdk17-redis-common/artifactIdversion8.15.0/version/dependencydependencygroupIdcom.bucket4j/groupIdartifactIdbucket4j_jdk17-jedis/artifactIdversion8.15.0/version/dependency!-- spring-boot-starter-cache --dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-cache/artifactId/dependency!-- jedis依赖 --dependencygroupIdredis.clients/groupIdartifactIdjedis/artifactId/dependency版本号bucket4j-spring-boot-starter 以及 bucket4j_jdk17-redis-common、bucket4j_jdk17-jedis 的版本号参考 bucket4j-spring-boot-starter github 文档Redis 客户端大部分 SpringBoot 应用使用的是基于 Servlet 同步阻塞模型的 spring-boot-starter-web 依赖因此在集成 Bucket4j 时必须使用 Redis 的 Jedis 客户端。如果使用的是基于 Flux 异步响应模型的 spring-boot-starter-webflux 依赖则可以选择 Lettuce 或 Redisson 客户端。此处参考 bucket4j-spring-boot-starter 配置Jedis 只支持同步Lettuce 和 Redisson 只支持异步。二、Bucket4j 配置本文采用 RateLimiting 注解的方式以下是 yaml 配置bucket4j:cache-to-use:redis-jedismethods:-name:rate-limit-method#RateLimiting引用的方法名cache-name:bucketsrate-limit:bandwidths:-capacity:5#总容量refill-capacity:3#填充量time:10#10s内填充3个令牌最多保留5个unit:secondsrefill-speed:greedy#greedy贪婪模式在时间内均匀发放interval间隔模式到时间一次性发放将 RateLimiting 注解在需要限流的 Controller 层方法上RateLimiting(namerate-limit-method,//配置的methods名称fallbackMethodNamefallbackMethod)//超限时执行的方法名定义在下面PostMapping(/rateLimitTest)publicResponseEntityBooleanrateLimitTest(){returnResponseEntity.ok(true);}/** * 定义bucket4j请求超限时执行的后备方法 */publicResponseEntityBooleanfallbackMethod(){returnResponseEntity.ok(false);}此外也可以采用配置 filters 属性的方式无需注解参考 bucket4j-spring-boot-starter github 文档。三、配置 JedisPool完成上面的配置后初次启动报错。检查 Bucket4j 的 Jedis 源码发现需要定义一个 JedisPool 的 Bean编写 JedisPool 配置类ConfigurationpublicclassRedisConfig{/** * 用于bucket4j */BeanpublicJedisPooljedisPool(JedisPropertiesjedisProperties){JedisPoolConfigjedisPoolConfignewJedisPoolConfig();jedisPoolConfig.setMaxTotal(jedisProperties.getJedis().getPool().getMaxActive());jedisPoolConfig.setMaxWait(jedisProperties.getJedis().getPool().getMaxWait());jedisPoolConfig.setMaxIdle(jedisProperties.getJedis().getPool().getMaxIdle());jedisPoolConfig.setMinIdle(jedisProperties.getJedis().getPool().getMinIdle());returnnewJedisPool(jedisPoolConfig,jedisProperties.getHost(),jedisProperties.getPort(),Math.toIntExact(jedisProperties.getTimeout().toMillis()),jedisProperties.getPassword(),jedisProperties.getDatabase());}}读取 Jedis 配置的类ComponentConfigurationProperties(prefixspring.data.redis)DatapublicclassJedisProperties{privateStringhost;privateIntegerport;privateStringpassword;privateIntegerdatabase;privateDurationtimeout;privateMyJedisPooljedis;DatapublicstaticclassMyJedisPool{privatePoolpool;DatapublicstaticclassPool{privateIntegermaxActive;privateDurationmaxWait;privateIntegermaxIdle;privateIntegerminIdle;}}}application.yamlspring:data:redis:host:${host}port:6379password:${password}database:0timeout:10s#用于bucket4jjedis:pool:max-active:200max-wait:10smax-idle:10min-idle:1至此已完成所有配置可以请求方法进行限流测试了。参考[1]: bucket4j github 文档[2]: bucket4j-spring-boot-starter github 文档[3]: bucket4j 官方文档集成 jedis[4]: 轻松实现 API 接口限流Bucket4j 在 Spring Boot 中的应用[5]: Jedis使用教程详解