xin / thinkphp5-aliyunmns-queue
基于阿里云消息服务而适配的Thinkphp5的队列
Requires
- aliyun/aliyun-mns-php-sdk: ^1.1
- topthink/think-queue: ~2.0
This package is not auto-updated.
Last update: 2024-11-15 12:51:31 UTC
README
介绍
针对ThinkPHP5.1的队列（thinkphp-queue）做了阿里云消息队列的扩展，方便想使用阿里云消息队列同学快速开发。
安装教程
composer require xin/thinkphp5-aliyunmns-queue
使用说明
配置
配置文件位于 config/queue.php
<?php
return [
'connector' => 'AliyunMNS',
'endPoint' => '',
'accessId' => '',
'accessKey' => '',
'default' => 'default', // 默认队列名称
'wait' => 10, // 当队列中无任务时，最长等待时间
];
监听任务并执行
php think queue:listen // 适合任务少，任务不确定性
php think queue:work --daemon // 适合对性能有要求的，并且任务执行时间要短
两种，具体的可选参数可以输入命令加 --help 查看
可配合supervisor使用，保证进程常驻
创建任务类
单模块项目推荐使用 app\job 作为任务类的命名空间 多模块项目可用使用 app\module\job 作为任务类的命名空间 也可以放在任意可以自动加载到的地方
任务类不需继承任何类，如果这个类只有一个任务，那么就只需要提供一个fire方法就可以了，如果有多个小任务，就写多个方法，下面发布任务的时候会有区别 每个方法会传入两个参数 think\queue\Job $job（当前的任务对象） 和 $data（发布任务时自定义的数据）
还有个可选的任务失败执行的方法 failed 传入的参数为$data（发布任务时自定义的数据）
例子1:
<?php
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){
// ...任务达到最大重试次数后，失败了
}
}
例子2:
<?php
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 队列名，指定这个任务是在哪个队列上执行，同下面监控队列的时候指定的队列名,可不填
详细说明文档请参阅thinkphp-queue文档