剖析 Laravel 计划任务--事件属性

译文GitHub https://github.com/yuansir/diving-laravel-...

原文链接 https://divinglaravel.com/task-scheduling/...

你添加的每个记录都将转换为 Illuminate\Console\Scheduling\Event 的实例，并存储在Scheduler的 $events 类属性中，Event对象由以下内容组成：

• 命令运行
• CRON表达式
• 用于评估时间的时区
• 操作系统运行该命令的用户
• 命令应该运行的环境列表
• 维护模式配置
• 事件重叠配置
• 命令前台/后台运行配置
• 用于决定该命令是否运行的检查列表
• 如何处理输出的配置
• 命令运行后运行的回调
• 在命令运行前运行的回调
• 命令说明
• 命令的唯一Mutex

命令可能像下面一种方式运行：

• 回调
• 在操作系统上运行的命令
• artisan命令
• 被调度的作业

使用回调

在回调的情况下，Container::call() 方法用于运行我们传递的值，这意味着我们可以传递一个可以调用或表示方法的字符串：

protected function schedule(Schedule $schedule)
{
    $schedule->call(function () {
        DB::table('recent_users')->delete();
    })->daily();
}

Or:

protected function schedule(Schedule $schedule)
{
    $schedule->call('MetricsRepository@cleanRecentUsers')->daily();
}

调用操作系统的命令

如果要运行操作系统的命令，可以使用 exec()：

$schedule->exec('php /home/sendmail.php --user=10 --attachInvoice')->monthly();

您还可以将数组作为参数：

$schedule->exec('php /home/sendmail.php', [
    '--user=10',
    '--subject' => 'Reminder',
    '--attachInvoice'
])->monthly();

调用一个artisan命令

$schedule->command('mail:send --user=10')->monthly();

你也可以传一个类名

$schedule->command('App\Console\Commands\EmailCommand', ['user' => 10])->monthly();

你传递的值将转换为实际的shell命令，并传递给 exec() 在操作系统上运行。

调度一个作业

您可以使用Job类名称或实际对象将作业分发到队列中：

$schedule->job('App\Jobs\SendOffer')->monthly();

$schedule->job(new SendOffer(10))->monthly();

Laravel会创建一个回调函数，调用 dispatch() 辅助方法来分发你的命令。

所以在这里创建一个事件的两个实际方法是通过调用 exec() 或 call()，第一个提交一个 Illuminate\Console\Scheduling\Event 的实例，后者提交 Illuminate\Console\Scheduling\CallbackEvent来做一些特殊处理。

创建cron表达式

使用计划事件的计时方法，laravel会为该事件创建一个CRON表达式，默认情况下，表达式设置为每分钟运行一次命令：

* * * * * *

但当你调用 hourly() 时表达式会更新成这样:

0 * * * * *

当你调用 dailyAt('13:30') 时表达式会更新成这样:

30 13 * * * *

当你调用 twiceDaily(5, 14) 时表达式会更新成这样:

0 5,14 * * * *

一个非常聪明的抽象层，可以节省大量的精力来找到正确的cron表达式，但是如果你只要你想你也可以传递你自己的表达式：

$schedule->command('mail:send')->cron('0 * * * * *');

如何设置时区?

如果您希望CRON表达式针对特定时区，则可以使用以下方式进行：

->timezone('Europe/London')

Laravel检查您设置的时区值，并更新 Carbon 日期实例使其起作用。

那么Laravel会用CRON表达式检查命令是否到期吗？

恰恰相反，Laravel使用 mtdowling/cron-expression 库来确定命令是否基于当前系统时间（相对于我们设置的时区）。

在运行命令时添加限制

持续时间限制

例如，如果您希望命令每天运行，但只能在两个特定日期之间运行：

->between('2017-05-27', '2017-06-26')->daily();

如果你想防止它在一段特定的时间内运行：

->unlessBetween('2017-05-27', '2017-06-26')->daily();

环境限制

您可以使用 environments() 设置传递命令允许运行的环境列表：

->environments('staging', 'production');

维护模式

默认情况下，当应用程序处于维护模式时，调度的命令不会运行，但是您可以通过使用以下命令来更改：

->evenInMaintenanceMode()

系统用户

你可以设置那个操作系统用户来执行这个命令:

->user('forge')

Laravel将使用 sudo -u forge 设置在操作系统上运行的用户。

自定义限制

您可以使用 when() 和 skip() 方法定义自定义约束：

// Runs the command only when the user count is greater than 1000
->when(function(){
    return User::count() > 1000;
});

// Runs the command unless the user count is greater than 1000
->skip(function(){
    return User::count() > 1000;
});

之前和之后回调函数

使用 before() 和 then() 方法可以注册在命令完成执行之前或之后运行的回调函数：

->before(function(){
    Mail::to('myself@Mail.com', new CommandStarted());
})
->then(function(){
    Mail::to('myself@Mail.com', new CommandFinished());
});

您还可以使用 pingBefore() and thenPing() 方法ping URL或webhooks：

->ping('https://my-webhook.com/start')->thenPing('https://my-webhook.com/finish')

使用这些命令laravel在注册一个前/后回调，并使用Guzzle发送一个 GET HTTP请求：

return $this->before(function () use ($url) {
    (new HttpClient)->get($url);
});

转载请注明： 转载自Ryan是菜鸟 | LNMP技术栈笔记

如果觉得本篇文章对您十分有益，何不 打赏一下

本文链接地址: 剖析Laravel计划任务--事件属性

本作品采用《CC 协议》，转载必须注明作者和本文链接