redis redisson 限流器的實例(RRateLimiter)

Posted on by

redis redisson 限流器實例

作用：限制一段時間內對數據的訪問數量

相關接口

RRateLimiter

public interface RRateLimiter extends RRateLimiterAsync, RObject { 
    boolean trySetRate(RateType var1, long var2, long var4, RateIntervalUnit var6);
                              //設置訪問速率，var2為訪問數，var4為單位時間，var6為時間單位 
    void acquire();           //訪問數據
    void acquire(long var1);  //占var1的速度計算值 
    boolean tryAcquire();                                    //嘗試訪問數據
    boolean tryAcquire(long var1);                           //嘗試訪問數據，占var1的速度計算值
    boolean tryAcquire(long var1, TimeUnit var3);            //嘗試訪問數據，設置等待時間var3
    boolean tryAcquire(long var1, long var3, TimeUnit var5); //嘗試訪問數據，占數據計算值var1，設置等待時間var3 
    RateLimiterConfig getConfig();
}

RateType：速度類型

public enum RateType {
    OVERALL,             //所有客戶端加總限流
    PER_CLIENT;          //每個客戶端單獨計算流量
 
    private RateType() {
    }
}

RateInternalUnit：速度單位

public enum RateIntervalUnit {
    MILLISECONDS {
        public long toMillis(long value) {
            return value;
        }
    },
    SECONDS {
        public long toMillis(long value) {
            return TimeUnit.SECONDS.toMillis(value);
        }
    },
    MINUTES {
        public long toMillis(long value) {
            return TimeUnit.MINUTES.toMillis(value);
        }
    },
    HOURS {
        public long toMillis(long value) {
            return TimeUnit.HOURS.toMillis(value);
        }
    },
    DAYS {
        public long toMillis(long value) {
            return TimeUnit.DAYS.toMillis(value);
        }
    };
 
    private RateIntervalUnit() {
    } 
    public abstract long toMillis(long var1);
}

示例

public class MyTest8 { 
    public static void main(String[] args){
        Config config=new Config();
        config.useSingleServer().setAddress("redis://192.168.57.120:6379").setPassword("123456");
        RedissonClient client= Redisson.create(config);
 
        RRateLimiter rateLimiter=client.getRateLimiter("rate_limiter");
        rateLimiter.trySetRate(RateType.PER_CLIENT,5,2, RateIntervalUnit.MINUTES); 
        ExecutorService executorService= Executors.newFixedThreadPool(10);
        for (int i=0;i<10;i++){
            executorService.submit(()->{
               try{
                   rateLimiter.acquire();
                   System.out.println("線程"+Thread.currentThread().getId()+"進入數據區："+System.currentTimeMillis());
               }catch (Exception e){
                   e.printStackTrace();
               }
            });
        }
    }
}

控制臺輸出

線程49進入數據區：1574672546522
線程55進入數據區：1574672546522
線程56進入數據區：1574672546526
線程50進入數據區：1574672546523
線程48進入數據區：1574672546523

線程51進入數據區：1574672666627
線程53進入數據區：1574672666627
線程54進入數據區：1574672666627
線程57進入數據區：1574672666628
線程52進入數據區：1574672666628
說明：兩分鐘之內最多隻有5個線程在執行

分佈式限流redission RRateLimiter使用及原理

前提：

最近公司在做有需求在做分佈式限流，調研的限流框架大概有

  • 1、spring cloud gateway集成redis限流,但屬於網關層限流
  • 2、阿裡Sentinel,功能強大、帶監控平臺
  • 3、srping cloud hystrix，屬於接口層限流，提供線程池與信號量兩種方式
  • 4、其他：redission、手擼代碼

實際需求情況屬於業務端限流，redission更加方便，使用更加靈活，下面介紹下redission分佈式限流如何使用及原理：

一、使用

使用很簡單、如下

// 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，至此結束。

總結：

redission分佈式限流采用令牌桶思想和固定時間窗口，trySetRate方法設置桶的大小，利用redis key過期機制達到時間窗口目的，控制固定時間窗口內允許通過的請求量。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：