PHP如何实现一个简单的API限流_PHP API接口请求频率限制方法

INCR

rate_limit:ip:192.168.1.1:60s

EXPIRE

429 Too Many Requests

ZADD

ZREMRANGEBYSCORE

ZCARD

ZREM

INCR

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset

phpredis

predis/predis

<?php

// 假设你已经通过Composer安装了predis/predis
// require 'vendor/autoload.php';

// 如果你用的是phpredis扩展，连接方式会略有不同
// $redis = new Redis();
// $redis->connect('127.0.0.1', 6379);

use Predis\Client as PredisClient;

class ApiRateLimiter
{
    private $redis;
    private $prefix; // Redis键前缀，用于区分不同的限流策略或业务

    public function __construct(PredisClient $redis, string $prefix = 'api_rate_limit:')
    {
        $this->redis = $redis;
        $this->prefix = $prefix;
    }

    /**
     * 检查并执行限流。
     *
     * @param string $identifier 唯一的请求标识符（如IP地址或用户ID）
     * @param int $limit 允许的最大请求次数
     * @param int $windowSeconds 时间窗口（秒）
     * @return bool 如果请求被允许，返回true；否则返回false。
     */
    public function allowRequest(string $identifier, int $limit, int $windowSeconds): bool
    {
        // 构建Redis键，例如：api_rate_limit:user:123:60
        $key = $this->prefix . $identifier . ':' . $windowSeconds;

        // 使用Redis的INCR命令，它会原子性地将键的值加1。
        // 如果键不存在，INCR会将其初始化为0再加1，所以第一次调用后是1。
        $currentRequests = $this->redis->incr($key);

        // 如果是当前窗口的第一次请求，设置键的过期时间。
        // 这样可以确保计数器在窗口结束后自动清零。
        if ($currentRequests === 1) {
            $this->redis->expire($key, $windowSeconds);
        }

        // 判断当前请求数是否在限制之内
        return $currentRequests <= $limit;
    }

    /**
     * 获取当前限流状态，方便返回给客户端。
     *
     * @param string $identifier
     * @param int $limit
     * @param int $windowSeconds
     * @return array 包含剩余请求数、重置时间等信息。
     */
    public function getStatus(string $identifier, int $limit, int $windowSeconds): array
    {
        $key = $this->prefix . $identifier . ':' . $windowSeconds;
        $currentRequests = (int)$this->redis->get($key);
        $ttl = $this->redis->ttl($key); // 获取键的剩余生存时间（秒）

        $remaining = max(0, $limit - $currentRequests);
        // 如果ttl为-1（永不过期）或-2（键不存在），则表示没有重置时间，设为0或当前时间
        $resetTime = ($ttl > 0) ? time() + $ttl : (time() + $windowSeconds);

        return [
            'limit' => $limit,
            'remaining' => $remaining,
            'reset_time' => $resetTime, // Unix时间戳，表示何时可以再次请求
            'current_requests' => $currentRequests,
            'window_seconds' => $windowSeconds
        ];
    }
}

// --- 使用示例 ---
// 假设你已经连接了Redis
try {
    $redis = new PredisClient([
        'scheme' => 'tcp',
        'host'   => '127.0.0.1',
        'port'   => 6379,
    ]);
} catch (Exception $e) {
    die("无法连接到Redis: " . $e->getMessage());
}


$limiter = new ApiRateLimiter($redis);

// 假设我们对每个IP地址限制每60秒最多100次请求
$identifier = $_SERVER['REMOTE_ADDR'] ?? 'unknown_ip'; // 获取客户端IP
$limit = 100;
$window = 60; // 60秒

if (!$limiter->allowRequest($identifier, $limit, $window)) {
    // 请求被限流了
    header('HTTP/1.1 429 Too Many Requests');
    $status = $limiter->getStatus($identifier, $limit, $window);
    header('X-RateLimit-Limit: ' . $status['limit']);
    header('X-RateLimit-Remaining: ' . $status['remaining']);
    header('X-RateLimit-Reset: ' . $status['reset_time']); // Unix timestamp

    echo json_encode([
        'error' => 'Too many requests.',
        'message' => 'You have exceeded your request limit. Please try again after ' . ($status['reset_time'] - time()) . ' seconds.',
        'status' => $status
    ]);
    exit();
}

// 如果请求被允许，继续处理API逻辑
header('Content-Type: application/json');
echo json_encode([
    'message' => 'Request successful!',
    'data' => ['your_api_response_data' => 'hello world'],
    'status' => $limiter->getStatus($identifier, $limit, $window) // 也可以在这里返回状态
]);

?>

allowRequest

$this->redis->incr($key)

$this->redis->expire($key, $windowSeconds)

INCR

currentRequests

$identifier

user:123:api_path:/products

ApiRateLimiter

INCR

EXPIRE