imi-rate-limit

{
    "require": {
        "imiphp/imi-rate-limit": "~1.0"
    }
}

[
    'components'    =>  [
        // 引入本组件
        'RateLimit'    =>  'Imi\RateLimit',
    ],
    'pools'    =>    [
        // 一定得要配置 Redis 连接池才可以用
    ],
    'redis' =>  [
        'defaultPool'   =>  'redis连接池名称',
    ],
]

/**
 * Ограничивает одновременный доступ до 3 раз в секунду.
 *
 * @Action
 * 
 * @RateLimit(name="test1", capacity=3)
 *
 * @return void
 */
public function test1()
{
    return [
        'data'  =>  'test1',
    ];
}

/**
 * Ограничивает одновременный доступ до одного раза в секунду и ожидает снятия ограничения перед продолжением выполнения. Время ожидания составляет 1 секунду.
 *
 * @Action
 * 
 * @RateLimit(name="test2", capacity=1)
 * @BlockingConsumer(1)
 *
 * @return void
 */
public function test2()
{
    return [
        'data'  =>  'test2',
    ];
}

/**
 * Общая ёмкость составляет 1000, каждый миллисекунду добавляется 1 токен, а при каждом вызове вычитается 500 токенов.
 * 
 * Пользовательская обработка ограничений.
 *
 * @Action
 * 
 * @RateLimit(name="test3", capacity=1000, fill=1, unit="millisecond", deduct=500, callback="\ImiDemo\HttpDemo\Util\RateLimitParser::parse")
 *
 * @return void
 */
public function test3()
{
    return [
        'data'  =>  'test3',
    ];
}

/**
 * Ручной вызов ограничения скорости.
 * 
 * Общая ёмкость составляет 1000, каждый миллисекунда добавляется 1 токен, при каждом вызове вычитается 500 токенов.
 *
 * @Action
 * 
 * @return void
 */
public function test4()
{
    if(true !== $result = RateLimiter::limit('test4', 1000, function(){
        // Возвращаемое значение пользовательского обратного вызова будет возвращено как исходное возвращаемое значение метода.
        return [
            'message'   =>  'Пользовательский возврат при срабатывании ограничения скорости',
        ];
    }, 1, 'millisecond', 500))
    {
        return $result;
    }
    return [
        'data'  =>  'test4',
    ];
}

/**
 * Ручной вызов ограничения скорости.
 * 
 * Ограничение одновременного доступа до одного раза в секунду, ожидание снятия ограничения перед выполнением. Время ожидания составляет одну секунду.
 *
 * @Action
 * 
 * @return void
 */
public function test5()
{
    if(true !== $result = RateLimiter::limitBlock('test5', 1, function(){
        // Возвращаемое значение пользовательского обратного вызова будет возвращено как исходное возвращаемое значение метода.
        return [
            'message'   =>  'Пользовательское сообщение при срабатывании ограничения скорости',
        ];
    }, 1, 1, 'second', 1))
    {
        return $result;
    }
    return [
        'data'  =>  'test5',
    ];
}