中文

动态限流中间件

---

什么是 dynamic-x系列

目前有：

• dynamic-limiter
• dynamic-config

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

dynamic-limiter

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

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

快速开始

spring 环境可以直接引入starter

<dependency>
    <groupId>io.github.lingfengcoder</groupId>
    <artifactId>dynamic-limiter-starter</artifactId>
    <version>${lastest.version}</version>
</dependency>

启动类增加开启注解

@EnableDynamicLimiter
public class ServletInitializer extends SpringBootServletInitializer {
 public static void main(String[] args) {
  SpringApplication.run(ServletInitializer.class, args);
 }
}

在需要限流的方法上增加注解

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

@Configuration
class demo{
 @Bean
 public  Supplier<Jedis> jedisSupplier(RedisClient redisClient) {
     return () -> redisClient.getJedis();
 }
}

配置文件(需要是bean对象)

//动态配置文件
@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。