think-queue处理延时任务事件

安装think-queue

• 官方地址：https://github.com/top-think/think-queue
• composer require topthink/think-queue

写业务控制器

/**
 * Created by 老吴.
 * UserMsg:砥砺前行，扬帆起航
 * email:[email protected]
 * QQ:1113249273
 * QQ群:925283872
 * 微信:cww0128
 * Date: 2021/5/18
 * Time: 9:53
 */

namespace app\api\controller;

use app\admin\model\general\Basic;
use app\admin\model\order\OrderItem;
use app\admin\model\user\Withdrawal;
use app\common\model\ScoreLog;
use think\Db;
use think\Exception;
use think\Queue\Job;

class DoJob
{
     
    /**
     * fire方法是消息队列默认调用的方法
     * @param Job $job 当前的任务对象
     * @param $data 发布任务时自定义的数据
     * @return int
     */
    public function fire(Job $job, $data)
    {
     
    

        if (empty($data)) {
     
            return 0;
        }
		$isJobDone = false;
		// 业务部分START
        // 有些消息在到达消费者时,可能已经不再需要执行了
        $isJobDone = true;
		// 业务部分END

        /*根据次数处理删除逻辑START*/
//        $nums = $job->attempts();
//        if ($nums > 0) {
     
//            $job->delete();
//        }
//        $job->delete();
        /*根据次数处理删除逻辑END*/

        if ($isJobDone) {
     
            // 如果任务执行成功，删除任务
            $job->delete();
        } else {
     
            if ($job->attempts() > 3) {
     
                //通过这个方法可以检查这个任务已经重试了几次了
                $job->delete();
                // 也可以重新发布这个任务
                //$job->release(2); //$delay为延迟时间，表示该任务延迟2秒后再执行
            }
        }
    }

}

调用消息队列

$jobHandlerClassName = 'app\api\controller\DoJob';  //根据Dojob命名空间位置来编写，Dojob如上面的控制器所示
$data = ['user_id' => 3];
$ret = Queue::later(10, $jobHandlerClassName, $data, $queue = 'OrderTimeOut'); //延时执行
$ret = Queue::push($jobHandlerClassName, $data, $queue = 'OrderTimeOut');//立即执行

相关说明

• Queue::later //延时执行
• Queue::push//立即执行
• $queue 队列名称，可以为null ，当有名称的时候，监听脚本： php think queue:listen --queue OrderTimeOut

准备工作

• 安装Redis，对应版本PHP安装redis扩展
• 安装supervisor用于监听事件，如下图所示

官方markdown存档：

安装

composer require topthink/think-queue

配置

配置文件位于 config/queue.php

公共配置

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

创建任务类

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

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

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

下面写两个例子

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\facade\Queue::push($job, $data = '', $queue = null) 和 think\facade\Queue::later($delay, $job, $data = '', $queue = null) 两个方法，前者是立即执行，后者是在$delay秒后执行

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

$data 是你要传到任务里的参数

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

监听任务并执行

php think queue:listen

php think queue:work

两种，具体的可选参数可以输入命令加 --help 查看

可配合supervisor使用，保证进程常驻

参考博客：

• 参考一：https://www.cnblogs.com/gyfluck/p/14024580.html
• 参考二：https://blog.csdn.net/qq_43489208/article/details/105140261