laravel5配置horizon队列控制面板

原创文章，转载注明出处。

horizon是laravel的官方的队列控制面板。

安装时的要点是：

1126补充。
laravel系统刚composer安装完成后，config中带有一个queue.php
安装horizon 时，必须先确保 queue.php
里的 connections.redis.connection,默认是default。
得对应 database.php 里的 redis.下面的键。

所以，可以在database.php里 加上 自己命名的键。
同时 在 queue.php里 设置这个自己命名的键。

composer require laravel/horizon ，这一步仅仅vendor目录修改。
php artisan horizon:install,此命令影响如下：

modified:   config/app.php

Untracked files:
  (use "git add <file>..." to include in what will be committed)

app/Providers/HorizonServiceProvider.php
config/horizon.php
public/vendor/

其中，app.php修改了providers 键，多了一行。
App\Providers\HorizonServiceProvider::class
另外加一个配置文件horizon.php，加一个服务提供者HorizonServiceProvider.php
加public/vendor目录，是静态页面。。

==========================================================================
==========================================================================

创建队列任务。
php artisan make:job JobTest
修改此类。
public function handle()
    {
        //
        logger(time());
        logger(11);
        //echo 12;

    }


修改
route/web.php

Route::get('/', function () {

    \App\Jobs\JobTest::dispatch()->onQueue('default');

    return '加入队列成功';
});


==========================================================================
最好在生产服务器上也使用
php artisan horizon:install 这个命令。
原因是他居然在public下会生成文件。而一般的laravel插件不会这么做。
很容易忘记拷贝从本地。

注意：
supervisord的配置文件里，
user配置必须是真实的用户。

修改app/Provides/HorizonServiceProvider.php：

<?php

namespace App\Providers;

use Laravel\Horizon\Horizon;
use Illuminate\Support\Facades\Gate;
use Laravel\Horizon\HorizonApplicationServiceProvider;

class HorizonServiceProvider extends HorizonApplicationServiceProvider
{
    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        Horizon::auth(function ($request) {
            return true;

        });
    }


    /**
     * Register the Horizon gate.
     *
     * This gate determines who can access Horizon in non-local environments.
     *
     * @return void
     */
    protected function gate()
    {
        Gate::define('viewHorizon', function ($user) {
            return true ;
        });
    }

}

配置要点：
horizon的配置中，
'path' => 'admin/horizon',把这个面板的页面放到admin路径后。
然后在laravel-admin里，设置菜单，角色自己定义，路径horizon

然后为了安全起见，
horizon的配置文件里:
'middleware' => ['web','admin',],
这样的话，只有登录后台，才能看到面板。

继续这个配置文件，下面这个queue是在database.php配置的。
'use' => 'queue',

database.php
'redis' => [

        'client' => 'phpredis',

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

            //'read_timeout' => 60,
        ],


        // 这是用于缓存的。
        'cache' => [
            '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,
        ],

    ],
每个redis都有16个库，编号应该是从0到15
一定要分开来，不过就算不分的话，他好像是有前缀的，关系也不大，分最好。分的参数是那个database

继续：
下面那个supervisor，并不代表必须要使用supervisord。只要执行
php artisan horizon这个命令，都会生效。
processes这个参数，生成多少个进程。
queue这个参数重要，确定这个配置监听哪些队列。


'environments' => [
        'production' => [
            'supervisor-1' => [
                'connection' => 'redis',
                'queue' => ['q1','qiye_weixin','email','log1','log2'],
                'balance' => 'false',
                'processes' => 3,
                'tries' => 3,
            ],
            'supervisor-2' => [
                'connection' => 'redis',
                'queue' => ['default',],
                'balance' => 'false',
                'processes' => 1,
                'tries' => 3,
            ],
        ],

        'local' => [
            'supervisor-1' => [
                'connection' => 'redis',
                'queue' => ['default','q1','qiye_weixin','email','log1','log2'],
                'balance' => 'simple',
                'processes' => 3,
                'tries' => 3,
            ],
        ],
    ],


配置补充：
3个配置文件
database.php
queue.php
horizon.php
，其中，键名自己定义，下面只是实例，也可以不添加，只修改也行的。
示例如下：
其中，database.php里设置了多个redis连接。自己添加一个队列专用的。
'db_queue_redis' => [
            'url' => env('REDIS_URL'),
            'host' => env('REDIS_HOST', '127.0.0.1'),
            'password' => env('REDIS_PASSWORD', null),
            'port' => env('REDIS_PORT', 6379),
            'database' => env('REDIS_DB', 0),
        ],


，把queued.php 的  添加
'queue_redis' => [
            'driver' => 'redis',
            'connection' => 'db_queue_redis',
            'queue' => 'default',
            'retry_after' => 90,
            'block_for' => null,
        ],
3，给 queue.php  的设置 default 键

'default' => 'queue_redis',

4、horizon.php
'environments' => [
        'production' => [
            'supervisor-1' => [
                'connection' => 'queue_redis',
                'queue' => ['default'],
                'balance' => 'simple',
                'processes' => 10,
                'tries' => 1,
            ],
        ],

        'local' => [
            'supervisor-1' => [
                'connection' => 'queue_redis',
                'queue' => ['default'],
                'balance' => 'simple',
                'processes' => 3,
                'tries' => 1,
            ],
        ],
    ],

5、关于 horizon.php 的 use指令，可以用默认 的default 连接。也可以自己修改。随意。






使用要点：
当使用horizon之后，就不需要再使用
php artisan queue:work 这个命令了。

而是改由
php artisan horizon 这个命令来消费队列。
当然，在生产环境中，肯定也不是直接使用这个命令，而是使用supervisord，反正也超简单的。

/etc/supervisord.d/horizon.ini：

[program:horizon]
process_name=%(program_name)s
command=php /应用目录/artisan horizon
autostart=true
autorestart=true
user=nginx //需根据实际情况修改
redirect_stderr=true
stdout_logfile=/应用目录/storage/logs/horizon.log 根据实际改

妈妈再也不用担心我没有好用的php队列了！