Laravel 5.5 定时任务调度

短命女 2022-04-23 09:54 453阅读 0赞

## 简介 ##

Cron 定时任务是 Linux 中非常常用的功能。通过 Cron 脚本能使计划任务定期地在系统后台自动运行。

Crontab 是用来记录在特定时间运行的 Cron 的一个脚本文件。

在服务器上通过 crontab -e 来新增或编辑 Cron 条目，通过 crontab -l 查看已存在的 Cron 条目列表。

在以前，开发者要为每一个需要执行的定时任务编写一个 Cron 条目，这是很让人头疼的事。你的任务调度不在源码控制中，你必须使用 SSH 登录到服务器后添加这些 Cron 条目。

Laravel 的命令调度器允许你流式地定义命令调度，在服务器上只需要一个 Cron 条目即可。

任务调度定义在 app/Console/Kernel.php 文件的 schedule 方法中。

protected function schedule(Schedule $schedule)
    {
        // $schedule->command('inspire')
        //          ->hourly();
    }

## 开启调度器 ##

想要开启调度器，你唯一需要添加到服务器的 Cron 条目为：

* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1

该 Cron 会每分钟调用一次 Laravel 命令调度器，然后，Laravel 会自动评估你的调度任务并运行到期的任务。

## 定义任务调度 ##

在 App\\Console\\Kernel.php 文件的 schedule 方法中定义所有的调度任务。

<?php
    
    namespace App\Console;
    
    use Illuminate\Console\Scheduling\Schedule;
    use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
    
    class Kernel extends ConsoleKernel
    {
    
        /**
         * 应用提供的 Artisan 命令
         *
         * @var array
         */
        protected $commands = [
            //
        ];
    
        /**
         * 定义应用的调度任务
         *
         * @return void
         */
        protected function schedule(Schedule $schedule)
        {
            // 每个小时执行一次 inspire 命令
            $schedule->command('inspire')->hourly();
            
            // 每天凌晨执行闭包
            $schedule->call(function () {
                echo 'test';
            })->daily();
        }
    }

任务调度的类型包含以下几种：

*  闭包
 *  Artisan 命令
 *  Shell 命令
 *  队列任务

### 调度闭包 ###

call 方法可用于调度闭包。

$schedule->call(function () {
                echo 'test';
            })->daily();

### 调度 Artisan 命令 ###

除了调度闭包外，还可以调度 Artisan 命令和操作系统命令。例如，可以使用 command 方法通过命令名或类来调度一个 Artisan 命令。

$schedule->command('emails:send --force')->daily();
    $schedule->command(EmailsCommand::class, ['--force'])->daily();

### 调度 Shell 命令 ###

exec 方法可用于调用操作系统命令。

$schedule->exec('node /home/forge/script.js')->daily();

### 调度队列任务 ###

job 方法可用于调度一个队列任务，通过该方法可以很方便地调度任务而不必调用 call 方法手动创建闭包来推送任务到队列。

$schedule->job(new Heartbeat)->everyFiveMinutes();

## 任务调度的常用选项 ##

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-&gt;cron('* * * * *');</td> 
   <td>自定义 Cron 调度的时间选项</td> 
  </tr> 
  <tr> 
   <td>-&gt;everyMinute();</td> 
   <td>每分钟运行一次任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;everyFiveMinutes();</td> 
   <td>每五分钟运行一次任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;everyTenMinutes();</td> 
   <td>每十分钟运行一次任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;everyFifteenMinutes();</td> 
   <td>每十五分钟运行一次任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;everyThirtyMinutes();</td> 
   <td>每三十分钟运行一次任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;hourly();</td> 
   <td>每小时运行一次任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;hourlyAt(17);</td> 
   <td>每小时第十七分钟运行一次任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;daily();</td> 
   <td>每天凌晨零点运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;dailyAt('13:00');</td> 
   <td>每天13:00运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;twiceDaily(1, 13);</td> 
   <td>每天1:00 &amp; 13:00运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;weekly();</td> 
   <td>每周运行一次任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;monthly();</td> 
   <td>每月运行一次任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;monthlyOn(4, '15:00');</td> 
   <td>每月4号15:00运行一次任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;quarterly();</td> 
   <td>每个季度运行一次</td> 
  </tr> 
  <tr> 
   <td>-&gt;yearly();</td> 
   <td>每年运行一次</td> 
  </tr> 
  <tr> 
   <td>-&gt;timezone('America/New_York');</td> 
   <td>设置时区</td> 
  </tr> 
 </tbody> 
</table>

这些方法可以和额外的约束结合起来创建特定时间运行的、更加细粒度的调度。

$schedule->call(function () {
        // 每周星期一13:00运行一次...
    })->weekly()->mondays()->at('13:00');
    
    // 工作日的上午8点到下午5点每小时运行...
    $schedule->command('foo')
             ->weekdays()
             ->hourly()
             ->timezone('America/Chicago')
             ->between('8:00', '17:00');

## 任务调度的额外约束 ##

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-&gt;weekdays();</td> 
   <td>只在工作日运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;sundays();</td> 
   <td>每个星期天运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;mondays();</td> 
   <td>每个星期一运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;tuesdays();</td> 
   <td>每个星期二运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;wednesdays();</td> 
   <td>每个星期三运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;thursdays();</td> 
   <td>每个星期四运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;fridays();</td> 
   <td>每个星期五运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;saturdays();</td> 
   <td>每个星期六运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;between($start, $end);</td> 
   <td>基于特定时间段运行任务</td> 
  </tr> 
  <tr> 
   <td>-&gt;when(Closure);</td> 
   <td>基于特定条件成立时，运行任务</td> 
  </tr> 
 </tbody> 
</table>

### 介于时间段的约束 ###

between 方法用于限定一天中特定时间段的任务执行。

$schedule->command('reminders:send')
             ->hourly()
             ->between('7:00', '22:00');

类似地，unlessBetween 方法用于排除指定时间段任务的执行。

$schedule->command('reminders:send')
             ->hourly()
             ->unlessBetween('23:00', '4:00');

### 特定条件的约束 ###

when 方法中的闭包，如果返回 true，任务才会执行。

$schedule->command('emails:send')->daily()->when(function () {
        return true;
    });

skip 方法和 when 相反，如果 skip 方法返回 true，调度任务将不会执行。

$schedule->command('emails:send')->daily()->skip(function () {
        return true;
    });

使用 when 方法链的时候，调度命令将只会执行返回 true 的 when 方法。

### 避免任务重叠 ###

默认情况下，即使前一个任务仍然在运行，调度任务也会运行，要避免这样的情况，可使用 withoutOverlapping 方法。

$schedule->command('emails:send')->withoutOverlapping();

在本例中，Artisan 命令 emails:send 每分钟都会运行 —— 如果该命令没有在运行的话。如果你的任务在执行时经常大幅度的变化，那么 withoutOverlapping 方法就非常有用，你不必再去预测给定任务到底要消耗多长时间。

如果需要的话，你可以指定 withoutOverlapping 锁失效前的分钟数，默认情况下，这个锁会在 24 小时后失效。

$schedule->command('emails:send')->withoutOverlapping(10);

### 维护模式 ###

当 Laravel 处于维护模式时，调度任务不会运行，不过，如果你想要在维护模式期间强制运行任务，可以使用 evenInMaintenanceMode 方法。

$schedule->command('emails:send')->evenInMaintenanceMode();

## 任务输出 ##

Laravel 调度器为处理调度任务输出提供了多个方便的方法。

可以使用 sendOutputTo 方法，发送输出到文件以便稍后检查。

$schedule->command('emails:send')
         ->daily()
         ->sendOutputTo($filePath);

如果你想要追加输出到文件，可以使用 appendOutputTo 方法。

$schedule->command('emails:send')
         ->daily()
         ->appendOutputTo($filePath);

使用 emailOutputTo 方法，你可以将输出通过邮件发送给接收人。使用邮件发送任务输出之前，需要配置 Laravel 的邮件服务。

$schedule->command('foo')
         ->daily()
         ->sendOutputTo($filePath)
         ->emailOutputTo('foo@example.com');

注意：emailOutputTo、 sendOutputTo 和 appendOutputTo 方法只对 command 方法有效。

## 任务钩子 ##

使用 before 和 after 方法，你可以指定在调度任务完成之前和之后要执行的代码。

$schedule->command('emails:send')
             ->daily()
             ->before(function () {
                 // 任务即将开始...
             })
             ->after(function () {
                 // 任务已经完成...
             });

## Ping URL ##

使用 pingBefore 和 thenPing 方法，调度器可以在任务完成之前和之后自动 ping 给定的 URL。该方法在通知外部服务时很有用。

$schedule->command('emails:send')
         ->daily()
         ->pingBefore($url)
         ->thenPing($url);

使用 pingBefore($url) 或 thenPing($url) 特性需要安装 HTTP 库 Guzzle，可以使用 Composer 包管理器来安装 Guzzle 依赖到项目。

composer require guzzlehttp/guzzle