如何使用php对API进行限流

2023 年 12 月 30 日

85 次浏览

1926字数

# [如何使用php对API进行限流](https://mp.weixin.qq.com/s/1JqYnYbceOA0EaBxjX9qyA) 
在开发API时，为了防止恶意请求和保证系统的稳定性，我们经常需要对API进行限流。本文将介绍如何使用PHP对API进行限流。

首先，我们需要一个Redis连接来存储和管理请求的计数。我们可以通过以下代码建立与Redis的连接：

```php
class RateLimiter {
    private $redis; // Redis连接

public function __construct() {
        // 假设已经建立了与Redis的连接
        $this->redis = new Redis();
        $this->redis->connect('127.0.0.1', 6379);
    }
    
    // ...
}
``` 
接下来，我们定义一个limitRequests方法来实现限流逻辑。该方法接受三个参数：$key是API的标识，$limit是限制的请求数量，$window是窗口的大小（单位为秒）。

```php
public function limitRequests($key, $limit, $window) {
    $currentTime = time();
    $keyPrefix = 'ratelimiter:' . $key;
    $windowKey = $keyPrefix . ':' . floor($currentTime / $window);

$requests = $this->redis->get($windowKey);
    if ($requests === false) {
        // 创建新的窗口
        $this->redis->multi();
        $this->redis->incr($windowKey);
        $this->redis->expire($windowKey, $window + 1); // 设置过期时间略大于窗口大小
        $this->redis->exec();
        return true;
    }

if ($requests < $limit) {
        // 在当前窗口内的请求数量未达到限制
        $this->redis->incr($windowKey);
        return true;
    }
    // 达到限制，拒绝请求
    return false;
}
``` 
在limitRequests方法中，我们首先根据当前时间和窗口大小计算出窗口的键名，然后从Redis中获取该键对应的请求数量。如果该键不存在，则说明是一个新的窗口，我们可以通过Redis的multi方法和incr方法来增加请求数量，并设置过期时间略大于窗口大小。最后，我们使用Redis的exec方法提交事务，并返回true表示请求通过。

如果该键存在且请求数量未达到限制，则增加请求计数并返回true；如果请求数量达到限制，则直接返回false表示请求被拒绝。

接下来是一个使用示例：

```php
$rateLimiter = new RateLimiter();

// API限流，限制每分钟最多5次请求
$key = 'api:example';
$limit = 5;
$window = 60;

if ($rateLimiter->limitRequests($key, $limit, $window)) {
    // 执行API逻辑
    echo "API请求成功";
} else {
    // 返回请求频率过高的错误信息
    echo "请求频率过高，请稍后再试";
}
``` 
以上示例中，我们实例化一个RateLimiter对象，并调用limitRequests方法来限流。如果请求通过限流验证，则执行API逻辑并输出成功信息；如果请求被拒绝，则输出错误信息提示请求频率过高。

通过以上代码，我们可以实现对API的简单限流。当然，根据实际需求，我们还可以结合IP地址、用户身份等信息进行更细粒度的限制。

最后修改：2023 年 12 月 30 日