跳到主要内容
版本：5.0

队列

设置​

Laravel 队列组件提供一个统一的 API 集成了许多不同的队列服务，队列允许你延后执行一个耗时的任务，例如延后至指定的时间才发送邮件，进而大幅的加快了应用程序处理请求的速度。

队列的配置文件在 config/queue.php，在这个文件你将可以找到框架中每种不同的队列服务的连接设置，其中包含了 Beanstalkd、IronMQ、Amazon SQS、Redis、null，以及同步 (本地端使用) 驱动设置。驱动 null 只是简单的舍弃队列工作，因此那些工作永远不会执行。

队列数据表​

为了能够使用 database 驱动，你需要建立一个数据表来保存工作。要使用一个迁移建立这个数据表，可以执行 queue:table Artisan 命令：

php artisan queue:table

其他队列依赖​

下面的依赖是使用对应的队列驱动所需的扩展包：

  • Amazon SQS: aws/aws-sdk-php
  • Beanstalkd: pda/pheanstalk ~3.0
  • IronMQ: iron-io/iron_mq ~1.5
  • Redis: predis/predis ~1.0

基本用法​

推送一个工作至队列​

应用程序中能够放进队列的工作都存放在 App\Commands 目录下，你可以借由下面 Artisan 命令产生一个可使用队列的命令：

php artisan make:command SendEmail --queued

要推送一个新的工作至队列，请使用 Queue::push 方法：

Queue::push(new SendEmail($message));
注意

在这个例子当中，我们直接使用 Queue Facade，然而，常见的作法是借由 Command Bus 去分派队列命令。我们将会在这篇文章中继续使用 Queue Facade，不过，也要熟悉使用 command bus，因为它能够同时分派你的网站应用程序中队列与同步的命令。

默认情况下，make:command Artisan 命令会产生一个 "self-handling" 的命令，意味着命令里会包含一个 handle 方法。这个方法将会在队列执行时被调用。你可以在 handle 方法使用时提示传入任何你需要的依赖，而 服务容器 会自动注入他们：

public function handle(UserRepository $users)
{
    //
}

如果你希望你的命令有独立的处理类别，你可以在使用 make:command 命令时加上 --handler 标识。

php artisan make:command SendEmail --queued --handler

这个被产生出来的处理类别将会放在 App\Handlers\Commands 目录下面，并且服务容器会自动解析。

指定队列使用特定连接​

你也可指定队列工作送至指定的连接：

Queue::pushOn('emails', new SendEmail($message));

发送相同的数据去多个队列工作​

如果你需要发送一样的数据去几个不同的队列工作，你可以使用 Queue::bulk 方法：

Queue::bulk([new SendEmail($message), new AnotherCommand]);

延迟执行一个工作​

有时候你可能想要延迟执行一个队列工作，举例来说你希望一个队列工作在客户注册 15 分钟后才寄送 e-mail，你可以使用 Queue::later 方法来完成这件事情：

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

Queue::later($date, new SendEmail($message));

在这个例子中，我们使用 Carbon 日期类库来指定我们希望队列工作希望延迟的时间，另外你也可发送一个整数来设置你希望延迟的秒数。

注意

在 Amazon SQS 服务中，有最大 900 秒（ 15 分钟 ）的限制。

将 Eloquent 模型放进队列​

如果你队列工作的构造器接收一个 Eloquent 模型，只有这个模型的标记（ identifier ） 会被序列化后放到队列中。当工作真正开始被处理的时候，队列系统会自动从数据库中重新取得完整的模型实例。这个对你的网站应用程序来说是完全透明的，并且预防一些在序列化完整 Eloquent 模型实例时可能遇到的问题。

删除一个处理中的工作​

一旦一个工作被处理过后，这个工作必须从队列中删除。假如在工作执行后没有发生错误，这个将会自动完成。

如果你希望能够手动删除或着释放工作，在 Illuminate\Queue\InteractsWithQueue trait 中提供 release 以及 delete 方法的接口。其中 release 方法接受单一一个值：你想要等待工作再次能够执行的秒数。

public function handle(SendEmail $command)
{
    if (true)
    {
        $this->release(30);
    }
}

释放一个工作回到队列中​

假如在工作执行后发生错误，这个工作将会自动被释放回到队列之中，如此一来便能够再次尝试执行工作。工作会一直被释放回队列直到到达应用程序的尝试上限。这个上限数值可以在使用 queue:listen 或 queue:work Artisan 命令时候借由 --tries 开关来设置。

检查工作执行次数​

当一个工作执行后发生错误，这个工作将会自动的释放回队列当中，你可以透过 attempts 方法来检查这个工作已经被执行的次数：

if ($this->attempts() > 3)
{
    //
}
注意

你的命令处理类别必须使用 Illuminate\Queue\InteractsWithQueue 这个 trait 才能够使用这个方法。

队列闭包​

你也可以推送一个闭包去队列，这个方法非常的方便及快速的来处理需要使用队列的简单的任务：

推送一个闭包至队列​

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

    $job->delete();
});
注意

要让一个组件变量可以在队列闭包中可以使用我们会通过 use 命令，试着发送主键及重复使用的相关模块在你的队列工作中，这可以避免其他的序列化行为。

当使用 Iron.io push queues 时,你应该在队列闭包中采取一些其他的预防措施，我们应该在执行工作收到队列数据时检查token是否真来自 Iron.io，举例来说你推送一个队列工作到 https://yourapp.com/queue/receive?token=SecretToken，接下来在你的工作收到队列的请求时，你就可以检查token的值是否正确。

执行一个队列监听​

Laravel 内含一个 Artisan 命令，它将推送到队列的工作拉来下执行，你可以使用 queue:listen 命令，来执行这件常驻任务：

开始队列监听​

php artisan queue:listen

你也可以指定特定队列连接让监听器使用：

php artisan queue:listen connection

注意当这个任务开始时，这将会一直持续执行到他被手动停止，你也可以使用一个处理监控如 Supervisor 来确保这个队列监听不会停止执行。

你也可以在 listen 命令中使用逗号分隔的队列连接，来设置不同队列连接的优先层级：

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

在这个范列中，总是会优先处理 high-connection 中的工作，然后才处理 low-connection。

指定工作超时参数​

你也可以设置给每个工作允许执行的秒数：

php artisan queue:listen --timeout=60

指定队列休息时间​

此外，你也可以指定让监听器在拉取新工作时要等待几秒：

php artisan queue:listen --sleep=5

注意队列只会在工作时休息，假如有许多可执行的工作，队列会持续的处理工作而不会休息

处理队列上的第一个工作​

当你只想处理队列上的一个工作你可以使用 queue:work Artisan 命令：

php artisan queue:work

常驻队列处理器​

在 queue:work 中也包含了一个 --daemon 选项，强迫队列处理器持续处理工作，而不会每次都重新启动框架，这个作法比起 queue:listen 可有效减少 CPU 使用量，但是却增加了布署时，对于处理中队列任务的复杂性。

要启动一个常驻的队列处理器，使用 --daemon：

php artisan queue:work connection --daemon

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

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

如你所见 queue:work 命令支持 queue:listen 大多相同的选项参数，你也可使用 php artisan help queue:work 命令来观看全部可用的选项参数。

布署常驻队列处理器​

最简单布署一个应用程序使用常驻队列处理器的方式，就是将应用程序在开始布署时转成维护模式，你可以使用 php artisan down 命令来完成这件事情，当这个应用程序在维护模式，Laravel 将不会允许任何来自队列上的新工作，但会持续的处理已存在的工作。

要重新启动 queue 也是非常容易，请将底下命令加到部署命令：

php artisan queue:restart

上述命令会在执行完目前的工作后，重新启动队列。

注意

这个命令依赖缓存系统来排定重新启动任务。默认 APCu 无法在命令提示字符中工作。如果你正在使用 APCu 请将 apc.enable_cli=1 加到你的 APCu 设置当中。

撰写常驻队列处理器​

常驻队列处理器不会在处理每一个工作之前都重新启动框架。因此，你应该注意并小心地在工作处理完成之前释放占用的资源。例如，如果你正在使用 GD 函式库操作图片，当你完成工作的时候，你应该使用 imagedestroy 方法来释放占用的内存。

同样地，数据库连接可能在长时间执行的队列处理器中断线，你可以使用 DB::reconnect 方法来确保你每次都有一个全新的连接。

推送队列​

你可以利用强大的 Laravel 5 队列架构来进行推送队列工作，不需要执行任何的常驻或背景监听，目前只支持 Iron.io 驱动，在你开始前建立一个 Iron.io 帐号及添加你的 Iron 凭证到 config/queue.php 配置文件。

注册一个推送队列订阅​

接下来，你可以使用 queue:subscribe Artisan 命令注册一个 URL，这将会接收新的推送队列工作：

php artisan queue:subscribe queue_name queue/receive

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

现在当你登录你的 Iron 管理后台，你将会看到你新的推送队列，以及订阅的 URL，你可以订阅许多的 URLs 给你希望的队列，接下来建立一个 route 给你的 queue/receive 及从 Queue::marshal 方法回传回应：

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

这里的 marshal 方法会将触发正确的处理类别，而发送工作到队列中只要使用一样的 Queue::push 方法。

已失败的工作​

事情往往不会如你预期的一样，有时候你推送工作到队列会失败，别担心，Laravel 包含一个简单的方法去指定一个工作最多可以被执行几次，在工作被执行到一定的次数时，他将会添加至 failed_jobs 数据表里，然后失败工作的数据表名称可以在 config/queue.php 里进行设置：

要产生一个迁移来建立 failed_jobs 数据表，你可以使用 queue:failed-table Artisan 命令：

php artisan queue:failed-table

你可以指定一个最大值来限制一个工作应该最多被执行几次，在你执行 queue:listen 时加上 --tries：

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

假如你会想注册一个事件，这个事件会将会在队列失败时被调用，你可以使用 Queue::failing 方法，这个事件是一个很好的机会让你可以通知你的团队通过 e-mail 或 HipChat。

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

你可能够直接在队列工作类别中定义一个 failed 方法，这让你能够在工作失败时候，执行一些特定的动作：

public function failed()
{
    // 当工作失败的时候会被调用……
}

重新尝试失败的工作​

要看到所有失败的工作，你可以使用 queue:failed 命令：

php artisan queue:failed

这个 queue:failed 命令将会列出工作 ID、连接、队列名称及失败的时间，可以使用工作 ID 重新执行一个失败的工作，例如一个已经失败的工作的 ID 是 5，我们可以使用下面的命令：

php artisan queue:retry 5

假如你想删除一个失败的工作，可以使用 queue:forget 命令：

php artisan queue:forget 5

要删除全部失败的工作，可以使用 queue:flush 命令：

php artisan queue:flush