简单使用Laravel队列

发表于 |

需求

有一个需求需要将表格中的作品从oss服务器拉取下来，因为这个任务耗时较长，就想尝试一下laravel的异步队列的功能，用户请求拉取的时候，立即返回请求成功，拉取任务在服务器异步进行。

配置环境

.env文件中设置QUEUE_CONNECTION=database，设置队列驱动，这里使用的框架是laravel 5.8，不同版本配置不同，本文使用database。

下面迁移jobs数据表，待执行的任务会记录在该表中。

php artisan queue:table

php artisan migrate

创建任务

php artisan make:job DownloadPic

执行以上命令，会在app/jobs目录下生成一个队列的任务类，生成的类实现了 Illuminate\Contracts\Queue\ShouldQueue 接口，这意味着这个任务将会被推送到队列中，而不是同步执行。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<?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 DownloadPic implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    private $list =[];    

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

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        //
        foreach($this->list as $item){
            //执行耗时的任务
        }
    }
}

此任务类被调用默认执行handle()方法

分发任务

新建一个Controller，将调用方法分配给一个路由，执行任务类的dispatch方法分发任务。

1
2
3
4
5
6
public function download()
{
    $list = StampDesign::get();
    DownloadPic::dispatch($list);;
    echo 'OK';
}

运行队列处理器

php artisan queue:work

执行该命令，开始持续监听队列

运行

访问download的路由，将下载任务推送到队列，队列处理器监听到队列的更新，将记录写在jobs表，执行队列任务，执行完成，删除jobs表中的已完成记录。