服务 ―― 队列
最后更新于：2022-04-01 04:11:30
# 服务 —— 队列
## 1、简介
Laravel队列服务为各种不同的后台队列提供了统一的API。队列允许你推迟耗时任务（例如发送邮件）的执行，从而大幅提高web请求速度。
### 1.1 配置
队列配置文件存放在`config/queue.php`。在该文件中你将会找到框架自带的每一个队列驱动的连接配置，包括数据库、[Beanstalkd](http://kr.github.com/beanstalkd)、 [IronMQ](http://iron.io/)、 [Amazon SQS](http://aws.amazon.com/sqs)、 [Redis](http://redis.io/)以及同步（本地使用）驱动。其中还包含了一个null队列驱动以拒绝队列任务。
### 1.2 队列驱动预备知识
### 1.2.1 数据库
为了使用`database`队列驱动，需要一张数据库表来存放任务，要生成创建该表的迁移，运行Artisan命令`queue:table`，迁移被创建好了之后，使用`migrate`命令运行迁移：
~~~
php artisan queue:table
php artisan migrate
~~~
### 1.2.2 其它队列依赖
下面是以上列出队列驱动需要安装的依赖：
* Amazon SQS: `aws/aws-sdk-php ~3.0`
* Beanstalkd: `pda/pheanstalk ~3.0`
* IronMQ: `iron-io/iron_mq ~2.0`
* Redis: `predis/predis ~1.0`
## 2、编写任务类
### 2.1 生成任务类
默认情况下，应用的所有队列任务都存放在`app/Jobs`目录。你可以使用Artisan CLI生成新的队列任务：
~~~
php artisan make:job SendReminderEmail --queued
~~~
该命令将会在`app/Jobs`目录下生成一个新的类，并且该类实现了`Illuminate\Contracts\Queue\ShouldQueue`接口，告诉Laravel该任务应该被推送到队列而不是同步运行。
### 2.2 任务类结构
任务类非常简单，正常情况下只包含一个当队列处理该任务时被执行的`handle`方法，让我们看一个任务类的例子：
~~~
<?php
namespace App\Jobs;
use App\User;
use App\Jobs\Job;
use Illuminate\Contracts\Mail\Mailer;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Bus\SelfHandling;
use Illuminate\Contracts\Queue\ShouldQueue;
class SendReminderEmail extends Job implements SelfHandling, ShouldQueue
{
use InteractsWithQueue, SerializesModels;
protected $user;
/**
* 创建一个新的任务实例
*
* @param User $user
* @return void
*/
public function __construct(User $user)
{
$this->user = $user;
}
/**
* 执行任务
*
* @param Mailer $mailer
* @return void
*/
public function handle(Mailer $mailer)
{
$mailer->send('emails.reminder', ['user' => $this->user], function ($m) {
//
});
$this->user->reminders()->create(...);
}
}
~~~
在本例中，注意我们能够直接将Eloquent模型传递到对列任务的构造函数中。由于该任务使用了`SerializesModels` trait，Eloquent模型将会在任务被执行是优雅地序列化和反序列化。如果你的队列任务在构造函数中接收Eloquent模型，只有模型的主键会被序列化到队列，当任务真正被执行的时候，队列系统会自动从数据库中获取整个模型实例。这对应用而言是完全透明的，从而避免序列化整个Eloquent模型实例引起的问题。
`handle`方法在任务被队列处理的时候被调用，注意我们可以在任务的`handle`方法中对依赖进行类型提示。Laravel[服务容器](http://laravelacademy.org/post/93.html)会自动注入这些依赖。
### 2.2.1 出错
如果任务被处理的时候抛出异常，则该任务将会被自动释放回队列以便再次尝试执行。任务会持续被释放知道尝试次数达到应用允许的最大次数。最大尝试次数通过Artisan任务`queue:listen`或`queue:work`上的`--tries`开关来定义。关于运行队列监听器的更多信息可以在[下面](http://laravelacademy.org/post/222.html#running-the-queue-listener)看到。
### 2.2.2 手动释放任务
如果你想要手动释放任务，生成的任务类中自带的`InteractsWithQueue` trait提供了释放队列任务的`release`方法，该方法接收一个参数——同一个任务两次运行之间的等待时间：
~~~
public function handle(Mailer $mailer){
if (condition) {
$this->release(10);
}
}
~~~
### 2.2.3 检查尝试运行次数
正如上面提到的，如果在任务处理期间发生异常，任务会自动释放回队列中，你可以通过`attempts`方法来检查该任务已经尝试运行次数：
~~~
public function handle(Mailer $mailer){
if ($this->attempts() > 3) {
//
}
}
~~~
## 3、推送任务到队列
默认的Laravel控制器位于`app/Http/Controllers/Controller.php`并使用了`DispatchesJobs` trait。该trait提供了一些允许你方便推送任务到队列的方法，例如`dispatch`方法：
~~~
<?php
namespace App\Http\Controllers;
use App\User;
use Illuminate\Http\Request;
use App\Jobs\SendReminderEmail;
use App\Http\Controllers\Controller;
class UserController extends Controller{
/**
* 发送提醒邮件到指定用户
*
* @param Request $request
* @param int $id
* @return Response
*/
public function sendReminderEmail(Request $request, $id)
{
$user = User::findOrFail($id);
$this->dispatch(new SendReminderEmail($user));
}
}
~~~
当然，有时候你想要从应用中路由或控制器之外的某些地方分发任务，因为这个原因，你可以在应用的任何类中包含`DispatchesJobs` trait，从而获取对分发方法的访问，举个例子，下面是使用该trait的示例类：
~~~
<?php
namespace App;
use Illuminate\Foundation\Bus\DispatchesJobs;
class ExampleClass{
use DispatchesJobs;
}
~~~
**为任务指定队列**
你还可以指定任务被发送到的队列。
通过推送任务到不同队列，你可以对队列任务进行“分类”，甚至优先考虑分配给多个队列的worker数目。这并不会如队列配置文件中定义的那样将任务推送到不同队列“连接”，而只是在单个连接中发送给特定队列。要指定该队列，使用任务实例上的`onQueue`方法，该方法有Laravel自带的基类`App\Jobs\Job`提供：
~~~
<?php
namespace App\Http\Controllers;
use App\User;
use Illuminate\Http\Request;
use App\Jobs\SendReminderEmail;
use App\Http\Controllers\Controller;
class UserController extends Controller{
/**
* 发送提醒邮件到指定用户
*
* @param Request $request
* @param int $id
* @return Response
*/
public function sendReminderEmail(Request $request, $id)
{
$user = User::findOrFail($id);
$job = (new SendReminderEmail($user))->onQueue('emails');
$this->dispatch($job);
}
}
~~~
### 3.1 延迟任务
有时候你可能想要延迟队列任务的执行。例如，你可能想要将一个注册15分钟后给消费者发送提醒邮件的任务放到队列中，可以通过使用任务类上的`delay`方法来实现，该方法由`Illuminate\Bus\Queueable` trait提供：
~~~
<?php
namespace App\Http\Controllers;
use App\User;
use Illuminate\Http\Request;
use App\Jobs\SendReminderEmail;
use App\Http\Controllers\Controller;
class UserController extends Controller{
/**
* 发送提醒邮件到指定用户
*
* @param Request $request
* @param int $id
* @return Response
*/
public function sendReminderEmail(Request $request, $id)
{
$user = User::findOrFail($id);
$job = (new SendReminderEmail($user))->delay(60);
$this->dispatch($job);
}
}
~~~
在本例中，我们指定任务在队列中开始执行前延迟60秒。
> 注意：Amazon SQS服务最大延迟时间是15分钟。
### 3.2 从请求中分发任务
映射HTTP请求变量到任务中很常见，Laravel提供了一些帮助函数让这种实现变得简单，而不用每次请求时手动执行映射。让我么看一下 `DispatchesJobs` trait上的`dispatchFrom`方法。默认情况下，该trait包含在Laravel控制器基类中：
~~~
<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
class CommerceController extends Controller{
/**
* 处理指定订单
*
* @param Request $request
* @param int $id
* @return Response
*/
public function processOrder(Request $request, $id)
{
// 处理请求...
$this->dispatchFrom('App\Jobs\ProcessOrder', $request);
}
}
~~~
该方法检查给定任务类的构造函数并从HTTP请求（或者其它`ArrayAccess`对象）中解析变量来填充任务需要的构造函数参数。所以，如果我们的任务类在构造函数中接收一个`productId`变量，该任务将会尝试从HTTP请求中获取`productId`参数。
你还可以传递一个数组作为`dispatchFrom`方法的第三个参数。该数组用于填充所有请求中不存在的构造函数参数：
~~~
$this->dispatchFrom('App\Jobs\ProcessOrder', $request, [
'taxPercentage' => 20,
]);
~~~
## 4、运行队列监听器
**开启任务监听器**
Laravel包含了一个Artisan命令用来运行推送到队列的新任务。你可以使用`queue:listen`命令运行监听器：
~~~
php artisan queue:listen
~~~
还可以指定监听器使用哪个队列连接：
~~~
php artisan queue:listen connection
~~~
注意一旦任务开始后，将会持续运行直到手动停止。你可以使用一个过程监视器如[Supervisor](http://supervisord.org/)来确保队列监听器没有停止运行。
**队列优先级**
你可以传递逗号分隔的队列连接列表到`listen`任务来设置队列优先级：
~~~
php artisan queue:listen --queue=high,low
~~~
在本例中，`high`队列上的任务总是在从`low`队列移动任务之前被处理。
**指定任务超时参数**
你还可以设置每个任务允许运行的最大时间（以秒为单位）：
~~~
php artisan queue:listen --timeout=60
~~~
**指定队列睡眠时间**
此外，可以指定轮询新任务之前的等待时间（以秒为单位）：
~~~
php artisan queue:listen --sleep=5
~~~
需要注意的是队列只会在队列上没有任务时“睡眠”，如果存在多个有效任务，该队列会持续运行，从不睡眠。
### 4.1 Supervisor配置
Supervisor为Linux操作系统提供的进程监视器，将会在失败时自动重启`queue:listen`或`queue:work`命令，要在Ubuntu上安装Supervisor，使用如下命令：
~~~
sudo apt-get install supervisor
~~~
Supervisor配置文件通常存放在`/etc/supervisor/conf.d`目录，在该目录中，可以创建多个配置文件指示Supervisor如何监视进程，例如，让我们创建一个开启并监视`queue:work`进程的`laravel-worker.conf`文件：
~~~
[program:laravel-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /home/forge/app.com/artisan queue:work sqs --sleep=3 --tries=3 --daemon
autostart=true
autorestart=true
user=forge
numprocs=8
redirect_stderr=true
stdout_logfile=/home/forge/app.com/worker.log
~~~
在本例中，`numprocs`指令让Supervisor运行8个`queue:work`进程并监视它们，如果失败的话自动重启。配置文件创建好了之后，可以使用如下命令更新Supervisor配置并开启进程：
~~~
sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start laravel-worker:*
~~~
要了解更多关于Supervisor的使用和配置，查看[Supervisor文档](http://supervisord.org/index.html)。此外，还可以使用Laravel Forge从web接口方便地自动配置和管理Supervisor配置。
### 4.2 后台队列监听器
Artisan命令`queue:work`包含一个`--daemon`选项来强制队列worker持续处理任务而不必重新启动框架。相较于`queue:listen`命令该命令对CPU的使用有明显降低：
~~~
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`任务来查看所有有效选项。
### 4.2.1 后台队列监听器编码考虑
后台队列worker在处理每个任务时不重启框架，因此，你要在任务完成之前释放资源，举个例子，如果你在使用GD库操作图片，那么就在完成时使用`imagedestroy`释放内存。
类似的，数据库连接应该在后台长时间运行完成后断开，你可以使用`DB::reconnect`方法确保获取了一个新的连接。
### 4.3 部署后台队列监听器
由于后台队列worker是常驻进程，不重启的话不会应用代码中的更改，所以，最简单的部署后台队列worker的方式是使用部署脚本重启所有worker，你可以通过在部署脚本中包含如下命令重启所有worker：
~~~
php artisan queue:restart
~~~
该命令会告诉所有队列worker在完成当前任务处理后重启以便没有任务被遗漏。
> 注意：这个命令依赖于缓存系统重启进度表，默认情况下，APC在CLI任务中无法正常工作，如果你在使用APC，需要在APC配置中添加`apc.enable_cli=1`。
## 5、处理失败任务
由于事情并不总是按照计划发展，有时候你的队列任务会失败。别担心，它发生在我们大多数人身上！Laravel包含了一个方便的方式来指定任务最大尝试执行次数，任务执行次数达到最大限制后，会被插入到`failed_jobs`表，失败任务的名字可以通过配置文件`config/queue.php`来配置。
要创建一个failed_jobs表的迁移，可以使用queue:failed-table命令：
~~~
php artisan queue:failed-table
~~~
运行[队列监听器](http://laravelacademy.org/post/222.html#running-the-queue-listener)的时候，可以在`queue:listen`命令上使用`--tries`开关来指定任务最大可尝试执行次数：
~~~
php artisan queue:listen connection-name --tries=3
~~~
### 5.1 失败任务事件
如果你想要注册一个队列任务失败时被调用的事件，可以使用`Queue::failing`方法，该事件通过邮件或[HipChat](https://www.hipchat.com/)通知团队。举个例子，我么可以在Laravel自带的`AppServiceProvider`中附件一个回调到该事件：
~~~
<?php
namespace App\Providers;
use Queue;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider{
/**
* 启动应用服务
*
* @return void
*/
public function boot()
{
Queue::failing(function ($connection, $job, $data) {
// Notify team of failing job...
});
}
/**
* 注册服务提供者
*
* @return void
*/
public function register()
{
//
}
}
~~~
### 5.1.1 任务类的失败方法
想要更加细粒度的控制，可以在队列任务类上直接定义`failed`方法，从而允许你在失败发生时执行指定动作：
~~~
<?php
namespace App\Jobs;
use App\Jobs\Job;
use Illuminate\Contracts\Mail\Mailer;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Bus\SelfHandling;
use Illuminate\Contracts\Queue\ShouldQueue;
class SendReminderEmail extends Job implements SelfHandling, ShouldQueue
{
use InteractsWithQueue, SerializesModels;
/**
* 执行任务
*
* @param Mailer $mailer
* @return void
*/
public function handle(Mailer $mailer)
{
//
}
/**
* 处理失败任务
*
* @return void
*/
public function failed()
{
// Called when the job is failing...
}
}
~~~
### 5.2 重试失败任务
要查看已插入到`failed_jobs`数据表中的所有失败任务，可以使用Artisan命令`queue:failed`：
~~~
php artisan queue:failed
~~~
该命令将会列出任务ID，连接，对列和失败时间，任务ID可用于重试失败任务，例如，要重试一个ID为5的失败任务，要用到下面的命令：
~~~
php artisan queue:retry 5
~~~
如果你要删除一个失败任务，可以使用`queue:forget`命令：
~~~
php artisan queue:forget 5
~~~
要删除所有失败任务，可以使用`queue:flush`命令：
~~~
php artisan queue:flush
~~~