【Springboot starter 组件开发】限流组件 RateLimiter

【Springboot starter 组件开发】限流组件 RateLimiter

  • 一、摘要
  • 二、基于guava实现
    • [2.1 核心依赖](#2.1 核心依赖)
    • [2.2 核心逻辑](#2.2 核心逻辑)
  • [三、基于Redis + lua脚本实现](#三、基于Redis + lua脚本实现)
    • [3.1 核心依赖](#3.1 核心依赖)
    • [3.2 核心逻辑](#3.2 核心逻辑)

一、摘要

  1. 基于guava的RateLimiter,实现限流
  2. 基于redis + lua脚本(推荐,准确性高),实现限流
  3. 掌握springboot starter的开发流程
  4. 源码地址:ratelimiter-spring-boot-starter

二、基于guava实现

2.1 核心依赖

xml 复制代码
<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>23.5-jre</version>
</dependency>

2.2 核心逻辑

java 复制代码
@Slf4j
public class GuavaLimiter implements LimiterManager {

    private final Map<String, RateLimiter> limiterMap = Maps.newConcurrentMap();

    @Override
    public boolean tryAccess(LimiterEntity entity) {
        if (StringUtils.isBlank(entity.getKey())) {
            throw new LimiterException("Guava limiter key cannot be empty");
        }
        RateLimiter rateLimiter = getRateLimiter(entity);
        if (rateLimiter == null) {
            return false;
        }
        boolean result = rateLimiter.tryAcquire(entity.getPermitsPerSecond(), entity.getTimeout(), TimeUnit.SECONDS);
        log.info("Guava limiter tryAccess, key={}, result={}", entity.getKey(), result);
        return result;
    }

    private RateLimiter getRateLimiter(LimiterEntity entity) {
        String key = entity.getKey();
        // 先看缓存中是否存在
        if (!limiterMap.containsKey(key)) {
            // 缓存中不存在,则创建令牌桶,预热时间设置为1s
            RateLimiter rateLimiter = RateLimiter.create(entity.getPermitsPerSecond(), 1, TimeUnit.SECONDS);
            limiterMap.put(key, rateLimiter);
            log.info("Guava limiter new bucket, key={}, permits={}", key, entity.getPermitsPerSecond());
            return rateLimiter;
        }
        return limiterMap.get(key);
    }
}

三、基于Redis + lua脚本实现

3.1 核心依赖

xml 复制代码
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
    <scope>provided</scope>
</dependency>

3.2 核心逻辑

java 复制代码
@Slf4j
public class RedisLimiter implements LimiterManager {

    private final StringRedisTemplate stringRedisTemplate;

    public RedisLimiter(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }

    @Override
    public boolean tryAccess(LimiterEntity entity) {

        if (StringUtils.isBlank(entity.getKey())) {
            throw new LimiterException("Redis limiter key cannot be empty");
        }
        List<String> keys = Collections.singletonList(entity.getKey());

        double permitsPerSecond = entity.getPermitsPerSecond();
        long timeout = entity.getTimeout();

        RedisScript<Long> redisScript = new DefaultRedisScript<>(buildLuaScript(), Long.class);

        Long count = stringRedisTemplate.execute(redisScript, keys, "" + permitsPerSecond, "" + timeout);

        log.info("Redis limiter tryAccess, key={}, count={} ", entity.getKey(), count);

        return count != null && count != 0;
    }

    private String buildLuaScript() {
        return "--获取KEY\n" +
                "local key = KEYS[1]\n" +
                "\n" +
                "local limit = tonumber(ARGV[1])\n" +
                "\n" +
                "local curentLimit = tonumber(redis.call('get', key) or \"0\")\n" +
                "\n" +
                "if curentLimit + 1 > limit\n" +
                "    then return 0\n" +
                "else\n" +
                "    -- 自增长 1\n" +
                "    redis.call('INCRBY', key, 1)\n" +
                "    -- 设置过期时间\n" +
                "    redis.call('EXPIRE', key, ARGV[2])\n" +
                "    return curentLimit + 1\n" +
                "end";
    }
}
相关推荐
2501_9262279443 分钟前
UDP网络编程:【Java】无连接通信到Socket实战(二)
java·网络·udp
Sunny_yiyi1 小时前
Java根据模版导出PDF文件
java·开发语言·pdf
麦兜*1 小时前
MongoDB 与 GraphQL 结合:现代 API 开发新范式
java·数据库·spring boot·mongodb·spring·maven·graphql
绝无仅有1 小时前
前端开发环境搭建:从安装 Node 到成功运行代码
后端·面试·github
shan&cen1 小时前
Day02 集合 | 30. 串联所有单词的子串、146. LRU 缓存、811. 子域名访问计数
java·数据结构·算法·缓存
yshhuang1 小时前
在Windows上搭建开发环境
前端·后端
绝无仅有1 小时前
某个互联网大厂的Elasticsearch基础面试题与答案
后端·面试·github
无责任此方_修行中1 小时前
AWS IoT Core 成本优化实战:从 PoC 到生产的省钱之旅
后端·架构·aws
ITMan彪叔1 小时前
Java MQTT 主流开发方案对比
java·后端