thinkphp6 redis消息队列简单教程 --- 2021-06-09

thinkphp6 redis消息队列简单教程

1. 安装 thinkphp-queue

composer require topthink/think-queue

也可指定版本：composer require topthink/think-queue:2.*

2. 搭建消息队列的存储环境
   使用 Redis
   安装并启动 Redis 服务 看你个人使用的windows下还是linux下的redis服务（或者其他）；可自行搭建（这里不做介绍）

3. 配置消息队列的驱动
   根据选择的存储方式，在\app\config\queue.php这个配置文件中，添加消息队列对应的驱动配置

 'redis',
    'connections' => [
        'sync'     => [
            'type' => 'sync',
        ],
        'database' => [
            'type'  => 'database',
            'queue' => 'default',
            'table' => 'jobs',
        ],
        'redis'    => [
            'type'       => 'redis',
            'queue'      => 'default',
            'host'       => '127.0.0.1',
            'port'       => 6379,
            'password'   => '',
            'select'     => 0,
            'timeout'    => 0,
            'persistent' => false,
        ],
    ],
    'failed'      => [
        'type'  => 'none',
        'table' => 'failed_jobs',
    ],
];

?>

4. 消息的创建与推送
   我们在业务控制器中创建一个新的消息，并推送到 helloJobQueue 队列
   新增 \app\controller\Test.php 控制器，在该控制器中添加 actionWithHelloJob 方法

 'test'.rand(), 'password'=>rand()] ;
        // 4.将该任务推送到消息队列，等待对应的消费者去执行
        $time2wait = strtotime('2021-06-09 11:51: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"."
";
        }else{
            echo 'Oops, something went wrong.';
        }
    }

}

除了 Queue::push( jobHandlerClassName , jobData , jobQueueName );这种方式之外，还可以直接传入 Queue::push( jobHandlerObject ,null , jobQueueName ); 这时，需要在 jobHandlerObject 中定义一个 handle() 方法，消息队列在执行到该任务时会自动反序列化该对象，并调用其 handle()方法。 该方式的缺点是无法传入自定义数据。

5. 消息的消费与删除
   编写 Hello 消费者类，用于处理 helloJobQueue 队列中的任务
   新增 \app\job\Hello.php 消费者类（app目录下新建job目录，然后创建Hello.php文件），并编写其 fire() 方法

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']
        ]);
        return true;
    }

}

6. 发布任务
   在浏览器中访问 http://localhost/index.php/test/actionWithHelloJob 可以看到消息推送成功。

7. 处理任务
   切换当前终端窗口的目录到项目根目录下，执行
   php think queue:work --queue helloJobQueue
   可以看到执行的结果类似如下:

   
   
   image.png
   
   

   同时打开 redis 可视化工具 Redis Desktop Manager (没有的话 可下载去安装，然后连接上你的redis，就可以查看到工具了)

   
   
   image.png

以上是我使用thinkphp6 做的操作！