Laravel 队列基础使用

今天体验了 Laravel 框架中的队列功能，也遇到了一些问题，接下来记录一下使用的步骤，使用一个小小的案例进行说明。我使用的 Laravel5.5 框架，队列驱动为 Redis。

安装 Predis 扩展

$ composer require predis/predis

配置 Redis
打开 config/database.php 文件，找到 Redis 的配置信息：

'redis' => [
        'client' => 'predis',

        'default' => [
            'host' => env('REDIS_HOST', '127.0.0.1'),
            'password' => env('REDIS_PASSWORD', null),
            'port' => env('REDIS_PORT', 6379),
            'database' => 0,
        ],

        'session' => [
            'host' => env('REDIS_HOST', '127.0.0.1'),
            'password' => env('REDIS_PASSWORD', null),
            'port' => env('REDIS_PORT', 6379),
            'database' => 1,
        ],

        'queue' => [
            'host' => env('REDIS_HOST', '127.0.0.1'),
            'password' => env('REDIS_PASSWORD', null),
            'port' => env('REDIS_PORT', 6379),
            'database' => 2,
        ],

    ],

这里我配置了多个连接，保留 default 配置，由于使用 Redis 存储 Session，所以新建了一个名为 session 的配置，对应的数据库为1。然后新建 queue 配置用于队列，对应的数据库为2。这样配置的好处是各个功能的数据可以分开存放，运行和维护的时候会更加方便。

配置 .env 中的信息
打开 .env 文件，默认会有redis连接和队列的配置信息

QUEUE_DRIVER=redis

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

这里讲 QUEUE_DRIVER 改为 Redis，下面的 Reids 连接信息根据自己的情况进行填写。

新建一个队列 Job
使用 Laravel 的 Artisan 命令进行创建

$ php artisan make:job GoodsInfoToLog (这里根据自己的需要进行修改)

执行完成后会在 app 目录中出现 Job 目录和 GoodsInfoToLog.php 文件：

<?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;

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

    public function __construct()
    {

    }

    public function handle()
    {
  
    }
}

演示队列使用
在这里我将演示将商品信息使用队列系统记录到日志中:
修改 GoodsInfoToLog.php 文件：

<?php

namespace App\Jobs;

use App\Models\Goods;
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 GoodsInfoToLog implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    protected $goods;
  
    //将商品模型类进行依赖注入
    public function __construct(Goods $goods)
    {
        $this->goods = $goods;
    }

    //编写队列所执行任务的业务逻辑，下面是将商品信息记录到log中
    public function handle()
    {
        Log::info(['id' => $this->goods->id, 'title' => $this->goods->title, 'price' => $this->goods->price]);
    }
}

打开路由文件 web.php 进行路由注册，将这些任务记录到队列中：

Route::get('goodsInfo', function () {
    $goods = \App\Models\Goods::all();
    foreach ($goods as $item) {
        \App\Jobs\GoodsInfoToLog ::dispatch($item);
    }
});

打开浏览器，输入 example.com/goodsInfo ，回车，这样就会将任务记录到队列中。

打开命令行工具，进入到项目根目录，运行队列任务：

#执行一条队列任务
$ php artisan queue:work --once

执行完毕，打开日志，查看是否有内容输出：

[2019-01-08 23:22:14] local.INFO: array (
  'id' => 1,
  'title' => '感冒灵颗粒',
  'price' => '10.50',
)

ok，正常输出。继续执行则会继续记录，直到队列任务执行完毕；
如果想一次全部执行，可以使用:

$ php artisan queue:work

这样就会一次全部执行，查看 Log 是否正常输出。

6.安装 Horizon 扩展
Horizon 为 Laravel 官方发布的队列监控面板，他可以更加直观的展示队列的运行状况。执行以下命令进行安装：

$ composer require laravel/horizon

发布配置文件：

$ php artisan vendor:publish --provider="Laravel\Horizon\HorizonServiceProvider"

执行完成会在 config 目录创建 horizon.php 文件作为配置文件

打开 web.php路由文件，填入 horizon 的路由：

\Laravel\Horizon\Horizon::auth(function ($request) {
    //此处可进权限判断，测试情况下直径 return true 即可
    return true;
});

使用浏览器打开 example.com/horizon，就可以看到对应的界面：

注意状态为关闭，接下来启动该服务，在命令行中执行:

$ php artisan horizon

状态变为已启动；
有了 Horizon，我们的队列任务创建后会自动执行，更加方便，并且可以展示更多的队列执行的数据。

ok！这里只是讲述了最基本的用法，更详细的内容可以去查看官方文档。

文章同步发布在我的个人博客中，传送门Hesunfly Blog