队列服务

配置

队列允许您将处理耗时的任务(例如发送电子邮件)推迟到稍后的时间，从而大大加快了对应用程序的Web请求。

队列配置文件存储在config/queue.php中。 在此文件中，您将找到包含的每个队列驱动程序的连接配置，例如数据库， Beanstalkd, IronMQ, Amazon SQS, Redis,，null和同步(用于本地使用)驱动程序。 null队列驱动程序只是丢弃排队的作业，因此永远不会执行它们。

先决条件

在使用Amazon SQS，Beanstalkd，IronMQ或Redis驱动程序之前，您需要安装Drivers plugin。

基本用法

将作业推送到队列中

要将新作业推送到队列，请使用Queue::push方法:

  1. Queue::push('SendEmail', ['message' => $message]);

push方法的第一个参数是应该用于处理作业的类的名称。 第二个参数是应该传递给处理程序的数据数组。 应该像这样定义一个作业处理程序:

  1. class SendEmail
  2. {
  3.     public function fire($job, $data)
  4.     {
  5.         //
  6.     }
  7. }

请注意，唯一需要的方法是fire，它接收一个Job实例以及被推入队列的data数组。

指定自定义处理程序方法

如果您希望作业使用fire以外的方法，则可以在推送作业时指定方法:

  1. Queue::push('SendEmail@send', ['message' => $message]);

指定作业的队列名称

为jobaYou指定队列名称还可以指定作业应发送到的队列/管道:

  1. Queue::push('SendEmail@send', ['message' => $message], 'emails');

延迟作业的执行

有时您可能希望延迟执行排队的作业。 例如，您可能希望将注册后15分钟向客户发送电子邮件的作业排队。 您可以使用Queue::later方法完成此操作:

  1. $date = Carbon::now()->addMinutes(15);
  3. Queue::later($date, 'SendEmail', ['message' => $message]);

在此示例中，我们使用Carbon 日期库来指定我们希望分配给作业的延迟。 或者，您可以将要延迟的秒数作为整数传递。

注意: Amazon SQS服务的延迟限制为900秒(15分钟)。

队列和模型

如果排队的作业在其数据中采用模型，则只有模型的标识符将序列化到队列中。 实际处理作业时，队列系统将自动从数据库中重新检索完整的模型实例。 它对您的应用程序完全透明，可以防止序列化完整模型实例时出现的问题。

删除已处理的作业

处理完作业后，必须从队列中删除它，这可以通过Job实例上的delete方法完成:

  1. public function fire($job, $data)
  2. {
  3.     // Process the job...
  5.     $job->delete();
  6. }

将作业释放回队列

如果您希望将作业释放回队列，可以通过release方法执行此操作:

  1. public function fire($job, $data)
  2. {
  3.     // Process the job...
  5.     $job->release();
  6. }

您还可以指定在作业发布之前等待的秒数:

  1. $job->release(5);

检查运行尝试次数

如果在处理作业时发生异常，它将自动释放回队列。 您可以使用attempts方法检查运行作业的尝试次数:

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

访问作业ID

您还可以访问作业标识符:

  1. $job->getJobId();

队列闭包

您也可以将Closure推入队列。 这对于需要排队的快速，简单的任务非常方便:

将闭包推入队列

  1. Queue::push(function($job) use ($id) {
  2.     Account::delete($id);
  4.     $job->delete();
  5. });

注意: 不要在排队的Closures通过use指令使用对象，可以传递主键并从队列作业中重新拉出关联的模型。 这通常可以避免意外的序列化行为。

使用Iron.io 推送队列时，您应该采取额外的预防措施排队闭包。 接收队列消息的端点应检查令牌以验证请求是否实际来自Iron.io. 例如，您的推送队列端点应该类似于:https://example.com/queue/receive？token = SecretToken。 然后，您可以在编组队列请求之前检查应用程序中的秘密令牌的值。

运行队列工作程序

October 包括一些将处理队列中的作业的控制台命令。

要在将新作业推入队列时处理它们，请运行queue:work命令:

  1. php artisan queue:work

此任务启动后，它将继续运行，直到手动停止。 您可以使用Supervisor等进程监视器来确保队列工作程序不会停止运行。

队列工作进程将引导的应用程序状态存储在内存中。 它们在启动后无法识别代码中的更改。 部署更改时，请重新启动队列工作程序。

处理单个工作

要仅处理队列中的第一个作业，请使用--once选项:

  1. php artisan queue:work --once

指定连接和队列

您还可以指定工作人员应使用的队列连接:

  1. php artisan queue:work connection

您可以将逗号分隔的队列连接列表传递给work命令以设置队列优先级:

  1. php artisan queue:work --queue=high,low

在这个例子中，在从low队列转移到作业之前，将始终处理high队列上的作业。

指定作业超时参数

您还可以设置允许每个作业运行的时间长度(以秒为单位):

  1. php artisan queue:work --timeout=60

指定队列睡眠持续时间

此外，您可以指定轮询新作业之前要等待的秒数:

  1. php artisan queue:work --sleep=5

请注意，如果队列中没有作业，则队列仅“休眠”。 如果有更多可用的作业，队列将继续工作而不会休眠。

Supervisor配置

安装Supervisor

Supervisor是Linux操作系统的进程监视器，如果失败，将自动重启queue:work进程。 要在Ubuntu上安装Supervisor，您可以使用以下命令:

  1. sudo apt-get install supervisor

配置Supervisor

Supervisor配置文件通常存储在/etc/supervisor/conf.d目录中。 在此目录中，您可以创建任意数量的配置文件，以指示supervisor如何监视您的进程。 例如，让我们创建一个october-worker.conf文件，它启动并监视queue:work进程:

  1. [program:october-worker]
  2. process_name=%(program_name)s_%(process_num)02d
  3. command=php /path/to/october/artisan queue:work --sleep=3 --tries=3
  4. autostart=true
  5. autorestart=true
  6. user=october
  7. numprocs=8
  8. redirect_stderr=true
  9. stdout_logfile=/path/to/october/worker.log

在这个例子中，numprocs指令将指示Supervisor运行8queue:work进程并监视所有进程，如果失败则自动重启它们。 当然，您应该更改命令指令的queue:work部分以反映您所需的队列连接。 应将user指令更改为有权运行该命令的用户的名称。

开始Supervisor

创建配置文件后，您可以使用以下命令更新Supervisor配置并启动进程:

  1. sudo supervisorctl reread
  3. sudo supervisorctl update
  5. sudo supervisorctl start october-worker:*

有关Supervisor的更多信息，请参阅Supervisor文档。

守护进程队列工作者

queue:work还包括一个--daemon选项，用于强制队列工作者继续处理作业而无需重新启动框架。 与queue:work命令相比，这会显着降低CPU使用率，但会增加部署期间需要耗尽当前正在执行的作业队列的复杂性。

要以守护进程模式启动队列工作程序，请使用--daemon标志：

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

您可以使用php artisan help queue:work命令查看所有可用选项。

使用守护程序队列工作程序进行部署

使用守护程序队列工作程序部署应用程序的最简单方法是在部署开始时将应用程序置于维护模式。 这可以使用后端设置区域完成。 应用程序处于维护模式后，October将不接受队列中的任何新作业，但将继续处理现有作业。

重新启动worker的最简单方法是在部署脚本中包含以下命令：

  1. php artisan queue:restart

此命令将指示所有队列工作程序在完成当前作业的处理后重新启动。

注意: 此命令依赖于缓存系统来安排重新启动。 默认情况下，APCu不适用于CLI命令。 如果您使用的是APCu，请将“apc.enable_cli = 1”添加到您的APCu配置中。

守护程序队列工作程序的编码

守护程序队列工作程序在处理每个作业之前不会重新启动平台。 因此，在工作完成之前，您应该小心释放任何重型资源。 例如，如果您使用GD库进行图像处理，则在完成后应使用imagedestroy释放内存。

同样，数据库连接在长时运行的守护程序使用时可能会断开连接。 您可以使用Db::reconnect方法来确保您有新的连接。

失败的任务

由于事情并不总是按计划进行，因此有时排队的工作会失败。 别担心，它发生在我们最好的人身上！ 有一种方便的方法可以指定尝试作业的最大次数。 作业超过此尝试次数后，它将被插入到“failed_jobs”表中。 可以通过config/queue.php配置文件配置失败的作业表名称。

您可以使用queue：work命令中的--tries开关指定应尝试作业的最大次数：

  1. php artisan queue:work connection-name --tries=3

如果要注册在队列作业失败时将调用的事件，可以使用Queue::failing方法。 此活动是通过电子邮件或其他第三方服务通知您的团队的绝佳机会。

  1. Queue::failing(function($connection, $job, $data) {
  2.     //
  3. });

您还可以直接在队列作业类上定义failed方法，允许您在发生故障时执行特定于作业的操作：

  1. public function failed($data)
  2. {
  3.     // Called when the job is failing...
  4. }

原始数据data也将自动传递给失败的方法。

重试失败的作业

要查看所有失败的作业，可以使用queue:failed Artisan命令：

  1. php artisan queue:failed

queue:failed命令将列出作业ID，连接，队列和失败时间。 作业ID可用于重试失败的作业。 例如，要重试ID为5的失败作业，应发出以下命令：

  1. php artisan queue:retry 5

如果要删除失败的作业，可以使用queue:forget命令：

  1. php artisan queue:forget 5

要删除所有失败的作业，可以使用queue:flush命令：

  1. php artisan queue:flush