0、启用命令方式
listen、work只能运行一种,运行work,再运行listen,那么就会停止work
指定任务名称运行(监听任务并执行1,2都可以)
-
php think queue:listen --queue 任务名称
如:php think queue:listen --queue helloJobQueue -
php think queue:work --daemon(不加--daemon为执行单个任务) 如:php think queue:work --queue helloJobQueue --daemon
缺点:每次创建的任务都需要人工在命令窗口中监听运行才能生效
例子:先创建A任务了,已经运行监听php think queue:listen --queue A任务,如果需要创建另一个B任务并运行,那么还需要再一次运行监听php think queue:listen --queue B任务,否则B任务不可能进行。
我们看一下自己的TP5的框架中的 TP5\vendor\topthink ,这个文件中有没有think-queue这个文件夹,如果没有请安装,安装这个是要用到Composer的如果没有安装composer
1.1 安装 thinkphp-queue
composer install thinkphp-queue
或 composer require topthink/think-queue=1.1.6
1.2 搭建消息队列的存储环境
安装使用 Redis,启用Redis扩展
1.3 配置消息队列的驱动
根据选择的存储方式,在\application\extra\queue.php这个配置文件中,添加消息队列对应的驱动配置
return [
'connector' => 'Redis',
'expire' => 60, // 任务的过期时间,默认为60秒; 若要禁用,则设置为 null
'default' => 'default', // 默认的队列名称
'host' => '127.0.0.1', // redis 主机ip
'port' => 6379, // redis 端口
'password' => '', // redis 密码
'select' => 0, // 使用哪一个 db,默认为 db0
'timeout' => 0, // redis连接的超时时间
'persistent' => false, // 是否是长连接
];
1.4 消息的创建与推送
我们在业务控制器中创建一个新的消息,并推送到 helloJobQueue 队列
新增 \application\index\controller\JobTest.php 控制器,在该控制器中添加 actionWithHelloJob 方法
<?php
namespace app\admin\controller;
use think\debug\Html;
use think\Request;
use think\Console;
use think\Queue;
class JobTest extends \think\Controller
{
/*
* 测试队列action http://tp5.com:2000/admin/Job_Test/actionWithHelloJob
* */
public function actionWithHelloJob(){
// 1.当前任务将由哪个类来负责处理。
// 当轮到该任务时,系统将生成一个该类的实例,并调用其 fire 方法
$jobHandlerClassName = 'app\admin\job\Hello@fire';
// 2.当前任务归属的队列名称,如果为新队列,会自动创建
$jobQueueName = "helloJobQueue";
// 3.当前任务所需的业务数据 . 不能为 resource 类型,其他类型最终将转化为json形式的字符串
// ( jobData 为对象时,需要在先在此处手动序列化,否则只存储其public属性的键值对)
$jobData = [ 'name' => 'test'.rand(), 'password'=>rand()] ;
// 4.将该任务推送到消息队列,等待对应的消费者去执行
$time2wait = strtotime('2022-08-13 16:12:00') - strtotime('now'); // 定时执行
$isPushed = Queue::later($time2wait, $jobHandlerClassName , $jobData , $jobQueueName );
// database 驱动时,返回值为 1|false ; redis 驱动时,返回值为 随机字符串|false
if( $isPushed !== false ){
echo date('Y-m-d H:i:s') . " a new Hello Job is Pushed to the MQ"."<br>";
}else{
echo 'Oops, something went wrong.';
}
}
}
1.5 消息的消费与删除
编写 Hello 消费者类,用于处理 helloJobQueue 队列中的任务
新增 \application\index\job\Hello.php 消费者类,并编写其 fire() 方法
<?php
namespace app\admin\job;
use think\queue\Job;
class Hello{
/**
* fire方法是消息队列默认调用的方法
* @param Job $job 当前的任务对象
* @param array|mixed $data 发布任务时自定义的数据
*/
public function fire(Job $job,$data){
// 如有必要,可以根据业务需求和数据库中的最新数据,判断该任务是否仍有必要执行.
$isJobStillNeedToBeDone = $this->checkDatabaseToSeeIfJobNeedToBeDone($data);
if(!$isJobStillNeedToBeDone){
$job->delete();
return;
}
$isJobDone = $this->doHelloJob($data);
if ($isJobDone) {
//如果任务执行成功, 记得删除任务
$job->delete();
}else{
if ($job->attempts() > 3) {
//通过这个方法可以检查这个任务已经重试了几次了
$job->delete();
// 也可以重新发布这个任务
//$job->release(2); //$delay为延迟时间,表示该任务延迟2秒后再执行
}
}
}
/**
* 有些消息在到达消费者时,可能已经不再需要执行了
* @param array|mixed $data 发布任务时自定义的数据
* @return boolean 任务执行的结果
*/
private function checkDatabaseToSeeIfJobNeedToBeDone($data){
return true;
}
/**
* 根据消息中的数据进行实际的业务处理
* @param array|mixed $data 发布任务时自定义的数据
* @return boolean 任务执行的结果
*/
private function doHelloJob($data) {
// 根据消息中的数据进行实际的业务处理...
// test
// Db::name('admin')->insert([
// 'name'=>$data['name'],
// 'password'=>$data['password']
// ]);
echo '正在工作中....';
return true;
}
}
1.6 发布任务
在浏览器中访问 http://tp5.com:2000/admin/Job_Test/actionWithHelloJob 可以看到消息推送成功。
查看redis客户端
1.7 处理任务(处理及监听)
切换当前终端窗口的目录到项目根目录下,执行
php think queue:listen --queue helloJobQueue
同时打开 redis 可视化工具,查看
定时执行,所以队列处于待执行状态。当执行时间到了,队列会自动执行。
至此,我们成功地经历了一个消息的 创建 -> 推送 -> 消费 -> 删除 的基本流程
注意:解决 运行命令 php think queue:listen 报错“count(): Parameter must be an array or
解决方法:
本文主要参考: