剖析Laravel计划任务--创建和运行系统命令

安宇雨 - 随手采集
2018-12-19 13:41:22
随手采集
0000-未整理-等待研究

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

原文链接 https://divinglaravel.com/task-scheduling/building-and-running-the-os-command

在启动计划任务的事件的时候，Laravel 的进度管理器在Illuminate\Console\Scheduling\Event对象上调用 run() 方法，表示该事件发生在 Illuminate\Console\Scheduling\ScheduleRunCommand 内。

这个 run() 方法构建命令语法，并使用 Symfony Process 组件在操作系统上运行它，但在构建命令之前，它首先检查该命令是否应该在后台运行，默认情况下所有命令都在前台运行除非你使用以下方法来调度命令：

->runInBackground()

什么时候我需要在后台运行命令?

假设如果您有几个任务应该同时运行，比如每个小时，Laravel 默认设置会指示操作系统逐个运行命令：

~ php artisan update:coupons
# Waiting for the command to finish
# ...
# Command finished, now we run the next one
~ php artisan send:mail

但是，你可以指示操作系统在后台运行命令，以便您可以继续推送更多命令，即使其他命令尚未完成：

~ php artisan update:coupons &
~ php artisan send:mail &

使用命令末尾的＆符号可以继续推送命令，而无需等待初始化完成。

run() 方法检查 runInBackground 属性的值，并决定下一个调用哪个方法runCommandInForeground() 还是 runCommandInBackground()。

如果命令要在前台运行，其余部分就简单了：

$this->callBeforeCallbacks($container);

(new Process(
    $this->buildCommand(), base_path(), null, null, null
))->run();

$this->callAfterCallbacks($container);

Laravel 执行任意 before-callbacks，将命令发送到 OS，最后执行任意 before-callbacks。

但是，如果命令是在后台运行 Laravel 调用 callBeforeCallbacks()，发送命令，但不调用 after-callbacks，原因正如你所想的，因为该命令将在后台执行如果我们在这个时候调用 callAfterCallbacks() ，那么在命令完成之后，它将不会运行，一旦命令被发送到操作系统，它就会运行。

那么当我们在后台运行命令时，没有执行 after-callbacks？

他们运行了，laravel 在原来的一个命令完成后使用另一个命令运行：

(php artisan update:coupons ; php artisan schedule:finish eventMutex) &

这个命令会导致一系列的两个命令一个接一个地运行，但在后台运行，所以在你的 update:coupons 命令完成一个 schedule:finish 命令后，会运行给定当前事件的 Mutex，使用这个 ID Laravel 查找事件并运行其回调。

构建命令字符串

当调度程序调用 runCommandInForeground() 或 runCommandInBackground() 方法时，调用一个buildCommand() 来构建操作系统将运行的实际命令，这个方法只需执行以下操作：

return (new CommandBuilder)->buildCommand($this);

构建命令，需要知道以下配置：

命令 mutex
输出应发送到的位置
确定输出是否应该追加
运行命令的用户
后台还是前台

命令互斥

互斥是每个命令的唯一 ID 集合，Laravel 主要使用它来防止命令重叠，我们稍后将讨论，但它也将其用作命令的唯一 ID。

Laravel 在 Event::mutexName() 方法里面定义每一个命令的互斥:

return 'framework'.DIRECTORY_SEPARATOR.'schedule-'.sha1($this->expression.$this->command);

所以它是事件的 CRON 表达式和命令字符串的组合。

但是，对于回调事件是这样创建互斥的：

return 'framework/schedule-'.sha1($this->description);

所以为了确保你的回调事件有一个正确的互斥，你需要为命令设置一个描述：

$schedule->call(function () {
    DB::table('recent_users')->delete();
})->daily()->description('Clear recent users');

控制输出

默认情况下，命令的输出被发送到 /dev/null ，这是一个写入丢弃数据的特殊文件，但是如果你想在某个地方发送命令输出，可以使用 sendOutputTo() 定义命令：

$schedule->command('mail:send')->sendOutputTo('/home/scheduler.log');

但这会导致输出覆盖每次写入 scheduler.log 文件的任何东西，如果用追加的方式输出可以使用appendOutputTo()。命令如下所示：

// Append output to file
php artisan mail:send >> /home/scheduler.log 2>&1

// Overwrite file
php artisan mail:send > /home/scheduler.log 2>&1

2>&1 指示操作系统将错误输出重定向到标准输出通道，简而言之，这意味着错误和输出将被记录到您的文件中。

Using the correct user

使用正确的用户

当你设置一个用户去执行命令的时候:

$schedule->command('mail:send')->user('forge');

Laravel 会像下面这样执行命令:

sudo -u forge -- sh -c 'php artisan mail:send >> /home/scheduler.log 2>&1'

在后台运行

正如我们之前讨论过的，命令字符串将如下所示，它在后台运行：

(php artisan update:coupons ; php artisan schedule:finish eventMutex) &

但这只是一个简短的形式，这里是完整的字符串，实际上可以运行：

(php artisan update:coupons >> /home/scheduler.log 2>&1 ; php artisan schedule:finish eventMutex) > /dev/null 2>&1  &

或者如果您没有将其设置为追加输出，也没有定义自定义输出位置：

(php artisan update:coupons > /dev/null 2>&1 ; php artisan schedule:finish eventMutex) > /dev/null 2>&1  &

通过邮件发送输出

你可以通过调用 emailOutputTo() 方法来将命令输出发送到电子邮件

$schedule->command('mail:send')->emailOutputTo(['myemail@mail.com', 'myOtheremail@mail.com']);

如果有一个输出，你只想接收电子邮件你也可以使用 emailWrittenOutputTo() ，否则你会收到电子邮件即使现在输出给你你看到了，它也只是命令运行一个通知。

这个方法将更新计划事件的输出属性并将其输出到 storage/logs 目录中的文件：

if (is_null($this->output) || $this->output == $this->getDefaultOutput()) {
    $this->sendOutputTo(storage_path('logs/schedule-'.sha1($this->mutexName()).'.log'));
}

注意，只有在尚未设置自定义输出目标位置时，此操作才会起作用。

接下来，Laravel 将注册一个回调，尝试找到该文件，读取其内容，并将其发送到指定的收件人。

$text = file_exists($this->output) ? file_get_contents($this->output) : '';

if ($onlyIfOutputExists && empty($text)) {
    return;
}

$mailer->raw($text, function ($m) use ($addresses) {
    $m->to($addresses)->subject($this->getEmailSubject());
});

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

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

谢谢打赏