README

Laravel 的原生调度器允许您安排 artisan 命令每分钟运行一次。

如果您需要以更高的频率执行某些操作，例如每秒一次，那么您就找到了正确的包。安装了 laravel-short-schedule 之后，您可以这样做

// in app\Console\Kernel.php

protected function shortSchedule(\Spatie\ShortSchedule\ShortSchedule $shortSchedule)
{
    // this command will run every second
    $shortSchedule->command('artisan-command')->everySecond();
    
    // this command will run every 30 seconds
    $shortSchedule->command('another-artisan-command')->everySeconds(30);
    
    // this command will run every half a second
    $shortSchedule->command('another-artisan-command')->everySeconds(0.5);
    
    // this command will run every second and its signature will be retrieved from command automatically
    $shortSchedule->command(\Spatie\ShortSchedule\Tests\Unit\TestCommand::class)->everySecond();
}

您是视觉学习者吗？

在这个视频中，您将看到这个包的演示。

想了解其内部工作原理？那么请观看这个视频。

最后，还有一个视频展示了如何测试该包。您将了解如何测试由 ReactPHP 驱动的循环。

这些视频也是 Laravel 包培训的一部分。

支持我们

我们投入了大量资源来创建一流的开放源代码包。您可以通过购买我们的付费产品之一来支持我们。

我们非常感谢您从家乡寄给我们明信片，并说明您正在使用我们的哪些包。您可以在我们的联系页面上找到我们的地址。我们将发布所有收到的明信片在我们的虚拟明信片墙上。

安装

您可以通过 composer 安装此包

composer require spatie/laravel-short-schedule

在您的生产环境中，您可以使用此命令启动短期调度器

php artisan short-schedule:run

您应该使用进程监控器（如 Supervisor）来确保此任务始终运行，并在服务器启动时自动启动它。每次您更改计划时，都应该重新启动此命令。

处理内存泄漏

为了处理内存泄漏的命令，您可以设置短期调度器工作进程的生存时间（秒）

php artisan short-schedule:run --lifetime=60 // after 1 minute the worker will be terminated

在给定的时间后，工作进程及其所有子进程将被终止，释放所有内存。然后 supervisor（或类似的监视器）将其重新启动。

Lumen

在您的 Lumen 项目中运行 php artisan short-schedule:run 命令之前，您应该在您的 app/Commands 文件夹中复制 ShortScheduleRunCommand

cp ./vendor/spatie/laravel-short-schedule/src/Commands/ShortScheduleRunCommand.php ./app/Console/Commands/ShortScheduleRunCommand.php

接下来，编辑新的 ShortScheduleRunCommand.php 文件，将命名空间从 namespace Spatie\ShortSchedule\Commands; 更改为 namespace App\Console\Commands;，然后您就可以开始了！

用法

在 app\Console\Kernel 中，您应该添加一个名为 shortSchedule 的方法。

// in app\Console\Kernel.php

protected function shortSchedule(\Spatie\ShortSchedule\ShortSchedule $shortSchedule)
{
    // this artisan command will run every second
    $shortSchedule->command('artisan-command')->everySecond();
    
    // this artisan command will run every second, its signature will be resolved from container
    $shortSchedule->command(\Spatie\ShortSchedule\Tests\Unit\TestCommand::class)->everySecond();
}

指定秒数

您可以通过这种方式每秒运行一次 artisan 命令

$shortSchedule->command('artisan-command')->everySecond();

您可以使用everySeconds指定特定的秒数。

$shortSchedule->command('artisan-command')->everySeconds(30);

您甚至可以以亚秒的频率安排任务。此任务将以每半秒运行一次。

$shortSchedule->command('artisan-command')->everySeconds(0.5);

安排shell命令

使用exec来安排bash命令。

$shortSchedule->exec('bash-command')->everySecond();

防止重叠

默认情况下，即使上一个调用仍在运行，安排的命令也会运行。

您可以通过添加withoutOverlapping来防止这种情况。

$shortSchedule->command('artisan-command')->everySecond()->withoutOverlapping();

时间约束之间

限制任务在开始和结束时间之间运行。

$shortSchedule->command('artisan-command')->between('09:00', '17:00')->everySecond();

使用溢出天数是安全的。在这个例子中，命令将在每天21:00至01:00之间每秒钟运行一次。

$shortSchedule->command('artisan-command')->between('21:00', '01:00')->everySecond();

真值测试约束

如果给定的闭包返回一个真值，则命令将运行。闭包将在与命令相同的频率下评估。因此，如果您安排命令每秒运行一次，给定的闭包也将每秒运行一次。

$shortSchedule->command('artisan-command')->when(fn() => rand() %2)->everySecond();

环境约束

命令只会在给定环境中运行。

$shortSchedule->command('artisan-command')->environment('production')->everySecond();

您也可以传递一个数组。

$shortSchedule->command('artisan-command')->environment(['staging', 'production'])->everySecond();

复合约束

您可以同时使用上述所有约束。只有当所有使用的约束都通过时，命令才会执行。

$shortSchedule
  ->command('artisan-command')
  ->between('09:00', '17:00')
  ->when($callable)
  ->everySecond();

维护模式

当Laravel处于维护模式时，命令不会运行。如果您想强制在维护模式下运行命令，可以使用runInMaintenanceMode方法。

$shortSchedule->command('artisan-command')->everySecond()->runInMaintenanceMode();

在单个服务器上运行任务

限制命令只在一个服务器上运行。

$shortSchedule->command('artisan-command')->everySecond()->onOneServer();

事件

在响应这些事件时执行任何代码都会阻塞。如果您的代码执行时间过长，所有短时间安排的工作都会延迟。我们强烈建议将您希望对这些事件做出响应的任何代码放入队列中。

`Spatie\ShortSchedule\Events\ShortScheduledTaskStarting`

此事件将在任务开始之前触发。它有以下公共属性

command：将被执行的命令字符串
process：将用于执行命令的Symfony\Component\Process\Process实例

`Spatie\ShortSchedule\Events\ShortScheduledTaskStarted`