# think-queue

**Repository Path**: rantotech/think-queue

## Basic Information

- **Project Name**: think-queue
- **Description**: think-queue 3.0(RabbitMQ) for ThinkPHP6
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 2
- **Created**: 2021-04-14
- **Last Updated**: 2025-01-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# think-queue 3.0(RabbitMQ) for ThinkPHP6

​	本项目由topthink/think-queue派生而来，增加了RabbitMQ驱动，并将官方通过symfony/process组件实现的阻塞式子进程调用改造为异步调用，运行时将会生成默认200个(通过maximum参数配置数量)异步Work进程从队列Pop出Job并执行，实测在处理单个任务耗时300ms的Job时，处理能力为280±个Job/秒。

​	服务器配置较高的情况下可以通过调整maximum配置或增加listen实例的方法提高处理性能。

`组件接入RabbitMQ采用的pull模式以及自动ack(出队即确认)`

##开发计划

- [x] 增加Amqp支持
- [x] 多个异步消费实例
- [x] 队列空闲或繁忙时自动缩减或增加消费实例
- [ ] Job处理协程化，实现每秒处理200*500个Job
- [ ] 增加rpc服务，独立消息中心方式运行

## 安装

> composer require rantowish/think-queue

## 配置

> 配置文件位于 `config/queue.php`

### 公共配置

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

## 使用说明

与官方think-queue组件使用方式完全一致。

### 创建任务类

> 单模块项目推荐使用 `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使用，保证进程常驻