Очереди

Настройка

В Laravel, компонент Queue предоставляет единое API для различных сервисов очередей. Очереди позволяют вам отложить выполнение времязатратной задачи, такой как отправка e-mail, на более позднее время, таким образом на порядок ускоряя загрузку (генерацию) страницы.

Настройки очередей хранятся в файле app/config/queue.php. В нём вы найдёте настройки для драйверов-связей, которые поставляются вместе с фреймворком: Beanstalkd, IronMQ, Amazon SQS, Redis, а также синхронный драйвер (для локального использования).

Упомянутые выше драйвера имеют следующие зависимости:

• Beanstalkd: pda/pheanstalk ~2.0
• Amazon SQS: aws/aws-sdk-php
• IronMQ: iron-io/iron_mq

Основы использования

Добавление новой задачи в очередь

Queue::push('SendEmail', array('message' => $message));

Регистрация обработчика задачи

Первый аргумент метода PHPQueue::push() — имя класса, который должен использоваться для обработки задачи. Второй аргумент — массив параметров, которые будут переданы обработчику. Обработчик задачи должен быть зарегистрирован так:

class SendEmail {

    public function fire($job, $data) {
      //
    }

  }

Заметьте, что PHPfire() — единственный обязательный метод этого класса; он получает экземпляр объект PHPJob и массив данных, переданных при добавлении задачи в очередь.

Задача с произвольным методом-обработчиком

Если вы хотите использовать какой-то другой метод вместо fire — передайте его имя при добавлении задачи:

Queue::push('SendEmail@send', array('message' => $message));

Queue::push('SendEmail@send', array('message' => $message), 'emails');

Queue::bulk(array('SendEmail', 'NotifyUser'), $payload);

$date = Carbon::now()->addMinutes(15);

Queue::later($date, 'SendEmail@send', array('message' => $message));

Удаление выполненной задачи

Как только вы закончили обработку задачи она должна быть удалена из очереди — это можно сделать методом PHPdelete() объекта PHPJob:

public function fire($job, $data) {
  // Обработка задачи...

  $job->delete();
}

Помещение задачи обратно в очередь

Если вы хотите поместить задачу обратно в очередь — используйте метод PHPrelease():

public function fire($job, $data) {
  // Обработка задачи...

  $job->release();
}

Вы также можете указать число секунд, после которого задача будет помещена обратно:

$job->release(5);

Получение числа попыток запуска задания

Если во время обработки задания возникнет исключение, задание будет помещено обратно в очередь. Вы можете получить число сделанных попыток запуска задания методом PHPattempts():

if ($job->attempts() > 3) {
  //
}

Получение идентификатора задачи

$job->getJobId();

Добавление замыканий

Вы можете помещать в очередь и функции-замыкания. Это очень удобно для простых, быстрых задач, выполняющихся в очереди.

Добавление замыкания в очередь

Queue::push(function ($job) use ($id) {
  Account::delete($id);

  $job->delete();
});

Вместо того, чтобы делать объекты доступными для замыканий очередей через директиву PHPuse, передавайте первичные ключи и повторно извлекайте связанные модели из вашей задачи в очереди. Это часто позволяет избежать неожиданного поведения при сериализации.

Константы PHP__DIR__ и PHP__FILE__ не должны использоваться в замыканиях.

При использовании push-очередей Iron.io будьте особенно внимательны при добавлении замыканий. Конечная точка выполнения, получающая ваше сообщение, должна проверить входящую последовательность-ключ, чтобы удостовериться, что запрос действительно исходит от Iron.io. Например, ваша конечная push-точка может иметь адрес вида https://yourapp.com/queue/receive?token=SecretToken — где значение token можно проверять перед собственно обработкой задачи.

Работа сервера приёма очереди

Laravel включает в себя задание Artisan, которое будет выполнять новые задачи по мере их поступления. Вы можете запустить его командой queue:listen.

Запуск сервера приёма

shphp artisan queue:listen

Вы также можете указать, какое именно соединение должно прослушиваться:

shphp artisan queue:listen connection

Заметьте, что когда это задание запущено оно будет продолжать работать, пока вы не остановите его вручную. Вы можете использовать монитор процессов, такой как Supervisor, чтобы удостовериться, что задание продолжает работать.

shphp artisan queue:listen --queue=high,low

Указание времени на выполнение задачи

Кроме этого вы можете указать число секунд, в течение которых будет выполняться каждая задача:

shphp artisan queue:listen --timeout=60

Указание перерыва между задачами

Также вы можете задать число секунд ожидания перед проверкой наличия новых задач в очереди:

shphp artisan queue:listen --sleep=5

Обратите внимание, что очередь «засыпает» только тогда, когда в ней нет задач. Если задачи есть, очередь будет продолжать обрабатывать их без перерыва.

Обработка только первой задачи в очереди

Для обработки только первой задачи можно использовать команду queue:work:

shphp artisan queue:work

shphp artisan queue:work connection --daemon

php artisan queue:work connection --daemon --sleep=3

php artisan queue:work connection --daemon --sleep=3 --tries=3

shphp artisan queue:restart

Push-очереди

Push-очереди дают вам доступ ко всем мощным возможностям, предоставляемым подсистемой очередей Laravel 4 без запуска серверов или фоновых программ. На текущий момент push-очереди поддерживает только драйвер Iron.io. Перед тем, как начать, создайте аккаунт и впишите его данные в app/config/queue.php.

Регистрация подписчика push-очереди

После этого вы можете использовать Artisan-команду queue:subscribe для регистрации URL конечной точки, которая будет получать добавляемые в очередь задачи:

shphp artisan queue:subscribe queue_name http://foo.com/queue/receive

Теперь, когда вы войдёте в ваш профиль Iron.io, то увидите новую push-очередь и её URL подписки. Вы можете подписать любое число URL на одну очередь. Дальше создайте маршрут для вашей конечной точки queue/receive и пусть он возвращает результат вызова метода PHPQueue::marshal():

Route::post('queue/receive', function () {
  return Queue::marshal();
});

Этот метод позаботится о вызове нужного класса-обработчика задачи. Для помещения задач в push-очередь просто используйте всё тот же метод PHPQueue::push(), который работает и для обычных очередей.

shphp artisan queue:failed-table

shphp artisan queue:listen connection-name --tries=3

Queue::failing(function($connection, $job, $data)
{
  //
});

shphp artisan queue:failed

shphp artisan queue:retry 5

shphp artisan queue:forget 5

shphp artisan queue:flush