Redisson限流器RRateLimiter使用及源码分析

news2024/11/24 7:19:07

在这里插入图片描述

一、使用

使用很简单、如下

// 1、 声明一个限流器
RRateLimiter rateLimiter = redissonClient.getRateLimiter(key);
 
// 2、 设置速率，5秒中产生3个令牌
rateLimiter.trySetRate(RateType.OVERALL, 3, 5, RateIntervalUnit.SECONDS);
 
// 3、试图获取一个令牌，获取到返回true
rateLimiter.tryAcquire(1)

二、原理

1、getRateLimiter

// 声明一个限流器 名称 叫key
redissonClient.getRateLimiter(key)

2、trySetRate

trySetRate 方法跟进去底层实现如下：

@Override
public RFuture<Boolean> trySetRateAsync(RateType type, long rate, long rateInterval, RateIntervalUnit unit) {
    return commandExecutor.evalWriteAsync(getName(), LongCodec.INSTANCE, RedisCommands.EVAL_BOOLEAN,
            "redis.call('hsetnx', KEYS[1], 'rate', ARGV[1]);"
          + "redis.call('hsetnx', KEYS[1], 'interval', ARGV[2]);"
          + "return redis.call('hsetnx', KEYS[1], 'type', ARGV[3]);",
            Collections.<Object>singletonList(getName()), rate, unit.toMillis(rateInterval), type.ordinal());
}

举个例子，更容易理解：

比如下面这段代码，5 秒中产生 3 个令牌，并且所有实例共享（RateType.OVERALL所有实例共享、RateType.CLIENT单实例端共享）

trySetRate(RateType.OVERALL, 3, 5, RateIntervalUnit.SECONDS);

那么 redis 中就会设置 3 个参数：

hsetnx,key,rate,3
 
hsetnx,key,interval,5
 
hsetnx,key,type,0

接着看tryAcquire(1)方法：底层源码如下

private <T> RFuture<T> tryAcquireAsync(RedisCommand<T> command, Long value) {
    return commandExecutor.evalWriteAsync(getName(), LongCodec.INSTANCE, command,
            "local rate = redis.call('hget', KEYS[1], 'rate');"  //1
          + "local interval = redis.call('hget', KEYS[1], 'interval');"  //2
          + "local type = redis.call('hget', KEYS[1], 'type');" //3
          + "assert(rate ~= false and interval ~= false and type ~= false, 'RateLimiter is not initialized')" //4
          
          + "local valueName = KEYS[2];" //5
          + "if type == 1 then "
              + "valueName = KEYS[3];" //6
          + "end;"
          
          + "local currentValue = redis.call('get', valueName); " //7
          + "if currentValue ~= false then " 
                 + "if tonumber(currentValue) < tonumber(ARGV[1]) then " //8
                     + "return redis.call('pttl', valueName); "
                 + "else "
                     + "redis.call('decrby', valueName, ARGV[1]); " //9
                     + "return nil; "
                 + "end; "
          + "else " //10
                 + "redis.call('set', valueName, rate, 'px', interval); " 
                 + "redis.call('decrby', valueName, ARGV[1]); "
                 + "return nil; "
          + "end;",
            Arrays.<Object>asList(getName(), getValueName(), getClientValueName()), 
            value, commandExecutor.getConnectionManager().getId().toString());
}

第 1、2、3 备注行是获取上一步 set 的 3 个值：rate、interval、type，如果这 3 个值没有设置，直接返回 rateLimiter 没有被初始化。

第 5 备注行声明一个变量叫valueName 值为KEYS[2],KEYS[2]对应的值是getValueName()方法，getValueName()返回的就是上面第一步getRateLimiter我们设置的 key；如果 type=1，表示全局共享，那么valueName 的值改为取KEYS[3]，KEYS[3]对应的值为getClientValueName()，查看getClientValueName()源码：

String getClientValueName() {
        return suffixName(getValueName(), commandExecutor.getConnectionManager().getId().toString());
   }

ConnectionManager().getId()如下：

public interface ConnectionManager {
    
    UUID getId();
 
    省略...
}

这个 getId() 是每个客户端初始化的时候生成的 UUID，即每个客户端的 getId 是唯一的，这也就验证了trySetRate方法中RateType.ALL与RateType.PER_CLIENT的作用。

接着看第 7 标准行，获取valueName对应的值currentValue；首次获取肯定为空，那么看第 10 标准行 else 的逻辑
set valueName 3 px 5，设置 key=valueName value=3 过期时间为 5 秒
decrby valueName 1，将上面 valueName 的值减 1
那么如果第二次访问，第 7 标注行返回的值存在，将会走第 8 标注行，紧接着走如下判断
如果当前 valueName 的值也就是 3，小于要获得的令牌数量 (tryAcquire方法中的入参)，那么说明当前时间内（key 的有效期 5 秒内），令牌的数量已经被用完，返回 pttl(key 的剩余过期时间)；反之说明桶中有足够的令牌，获取之后将会把桶中的令牌数量减 1，至此结束。