转载 thinkphp-queue 浅析

thinkphp-queue 浅析
传统的程序执行流程一般是 即时|同步|串行的,在某些场景下,会存在并发低,吞吐量低,响应时间长等问题。在大型系统中,一般会引入消息队列的组件,将流程中部分任务抽离出来放入消息队列,并由专门的消费者做针对性的处理,从而降低系统耦合度,提高系统性能和可用性。

一般来说,可以抽离的任务具有以下的特点:

  • 允许延后|异步|并行处理 (相对于传统的 即时|同步|串行 的执行方式)
    • 允许延后
      抢购活动时,先快速缓冲有限的参与人数到消息队列,后续再排队处理实际的抢购业务;
    • 允许异步
      业务处理过程中的邮件,短信等通知
    • 允许并行
      用户支付成功之后,邮件通知,微信通知,短信通知可以由多个不同的消费者并行执行,通知到达的时间不要求先后顺序。
  • 允许失败和重试
    • 强一致性的业务放入核心流程处理
    • 无一致性要求或最终一致即可的业务放入队列处理

thinkphp-queue 是thinkphp 官方提供的一个消息队列服务,它支持消息队列的一些基本特性:

  • 消息的发布获取执行删除重发失败处理延迟执行超时控制
  • 队列的多队列内存限制启动停止守护
  • 消息队列可降级为同步执行

thinkphp-queue 内置了 RedisDatabaseTopthinkSync这四种驱动。本文主要介绍 thinkphp-queue 结合其内置的 redis 驱动的使用方式和基本原理。

一、简单使用示例
1.1 安装 thinkphp-queue

composer install thinkphp-queue

1.2 搭建消息队列的存储环境
  • 使用 Redis
    安装并启动 Redis 服务 (详见:https://www.jianshu.com/p/34dd90fda917)
1.3 配置消息队列的驱动

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

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

   //    'connector' => 'Database',   // 数据库驱动
   //    'expire'    => 60,           // 任务的过期时间,默认为60秒; 若要禁用,则设置为 null
   //    'default'   => 'default',    // 默认的队列名称
   //    'table'     => 'jobs',       // 存储消息的表名,不带前缀
   //    'dsn'       => [],

   //    'connector'   => 'Topthink',   // ThinkPHP内部的队列通知服务平台 ,本文不作介绍
   //    'token'       => '',
   //    'project_id'  => '',
   //    'protocol'    => 'https',
   //    'host'        => 'qns.topthink.com',
   //    'port'        => 443,
   //    'api_version' => 1,
   //    'max_retries' => 3,
   //    'default'     => 'default',

   //    'connector'   => 'Sync',       // Sync 驱动,该驱动的实际作用是取消消息队列,还原为同步执行
   ];

1.4 消息的创建与推送

我们在业务控制器中创建一个新的消息,并推送到 helloJobQueue 队列
新增 \application\index\controller\JobTest.php 控制器,在该控制器中添加 actionWithHelloJob 方法

 'test'.rand(), 'password'=>rand()] ;
        // 4.将该任务推送到消息队列,等待对应的消费者去执行
        $time2wait = strtotime('2018-09-08 11:15: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()方法。 该方式的缺点是无法传入自定义数据。
1.5 消息的消费与删除

编写 Hello 消费者类,用于处理 helloJobQueue 队列中的任务
新增 \application\index\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;
    }
}

1.6 发布任务

在浏览器中访问 http://localhost/test/public/index.php/index/job_test/actionWithHelloJob 可以看到消息推送成功。

image
1.7 处理任务

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

image

同时打开 redis 可视化工具 Redis Desktop Manager (ps:附上百度网盘下载链接:链接:https://pan.baidu.com/s/1-k79ZEGD77EtUQFolJosXA 密码:xcfm)

image
  • 可见由于我设置了定时执行,所以队列处于待执行状态。当执行时间到了,队列会自动执行。
至此,我们成功地经历了一个消息的 创建 -> 推送 -> 消费 -> 删除 的基本流程
二、详细介绍

介绍 thinkphp-queue 的详细使用方法。如配置介绍,基本原理,各种特殊情况的处理等
注:在此篇文章不做详细说明,如需了解请参鉴
https://github.com/coolseven/notes/blob/master/thinkphp-queue/README.md

你可能感兴趣的:(转载 thinkphp-queue 浅析)