安装
composer require topthink/think-queue
配置
配置文件位于
config/queue.php
[
'default'=>'sync'
//驱动类型,可选择 sync(默认):同步执行,database:数据库驱动,redis:Redis驱动
//或其他自定义的完整的类名
]
创建任务类
任务类不需继承任何类,如果这个类只有一个任务,那么就只需要提供一个fire方法就可以了,如果有多个小任务,就写多个方法,下面发布任务的时候会有区别
每个方法会传入两个参数 think\queue\Job $job
(当前的任务对象) 和 $data
(发布任务时自定义的数据)
还有个可选的任务失败执行的方法 failed
传入的参数为$data
(发布任务时自定义的数据)
例子
默认任务
1、任务类
namespace app\job;
use think\queue\Job;
class Job1{
public function fire(Job $job, $data){
//....这里执行具体的任务
print_r($data);
if ($job->attempts() > 3) {
//通过这个方法可以检查这个任务已经重试了几次了
}
//如果任务执行成功后 记得删除任务,不然这个任务会重复执行,直到达到最大重试次数后失败后,执行failed方法
$job->delete();
// 也可以重新发布这个任务
$job->release($delay); //$delay为延迟时间
}
public function failed($data){
// ...任务达到最大重试次数后,失败了
}
}
2、执行队列
// 参数1:需要执行的任务类
// 参数2:发送的数据
// 参数3:队列名称 null为默认队列later
Queue::push('app\job\Job1',['msg'=>"好了",'code'=>200],null);
// 参数1:延迟执行的时间(秒)
// 参数2:需要执行的任务类
// 参数3:发送的数据
// 参数4:队列名称 null为默认队列later
Queue::later(10,'app\job\Job1',['msg'=>"好了",'code'=>200],null);
多任务
多任务可以写在一个文件里面,也可以分开多个文件写入,多个文件的时候,发送指定对应的执行类
namespace app\job;
use think\queue\Job;
class Job1{
public function Task1(Job $job, $data){
//....这里执行具体的任务
print_r($data);
if ($job->attempts() > 3) {
//通过这个方法可以检查这个任务已经重试了几次了
}
//如果任务执行成功后 记得删除任务,不然这个任务会重复执行,直到达到最大重试次数后失败后,执行failed方法
$job->delete();
// 也可以重新发布这个任务
$job->release($delay); //$delay为延迟时间
}
public function Task2(Job $job, $data){
print_r($data);
if ($job->attempts() > 3) {
//通过这个方法可以检查这个任务已经重试了几次了
}
}
public function Task3(Job $job, $data){
print_r($data);
if ($job->attempts() > 3) {
//通过这个方法可以检查这个任务已经重试了几次了
}
}
}
执行队列
// 实时发送
Queue::push('app\job\Job1@Task1',['msg'=>"好了",'code'=>200],'test1');
Queue::push('app\job\Job1@Task2',['msg'=>"好了",'code'=>200],'tes2');
Queue::push('app\job\Job1@Task3',['msg'=>"好了",'code'=>200],'test3');
// 延迟发送
Queue::later(10,'app\job\Job1@Task1',['msg'=>"好了",'code'=>200],'test1');
Queue::later(10,'app\job\Job1@Task2',['msg'=>"好了",'code'=>200],'test2');
Queue::later(10,'app\job\Job1@Task3',['msg'=>"好了",'code'=>200],'test3');
监听任务并执行
两种,具体的可选参数可以输入命令加 --help 查看
// 未指定队列或者其他参数情况
php think queue:listen
php think queue:work
// 执行队列 ,也可以指定多个
php think queue:listen --queue test1,test2
php think queue:work --queue test1