Laravel中使用Queue队列技巧

Laravel 队列为不一样的后台队列服务提供统一的 API，例如 Beanstalk，Amazon SQS，Redis，甚至其余基于关系型数据库的队列。队列的目的是将耗时的任务延时处理，好比发送邮件，从而大幅度缩短 Web 请求和相应的时间。

队列配置文件存放在 config/queue.php 。每一种队列驱动的配置均可以在该文件中找到，包括数据库，Beanstalkd ，Amazon SQS，Redis，以及同步（本地使用）驱动。其中还包含了一个 null 队列驱动用于那些放弃队列的任务

为何使用队列？

通常来讲使用队列是为了：

异步
重试
复制代码

也许你还有其余的理由使用队列，可是这应该是最基本的两个缘由。

什么状况使用队列？

了解了为何使用队列，那么通常有这么几类任务使用队列：

耗时比较久的，好比上传一个文件后进行一些格式的转化等。 须要保证送达率的，好比发送短信，由于要调用别人的 api，总会有概率失败，那么为了保证送达，重试就必不可少了。 使用队列的时候必定要想明白一个问题，这个任务究竟是不是能够异步，若是由于异步会致使问题，那么就要放弃使用队列。

驱动的必要设置

database.php

在 database.php 配置文件中对 redis 数据库部分进行配置，默认有一个 default 链接，就用这个好了:)

根据这个默认链接中须要的配置项，编辑 .env 配置文件，将其中的 REDIS_HOST、REDIS_PASSWORD、REDIS_PORT 填写成本身服务器中 Redis 的相应值。

queue.php

首先须要去 .env 中配置 QUEUE_DRIVER，由于如今打算用 Redis，因此配置成 redis。

接着配置 queue.php 里 connections 部分的 redis 链接，其中 connection 对应的值就是 database.php 中 redis 的那个 default 链接。

数据库

要使用 database 这个队列驱动的话，你须要建立一个数据表来存储任务。你能够用 queue:table 这个 Artisan

php artisan queue:table
复制代码

处理失败的任务

有时候你队列中的任务会失败。不要担忧，原本事情就不会一路顺风。

Laravel 内置了一个方便的方式来指定任务重试的最大次数。当任务超出这个重试次数后，它就会被插入到 failed_jobs 数据表里面。要建立 failed_jobs 表的迁移文件，你能够用 queue:failed-table 命令，接着使用 migrate Artisan 命令生成 failed_jobs 表：

php artisan queue:failed-table
复制代码

命令来建立这个数据表的迁移。当迁移建立好之后，就能够用 migrate 这条命令来建立数据表：

php artisan migrate
复制代码

执行命令讲解

php artisan queue:work --daemon --quiet --queue=default --delay=3 --sleep=3 --tries=3
复制代码

--daemon
复制代码

The queue:work Artisan command includes a --daemon option for forcing the queue worker to continue processing jobs without ever re-booting the framework. This results in a significant reduction of CPU usage when compared to the queue:listen command

整体来讲，在 supervisor 中通常要加这个 option，能够节省 CPU 使用。

--quiet
复制代码

不输出任何内容

--delay=3
复制代码

一个任务失败后，延迟多长时间后再重试，单位是秒。这个值的设定我我的建议不要过短，由于一个任务失败（好比网络缘由），重试时间过短可能会出现连续失败的状况。

--sleep=3
复制代码

去 Redis 中拿任务的时候，发现没有任务，休息多长时间，单位是秒。这个值的设定要看你的任务是否紧急，若是是那种很是紧急的任务，不能等待太长时间。

--tries=3
复制代码

定义失败任务最多重试次数。这个值的设定根据任务的重要程度来肯定，通常 3 次比较适合。

建立任务

生成任务类

在你的应用程序中，队列的任务类都默认放在 app/Jobs 目录下。若是这个目录不存在，那当你运行 make:job Artisan 命令时目录就会被自动建立。你能够用如下的 Artisan 命令来生成一个新的队列任务：

php artisan make:job Demo
复制代码

生成的类实现了 Illuminate\Contracts\Queue\ShouldQueue 接口，这意味着这个任务将会被推送到队列中，而不是同步执行。

<?php

namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Support\Facades\Log;

class Demo implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    public $param;
    /**
     * Create a new job instance.
     *
     * @return void
     */
    public function __construct($param = '')
    {
        $this->param = $param;
    }

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        Log::info('Hello, '.$this->param);
    }
}

复制代码

控制器代码

public function queue_demo()
{
    $num = rand(1,999999999);
    // 这个任务将被分发到默认队列...
    DemoJob::dispatch($num);
}
复制代码

开启队列

php artisan queue:work --queue=default
复制代码

因为是本地，须要打开监听，当访问到接口时，就会触发队列中的任务

线上的话须要用到supervisor的配置

Supervisor 配置

安装 Supervisor

Supervisor 是一个 Linux 操做系统上的进程监控软件，它会在 queue:listen 或 queue:work 命令发生失败后自动重启它们。在 Ubuntu 安装 Supervisor，能够用如下命令：

sudo apt-get install supervisor
复制代码

{tip} 若是本身手动配置 Supervisor 听起来有点难以应付，能够考虑使用 Laravel Forge，它能给你的 Laravel 项目自动安装与配置 Supervisor。

配置 Supervisor

Supervisor 的配置文件通常是放在 /etc/supervisor/conf.d 目录下。在这个目录中你能够建立任意数量的配置文件来要求 Supervisor 怎样监控你的进程。例如咱们建立一个 laravel-worker.conf 来启动与监控一个 queue:work 进程：

[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
autostart=true
autorestart=true
user=forge
numprocs=8
redirect_stderr=true
stdout_logfile=/home/forge/app.com/worker.log
复制代码

这个例子里的 numprocs 命令会要求 Supervisor 运行并监控 8 个 queue:work 进程，而且在它们运行失败后从新启动。固然，你必须更改 command 命令的 queue:work sqs ，以显示你所选择的队列驱动。

启动 Supervisor 当这个配置文件被建立后，你须要更新 Supervisor 的配置，并用如下命令来启动该进程：

sudo supervisorctl reread

sudo supervisorctl update

sudo supervisorctl start laravel-worker:*
复制代码

更多有关 Supervisor 的设置与使用，请参考 Supervisor 官方文档

具体示例代码参考github仓库