topthink/think-queue

The ThinkPHP5 Queue Package

Friday, June 8, 2018
by topthink
Repository
12 Watchers
122 Stars
25,920 Installations

PHP
15 Dependents
0 Suggesters
36 Forks
23 Open issues
18 Versions
28 % Grown

The README.md

think-queue

安装

composer require topthink/think-queue, _(*1)

配置

配置文件位于 application/extra/queue.php, _(*2)

公共配置

[
    'connector'=>'sync' //驱动类型，可选择 sync(默认):同步执行，database:数据库驱动,redis:Redis驱动,topthink:Topthink驱动
                   //或其他自定义的完整的类名
]

驱动配置

各个驱动的具体可用配置项在think\queue\connector目录下各个驱动类里的options属性中，写在上面的queue配置里即可覆盖, _(*3)

使用 Database

创建如下数据表, _(*4)

CREATE TABLE `prefix_jobs` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `queue` varchar(255) NOT NULL,
  `payload` longtext NOT NULL,
  `attempts` tinyint(3) unsigned NOT NULL,
  `reserved` tinyint(3) unsigned NOT NULL,
  `reserved_at` int(10) unsigned DEFAULT NULL,
  `available_at` int(10) unsigned NOT NULL,
  `created_at` int(10) unsigned NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

创建任务类

单模块项目推荐使用 app\job 作为任务类的命名空间多模块项目可用使用 app\module\job 作为任务类的命名空间也可以放在任意可以自动加载到的地方, _(*5)

任务类不需继承任何类，如果这个类只有一个任务，那么就只需要提供一个fire方法就可以了，如果有多个小任务，就写多个方法，下面发布任务的时候会有区别
每个方法会传入两个参数 think\queue\Job $job（当前的任务对象）和 $data（发布任务时自定义的数据）, _(*6)

还有个可选的任务失败执行的方法 failed 传入的参数为$data（发布任务时自定义的数据）, _(*7)

下面写两个例子

namespace app\job;

use think\queue\Job;

class Job1{

    public function fire(Job $job, $data){

            //....这里执行具体的任务 

             if ($job->attempts() > 3) {
                  //通过这个方法可以检查这个任务已经重试了几次了
             }


            //如果任务执行成功后 记得删除任务，不然这个任务会重复执行，直到达到最大重试次数后失败后，执行failed方法
            $job->delete();

            // 也可以重新发布这个任务
            $job->release($delay); //$delay为延迟时间

    }

    public function failed($data){

        // ...任务达到最大重试次数后，失败了
    }

}


namespace app\lib\job;

use think\queue\Job;

class Job2{

    public function task1(Job $job, $data){


    }

    public function task2(Job $job, $data){


    }

    public function failed($data){


    }

}

发布任务

think\Queue::push($job, $data = '', $queue = null) 和 think\Queue::later($delay, $job, $data = '', $queue = null) 两个方法，前者是立即执行，后者是在$delay秒后执行, _(*8)

$job 是任务名
单模块的，且命名空间是app\job的，比如上面的例子一,写Job1类名即可
多模块的，且命名空间是app\module\job的，写model/Job1即可
其他的需要些完整的类名，比如上面的例子二，需要写完整的类名app\lib\job\Job2
如果一个任务类里有多个小任务的话，如上面的例子二，需要用@+方法名app\lib\job\Job2@task1、app\lib\job\Job2@task2, _(*9)

$data 是你要传到任务里的参数, _(*10)

$queue 队列名，指定这个任务是在哪个队列上执行，同下面监控队列的时候指定的队列名,可不填, _(*11)

监听任务并执行

php think queue:listen, _(*12)

php think queue:work --daemon（不加--daemon为执行单个任务）, _(*13)

两种，具体的可选参数可以输入命令加 --help 查看, _(*14)

可配合supervisor使用，保证进程常驻, _(*15)

The Versions

08/06 2018

2.0.x-dev

2.0.9999999.9999999-dev

The ThinkPHP5 Queue Package

think-extend think-queue

The ThinkPHP5 Queue Package

topthink/think-queue

The README.md

think-queue

安装

配置

公共配置

驱动配置

使用 Database

创建任务类

下面写两个例子

发布任务

监听任务并执行

The Versions

2.0.x-dev

The Requires

by yunwuxin

dev-master

The Requires

by yunwuxin

v2.0.4

The Requires

by yunwuxin

v2.0.2

The Requires

by yunwuxin

dev-analysis-8LY26m

The Requires

by yunwuxin

v1.1.5

The Requires

by yunwuxin

v2.0.3

The Requires

by yunwuxin

v2.0.1

The Requires

by yunwuxin

v2.0

The Requires

by yunwuxin

v1.1.4

The Requires

by yunwuxin

v1.1.3

The Requires

by yunwuxin

dev-analysis-q1WyJ3

The Requires

by yunwuxin

v1.1.2

The Requires

by yunwuxin

v1.1.1

The Requires

by yunwuxin

v1.1.0

The Requires

by yunwuxin

v1.0.2

by yunwuxin

v1.0.1

by yunwuxin

v1.0.0

by yunwuxin