Планировщик задач

Введение

Раньше вы могли создавать Cron-записи для каждой запланированной задачи на вашем сервере. Но это могло быстро превратиться в рутину, так как планировщик задач больше не находится в системе контроля версий, и вы должны заходить через SSH на свой сервер, чтобы добавить Cron-записи.

Планировщик команд Laravel позволяет вам гибко и выразительно определить планирование своих команд в самом Laravel. И для этого на вашем сервере необходима только одна Cron-запись. Ваш планировщик задач определён в методе PHPschedule() файла app/Console/Kernel.php. Чтобы помочь вам начать, там уже есть простой пример с методом.

Запуск планировщика

При использовании планировщика вам надо добавить на ваш сервер только одну эту Cron-запись. Если вы не знаете, как добавлять Cron-записи на сервер, то можете использовать такой сервис, как Laravel Forge, который может управлять Cron-записями для вас:

sh* * * * * php /path/to/artisan schedule:run >>/dev/null 2>&1

Этот Cron будет вызывать планировщик команд Laravel каждую минуту. Когда будет выполнена команда shschedule:run, Laravel обработает ваши запланированные задачи и запустит только те задачи, которые должен.

Определение планировщика

Вы можете определить все свои запланированные задачи в методе PHPschedule() класса App\Console\Kernel. Для начала давайте посмотрим на пример планирования задачи. В этом примере мы запланируем замыкание PHPClosure, которое будет вызываться каждый день в полночь. В PHPClosure мы выполним запрос БД, чтобы очистить таблицу:

<?php

namespace App\Console;

use DB;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{
  /**
   * Artisan-команды вашего приложения.
   *
   * @var array
   */
  protected $commands = [
    \App\Console\Commands\Inspire::class,
  ];

  /**
   * Определяем планировщик команд приложения.
   *
   * @param \Illuminate\Console\Scheduling\Schedule $schedule
   * @return void
   */
  protected function schedule(Schedule $schedule)
  {
    $schedule->call(function () {
      DB::table('recent_users')->delete();
    })->daily();
  }
}

В дополнение к планированию вызовов PHPClosure вы можете также запланировать Artisan-команды и команды операционной системы. Например, вы можете использовать метод PHPcommand(), чтобы запланировать Artisan-команду, используя либо имя команды, либо класс:

$schedule->command('emails:send —force')->daily();

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

Команда PHPexec() может быть использована для обращения к операционной системе:

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

Настройки частоты планировщика

Конечно, есть множество вариантов планировщика, которые вы можете назначить на свою задачу:

Эти методы могут быть объединены с дополнительными ограничениями для создания ещё более гибкого планировщика, который будет работать только в определённые дни недели. Например, чтобы запланировать команду на еженедельный запуск в понедельник:

// Запуск каждый понедельник в 13:00...
$schedule->call(function () {
  //
})->weekly()->mondays()->at('13:00');

// Запускать каждый час с 8:00 до 17:00 по будням...
$schedule->command('foo')
         ->weekdays()
         ->hourly()
         ->timezone('America/Chicago')
         ->between('8:00', '17:00');

Ниже приведён список дополнительных ограничений в расписании:

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

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

Ограничения успешного теста

Метод PHPwhen() может быть использован, чтобы ограничить выполнение задачи на основании результата успешно пройденного теста. Другими словами, если заданное PHPClosure возвращает true, задача будет выполняться до тех пор, пока никакие другие ограничивающие условия не препятствуют её выполнению:

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

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

При использовании сцепленного метода PHPwhen(), запланированная команда выполнится только при условии, что все PHPwhen() возвратят true.

Предотвращение перекрытий задач

По умолчанию, запланированные задачи будут запускаться, даже если предыдущий экземпляр задачи всё ещё выполняется. Чтобы предотвратить это, вы можете использовать метод PHPwithoutOverlapping():

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

В этом примере Artisan-команда shemails:send будет запускаться каждую минуту, если она ещё не запущена. Метод PHPwithoutOverlapping() особенно полезен, если у вас есть задачи, которые изменяются коренным образом во время своего выполнения, что мешает вам предсказывать точно, сколько времени данная задача будет выполняться.

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

Выходные данные задачи

Планировщик Laravel предоставляет несколько удобных методов для работы с выходными данными, сгенерированными запланированными задачами. Во-первых, используя метод PHPsendOutputTo(), вы можете отправить вывод данных в файл для последующего анализа:

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

Если вы хотите добавить вывод в указанный файл, вы можете использовать метод PHPappendOutputTo():

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

Используя метод PHPemailOutputTo(), вы можете отправить по электронной почте выходные данные на адрес по вашему усмотрению. Обратите внимание, что данные должны быть сначала отправлены в файл с помощью метода PHPsendOutputTo(). Перед отправкой на электронную почту результата выполнения задачи вы должны настроить службы электронной почты Laravel:

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

Методы PHPemailOutputTo(), PHPsendOutputTo() и PHPappendOutputTo() доступны исключительно для метода PHPcommand() и не поддерживаются для PHPcall().

Обработчики прерываний задач

Используя методы PHPbefore() и PHPafter(), вы можете указать код, который будет выполняться до запуска и после завершения запланированной задачи:

$schedule->command('emails:send')
         ->daily()
         ->before(function () {
           // Перед запуском задачи...
         })
         ->after(function () {
           // Задача завершена...
         });

Пинг URL-адресов

Используя методы PHPpingBefore() и PHPthenPing(), планировщик может автоматически пинговать заданный URL до запуска и после завершения задачи. Этот метод полезен для уведомления внешней службы, например, Laravel Envoyer, о том, что ваша запланированная задача запустилась или закончила выполнение:

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

Использование функций PHPpingBefore($url) или PHPthenPing($url) требует библиотеки Guzzle HTTP.

shcomposer require guzzlehttp/guzzle

"guzzlehttp/guzzle": "~5.3|~6.0"