基于Redis Lua脚本实现的滑动窗口限流核心包

badger-rate-limiter

---

简介

最近根据业务需求封装了一个基于redis lua脚本实现的滑动窗口限流的核心包,可能有人会问为什么要封装?直接用不就好了?其实,封装起来有助于其他项目快速复用,同时减少使用门槛.

• 该包特点:

  基于Spring listener机制,比较优雅的实现了配置的热更新,不用重启服务即可更新限流策略. 同时提供了一个不用配置直接自行传限流配置的简易接口(开箱即用).有相关限流业务需求时可以考虑使用该包

使用:

添加包依赖即可使用(该包是基于spring-boot-starter-parent:2.2.2.RELEASE版本封装的,如果使用时不符合版本,请自行clone后进行二次改造)

<dependency>
    <groupId>com.honey</groupId>
    <artifactId>badger-rate-limiter</artifactId>
    <version>${badger.version}</version>
</dependency>

application.properties配置示例:

honey.badger.rate-limit.strategies.limit1.ttl=100000
honey.badger.rate-limit.strategies.limit1.windowTime=100000
honey.badger.rate-limit.strategies.limit1.limitCount=10
honey.badger.rate-limit.strategies.limit1.limitKey=account

使用时,直接调用提供的静态方法即可

public class DemoController {

    /**
     * 基于配置的限流接口示例
     *
     * @return {@link Boolean}
     * @author haojinlong
     * @date 2022/5/3
     */
    @ApiOperation("基于配置的限流接口示例")
    @GetMapping("/demo1")
    public Boolean demo1(@RequestParam String limitKey) {
        return RedisRateLimitUtil.isLimit4Config("limit1", limitKey);
    }

    /**
     * 非基于配置的限流接口示例
     *
     * @return {@link Boolean}
     * @author haojinlong
     * @date 2022/5/3
     */
    @ApiOperation("非基于配置的限流接口示例")
    @GetMapping("/demo2")
    public Boolean demo2(@RequestParam String limitKey) {
        return RedisRateLimitUtil.isLimit(limitKey, 1000, 1000, 3);
    }
}

注意事项:

• 该包是基于Redis实现的,所以使用该包前项目必须已经实例化过Redis
• 该包配置更新的核心抓手依靠的是Spring提供的listener交互逻辑,较为优雅的实现了配置热更新的需求,使得底层配置更新不用重启服务,如果有二次开发的需求,请先了解该方面的知识,便于更为精准的二次开发
• 考虑到场景的通用性,配置更新的方式写的比较通用,使用方可以通过监听Apollo/Nacos的配置变更然后 调用ConfigurableApplicationContext的publishEvent方法,即可以更新限流策略;或者可以通过运维接口将更新的配置通过上文提到的方式更新,亦可达到相同的目的

public class DemoListener {

    @Autowired
    private ConfigurableApplicationContext context;

    @ApiOperation("限流配置的监听器")
    @PutMapping("/rate-limit")
    public void updateLimit(String value) {
        Map<String, Object> map = new HashMap<>();
        map.put("honey.badger.rate-limit.strategies.limit1.limitCount", value);
        context.publishEvent(new RateLimitEvent(map));
    }
}

github项目地址

badger-rate-limiter