限制速率的 Laravel 工作中间件

laravel-rate-limited-job-middleware 是一个针对 Laravel 应用的工作（Job）中间件，它可以实现对任务执行速率的有效控制。

支持我们

查看我们的广告以支持我们的开源项目。您还可以通过购买我们的付费产品来直接支持我们。在使用我们的包时，请考虑发送一张来自您的家乡的明信片到我们的地址，您可以在我们的联系页面找到它。所有收到的明信片都会被展示在我们的虚拟明信片墙上。

安装

使用 Composer 可以轻松安装这个包：

composer require spatie/laravel-rate-limited-job-middleware

请注意，此包要求您的 Laravel 应用已配置好 Redis。

使用方法

默认情况下，中间件将允许每秒执行最多 5 个任务。超出限制的任务将会在 5 秒后释放。要应用这个中间件，只需在你的 Job 类中添加 Spatie\RateLimitedMiddleware\RateLimited 到中间件数组：

namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Spatie\RateLimitedMiddleware\RateLimited;

class TestJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable;

    public function handle()
    {
        // 执行任务逻辑
    }

    public function middleware()
    {
        return [new RateLimited()];
    }
}

配置尝试次数

由于存在速率限制，工作类的尝试次数可能难以预估。建议使用基于时间的尝试次数，例如：

public function retryUntil() :  \DateTime
{
    return now()->addDay();
}

自定义行为

您可以自定义中间件的所有行为。以下是一个例子，允许在 60 秒内最多执行 30 个任务，并且不被允许的任务将在 90 秒后释放：

// 在你的 job 中

public function middleware()
{
    $rateLimitedMiddleware = (new RateLimited())
        ->allow(30)
        ->everySeconds(60)
        ->releaseAfterSeconds(90);

    return [$rateLimitedMiddleware];
}

实现指数退避策略

远程服务如 API 常有速率限制，或在处理时出现服务器错误。在这种情况下，在再次尝试之前增加延迟是合理的。你可以用 releaseAfterBackoff($this->attempts()) 替换 releaseAfter 方法来使用默认的 5 秒间隔。否则，您可以链式调用 releaseAfter 来调整退避间隔。

功能特性

• 默认限制为每秒 5 个工作，未被允许的任务将等待 5 秒。
• 支持自定义每秒允许的最大任务数和时间跨度。
• 提供了配置释放延时的选项，包括指数退避策略。
• 可以选择不释放被限制的任务。
• 允许有条件地应用中间件，如只在特定条件下启用。
• 能够自定义 Redis 连接和存储键。

如何定制化？

例如，您可以设置 60 秒内最大 30 次尝试，失败则等待 90 秒：

public function middleware()
{
    $rateLimitedMiddleware = (new RateLimited())
        ->allow(30)
        ->everySeconds(60)
        ->releaseAfterSeconds(90);

    return [$rateLimitedMiddleware];
}

测试与贡献

使用 composer test 命令进行测试。详细信息请参考 CONTRIBUTING 文件。

许可证

本项目遵循 MIT 许可协议。详情请见 LICENSE.md 文件。

---

laravel-rate-limited-job-middleware 是 Laravel 社区的一份强大的礼物，它为您的任务队列提供了精细的速率控制，确保服务的稳定性和效率。其简洁的配置和高度定制性使其成为任何 Laravel 开发者实现任务限速的理想选择。立即加入那些已经在享受其便利的开发者行列吧！