# dynamic-limiter

**Repository Path**: lingfengx/dynamic-limiter

## Basic Information

- **Project Name**: dynamic-limiter
- **Description**: 基于redis的动态限流中间件，支持分布式限流，支持动态调整限流参数，支持多种限流算法，支持黑白名单过滤，支持SPEL表达式。 
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-08-13
- **Last Updated**: 2025-08-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<img align="center" width="300" alt="logo" src="https://gitee.com/lingfengx/static/raw/master/logo.png">

中文
# 动态限流中间件

[![GitHub](https://img.shields.io/github/stars/lingfengcoder/dynamic-limiter?color=5470c6)](https://github.com/lingfengcoder/dynamic-limiter)
 [![codecov](https://codecov.io/gh/lingfengcoder/dynamic-limiter/branch/develop/graph/badge.svg?token=WBUVJN107I)](https://codecov.io/gh/lingfengcoder/dynamic-limiter)

-------

## 什么是 dynamic-x系列
目前有：
- dynamic-limiter
- dynamic-config

dynamic-x 系列 使用足够简单的轻量级代码实现多种中间件能力，比如：动态配置、动态限流等。

# dynamic-limiter 
基于redis的动态限流中间件，支持分布式限流，支持动态调整限流参数，支持多种限流算法，支持黑白名单过滤，支持SPEL表达式。
提供以下功能支持：

- 方法级限流 - 支持方法级别的限流。
- 动态调整 - 应用运行时动态变更限流参数，（滑动窗口举例）包括不限于：窗口大小、最大通过数、黑白名单等。
- 限流算法 - 内置三种限流算法：滑动窗口、令牌桶、漏桶算法。
- 黑白名单 - 支持黑白名单过滤。
- SPEL支持 - 支持SPEL表达式，可根据方法参数动态限流

2.0新特性
- 支持内部降级队列
- 支持分布式调度任务执行
- 支持设置方法执行异常最大重试次数
```java
@RdsLimit(key = "demoLimit(#mediaInfo.tenantId,#mediaInfo.projectId)", configBean = MediaAddLimitConfig.class, errorRetryCount = 3, useFallbackQueue = true, enableFastRetryQueue = true)
    public Object demoLimit(MediaInfo mediaInfo, String projectId, MediaAdminInfoBO mediaInfoBO, String time, String id) throws InterruptedException {
}
```
新增注解配置
```java
   
    //是否开启内部降级队列，开启后，限流异常时，会将请求放入降级队列，随后被调度执行
    boolean useFallbackQueue() default false;

    //是否开启快速重试队列
    boolean enableFastRetryQueue() default false;

    //方法执行失败后，自动重试的次数
    int errorRetryCount() default 0;
```  

2.0引入了redisson，需要对redisson进行配置（ps：不会还有项目没有用redisson吧）
```yml
redisson:
  config:
    singleServerConfig:
      address: "redis://redis.host:port"
      password: password # Redisson 的密码配置
      database: 9 # 如果需要指定数据库
      connectionPoolSize: 64 # 连接池大小
      connectionMinimumIdleSize: 32 # 最小空闲连接数
```

## 快速开始
spring 环境可以直接引入starter
```xml
<dependency>
    <groupId>io.github.lingfengcoder</groupId>
    <artifactId>dynamic-limiter-starter</artifactId>
    <version>${lastest.version}</version>
</dependency>
```
启动类增加开启注解
```java
@EnableDynamicLimiter
public class ServletInitializer extends SpringBootServletInitializer {
 public static void main(String[] args) {
  SpringApplication.run(ServletInitializer.class, args);
 }
}
```
在需要限流的方法上增加注解
```java
class Test{
 //   
 @RdsLimit(key = "demoLimit(#userId,#tenantId)", configBean = LimitConfig.class, fallBack = "demoLimitFallback", autoRelease = false)
 public Boolean demoLimit(String userId, String tenantId) {
  //通过限流
  return true;
 }
 //demoLimitFallback限流降级方法
  public Boolean demoLimitFallback(String userId, String tenantId) {
  //限流降级
  return false;
  }
 
}
```
提供jedis的生产者bean
```java
@Configuration
class demo{
 @Bean
 public  Supplier<Jedis> jedisSupplier(RedisClient redisClient) {
     return () -> redisClient.getJedis();
 }
}
```
配置文件(需要是bean对象)
```java

//动态配置文件
@DynamicValConfigMap(file = "limit.properties", prefix = "limit.something")
public class LimitConfig implements RdsLimitConfig {
    private final static String TENANT_ID = "tenantId";
    private final static String USER_ID = "userId";
    //#是否开启限流
    private boolean enable = false;
    //#滑动窗口的大小
    private int boxLen = 10;
    //#滑动窗口的时间
    private long boxTime = 5000;
    //需要限流的租户
    private List<String> tenantIds = Collections.emptyList();
    //需要限流的用户
    private List<String> userIds = Collections.emptyList();

    private boolean blackEnable = false;

    @Override
    public boolean getEnable() {
        return enable;
    }

    @Override
    public Function<Map<String, Object>, String> dynamicKey() {
        return map -> {
            //map 中包含spel表达式中的参数
            StringBuilder builder = new StringBuilder();
            return builder.toString();
        };
    }

    @Override
    public boolean whiteEnable() {
        return false;
    }

    @Override
    public boolean blackEnable() {
        return blackEnable;
    }


    /**
     * 不限流操作
     *
     * @return
     */
    @Override
    public Function<Map<String, Object>, Boolean> whiteListHandler() {
        return null;
    }

    /**
     * 黑名单操作:需要限流的
     *
     * @return
     */
    @Override
    public Function<Map<String, Object>, Boolean> blackListHandler() {
        return map -> {
            Object tenantId = map.get(TENANT_ID);
            Object userId = map.get(USER_ID);
            if (userId != null && tenantIds.contains(userId)) {
                return true;
            }
            if (projectId != null && projectIds.contains(projectId)) {
                return true;
            }
            //不需要限流
            return false;
        };
    }
 @Override
 public long getTimeout() {
  return 0;
 }

 @Override
 public String getFallBack() {
  return null;
 }

 @Override
 public String getErrorBack() {
  return null;
 }

}
```
## 接入登记

更多接入的公司，欢迎在 [登记地址]() 登记，登记仅仅为了产品推广。

## 联系我

## 友情链接

## 贡献者

感谢所有为项目作出贡献的开发者。如果有意贡献，参考 [good first issue]()。