ThinkPHP使用think-queue实现redis消息队列

菜小编

2022-7-24

后端开发及架构

简单介绍：

消息队列中间件是大型系统中的重要组件，已经逐渐成为企业系统内部通信的核心手段。它具有松耦合、异步消息、流量削峰、可靠投递、广播、流量控制、最终一致性等一系列功能，已经成为异步RPC的主要手段之一。

大白话：

消息队列有两个角色和一个容器，角色分别为生产者（负责发布任务）和消费者（负责执行任务），容器这是用来存放/堆积生产者发布的任务，将发布和执行两个步骤分开且互不影响。

消息队列的大致流程为：

生产者发布任务存放/堆积在消息队列中，由消费者主动去消息队列中取出任务并执行，先发布的先执行（队列：先进先出），在没有消费者的情况下任务会堆积在队列中等待被取出执行。

优点：

消息队列适用于大并发或者处理时间长并需要批量操作的第三方接口，可用于但不仅限于短信发送、邮件发送、APP推送等，支持跨系统，即本系统发布的消息队列可以由自己或者给其他系统执行任务，同理本系统也可以作为消费者执行自己或者其他系统发布的消息队列任务。

接下来主要介绍一下 think-queue 的使用

ThinkPHP的Queue内置了 Redis、Database、Topthink、Sync四种驱动，这里使用的是 Redis，也推荐使用 Redis.

think-queue 队列消息可以进行任务的发布、获取、执行、删除、重新发布、延迟发布、超时控制等操作

消息队列基本配置

在 extra 目录下创建 queue.php 配置文件

<?phpreturn [
    'connector'  => 'Redis',
    'expire'     => null,   // 任务过期时间，默认为60秒，若要禁用，则设置为 null
    'default'    => 'REDIS_QUEUE',  // 默认的队列名
    'host'       => '127.0.0.1',   // redis 主机ip
    'port'       => 6379,   // redis 端口
    'password'   => '',   // redis 密码
    'select'     => 0,   // 使用哪里一个 db，默认为 db0
    'timeout'    => 0,   // redis 连接的超时时间
    'persistent' => false,   // 是否是长连接];

至于为什么放在这里，是因为 Queue 源代码默认从 extra 读取 queue 文件获取配置信息，如果想要将配置文件放置其他地方，则需要对应去修改源代码中的默认获取配置，如下图所示

在这里插入图片描述

生产者

创建一个测试类，写入生产者方法

<?phpnamespace app\api\controller;use think\Controller;use think\Queue;class Test extends Controller{
    // 生产者，添加消息队列
    public function addQueue()
    {
        // 参数
        $data = [
            'id' => rand(0, 99),
            'userName' => '一起摸鱼'
        ];

        // 消息队列名
        $queueName = 'testQueue';

        // 推入消息队列，注意这里的 ::class 是PHP5.5才有的写法
        $isPushed = Queue::push(TestQueue::class, $data, $queueName);
        // PHP5.5以下的可以直接写命名空间
        // $isPushed = Queue::push('app\common\queue\TestQueue', $data, $queueName);
        
        if ($isPushed !== false) {
            // 成功之后的业务
            echo '队列加入成功';
        } else {
            // 失败之后的业务
            echo '队列加入失败';
        }
    }}

消费者

创建一个 TestQueue 类，用做消费者，执行消息队列中的任务

<?phpnamespace app\common\queue;use think\Log;use think\queue\Job;class TestQueue{
    // 消费者执行入口
    public function fire(Job $job, $data)
    {
        // 具体执行业务
        $isJobDone = $this->doJob($data);
        
        if ($isJobDone) {
            // 消息队列执行成功，删除队列，否则会一直执行
            $job->delete();
        } else {
            // 消息队列执行失败
            // 获取消息队列已经重试了几遍
            $attempts = $job->attempts();
            if ($attempts == 0 || $attempts == 1) {
                // 重新发布，参数 delay 是延时发布的时间
                $job->release(2);
            }
        }
    }

    // 消息队列执行失败后会自动执行该方法
    public function failed($data)
    {
        Log::error('消息队列达到最大重复执行次数后失败：' . json_encode($data));
    }

    // 消息队列执行方法
    public function doJob($data)
    {
        // 具体执行业务
        
        
        $data = json_encode($data);
        echo '消息队列：' . $data;
        // 这里的判断条件以具体业务是否执行成功进行判断
        if ($data) {
            echo "执行成功";
            return true;
        } else {
            echo "执行失败";
            return false;
        }
    }}