在php项目中使用redis实现滑动时间窗口限流算法示例代码

php  /  管理员 发布于 2年前   417

不过滑动时间窗口算法及计数器算法都存在时间边界问题，如果能接受这个问题那使用它还是非常方便的，如果不能接受那就要用换成漏桶算法、令牌桶算法等解决方案了，不过就相对会复杂很多了

看产品功能取舍。

代码示例：

/**
 * 滑动窗口限流
 * Class SlidingWindow
 * @package App\Common
 */
class SlidingWindow
{
    protected $timeStamp;                       //当前的时间戳
    protected $_is_open_minimum_check = false;  //是否开启最小精度检查 默认不开启
    protected $_minimum_time_range_size = 1;    // 最小限制范围精度单位秒钟
    protected $_minimum_time_range_qps  = 50;   // 最小范围精度对应的时间内允许的请求数量
    protected $_maximum_time_range_size = 60;   // 最大限制范围单位秒钟
    protected $_maximum_time_range_qps = 3000;  // 最大限制范围对应的时间内允许的请求数量
    protected $key = 'sliding_window';
    /** @var $redis \Redis */
    public $redis;
    public function __construct($redis)
    {
        $this->timeStamp = time();
        $this->redis = $redis;
    }
    //设置是否开启最小精度的检查 false为关闭 true为开启
    public function setOpenMininumCheck($open)
    {
        $this->_is_open_minimum_check = $open;
        return $this;
    }
    //设置最小精度时间 单位秒
    public function setMininumTime($time)
    {
        $this->_minimum_time_range_size = $time;
        return $this;
    }
    //设置最小精度的限制数量
    public function setMinnumQps($qps)
    {
        $this->_minimum_time_range_qps = $qps;
        return $this;
    }
    //设置最大精度时间 单位秒
    public function setMaxnumTime($time)
    {
        $this->_maximum_time_range_size = $time;
        return $this;
    }
    //设置最大精度的限制数量
    public function setMaxnumQps($qps)
    {
        $this->_maximum_time_range_qps = $qps;
        return $this;
    }
    //设置自定义key
    public function setKey($key = '')
    {
        if(!empty($key)){
            $this->key = $key;
        }
        return $this;
    }
    public function luaGrant($value)
    {
        //极限并发情况下的,使用lua脚本会被redis当成一个整体的原子操作
        $luaScript = <<<EOT
                        local key = KEYS[1]
                        redis.call('expire',key,tonumber(ARGV[2]))
                        redis.call('zremrangebyscore',key,0,tonumber(ARGV[4]))
                        local max_count = redis.call('zcount',key,tonumber(ARGV[4]),tonumber(ARGV[5]))
                        if(max_count < tonumber(ARGV[8])) then
                            if (tonumber(ARGV[1]))then
                               local min_count = redis.call('zcount',key,tonumber(ARGV[3]),tonumber(ARGV[5]))
                               if(min_count >= tonumber(ARGV[7])) then
                                     return 0
                               else
                                 redis.call('zadd',key,tonumber(ARGV[5]),tonumber(ARGV[6]))
                                 return 1
                               end
                            else
                                redis.call('zadd',key,tonumber(ARGV[5]),tonumber(ARGV[6]))
                                return 1
                            end
                        else
                           return 0
                        end
EOT;
        $res =  $this->redis->eval($luaScript, [
            $this->key,
            $this->_is_open_minimum_check,
            $this->_maximum_time_range_size,
            $this->timeStamp - $this->_minimum_time_range_size + 1,
            $this->timeStamp - $this->_maximum_time_range_size,
            $this->timeStamp,
            $value,
            $this->_minimum_time_range_qps,
            $this->_maximum_time_range_qps
        ], 1);
//        return json_encode(["status" => (bool)$res,"time" => date('Y-m-d H:i:s',$this->timeStamp)]);
        return (bool)$res;
    }
}

功能调用示例

//uid为 具体的每个用户
$res = (new SlidingWindow($redis))
    ->setKey()
    ->setOpenMininumCheck(true)
    ->setMininumTime(5)
    ->setMinnumQps(500)
    ->setMaxnumTime(60)
    ->setMaxnumQps(3000)
    ->luaGrant($uid);
if(!$res){
    //限流了
    echo json_encode(["status" => false, "text" => "当前访问人数过多，请刷新重试", "is_limit" => true],JSON_UNESCAPED_UNICODE);
    exit;
}