支持多种消息服务端的队列应用

2.2.0 版本
2023-04-25 版本更新时间
344 安装
10 star

<h1 align="center">Playcat Queue</h1>

<p align="center">webman下的消息队列服务</p>

特点

  1. 多种消息系统支持(Redis,Kafka)
  2. 高效的消息延迟和异常重试机制
  3. 支持大数据量处理场景

支持的消息系统

Redis Stream (已完成)

Redis Cluster Stream (已完成)

Kafka(已完成)

更多。。。

环境需求

  • PHP >= 7.2
  • webman >= 1.4
  • PHP Redis扩展 (使用redis)
  • PHP RdKafka扩展 (使用kafka)

安装

$ composer require "playcat/queue"

使用方法

1.选择自己的消息服务

  • 使用Redis Stream(默认)
    所用Redis的版本 >=5.0
    修改config\plugin\playcat\queue\redis.php为自己redis的配置即可

  • 使用Redis Cluster Stream
    所用Redis的版本 >=5.0并且配置好自己的集群环境
    编辑config\plugin\playcat\queue\manager.php修改里面的driver为如下内容

'driver' => \Playcat\Queue\Driver\Rediscluster::class,

编辑config\plugin\playcat\queue\rediscluster.php,替换对应的redis的配置即可

  • 使用Kafka

  • 创建Kafka的topic

./kaftopics.sh --create --bootstrap-server xxx:9092 --replication-factor 1 --partitions 1 --topic 任务名称
  • 编辑config\plugin\playcat\queue\manager.php修改里面的driver为如下内容
'driver' => \Playcat\Queue\Driver\Kafka::class,

编辑config\plugin\playcat\queue\Kafka.php,替换对应的Kafka的配置

2.创建消费者任务

新建一个名为'Test.php'文件添加以下内容:

<?php

namespace app\queue\playcat;

use Playcat\Queue\Model\Payload;
use Playcat\Queue\Protocols\Consumer;

class Test implements Consumer
{
    //任务名称
    public $queue = 'test';

    public function consume(Payload $payload)
    {
        //获取自定义传入的内容
        $data = $payload->getQueueData();
        ...
    }
}

将'Test.php'保存到'

app/queue/playcat/'目录下。如果目录不存在就创建它(
==可以编辑config/plugin/playcat/queue/process.php中的consumer_dir的地址来改变==)

启动webman的服务

$ php start.php start

添加任务

use Playcat\Queue\Manager;
use Playcat\Queue\Model\Payload;
$payload = new Payload();
//对应消费队列里的任务名称
$payload->setChannel('test');
//对应消费队列里的任务使用的数据
$payload->setQueueData([1,2,3,4]);
//创建一个立即执行的任务
Manager::getInstance()->push($payload);

$payload_delay = new Payload();
//对应消费队列里的任务名称
$payload_delay->setChannel('test');
//对应消费队列里的任务使用的数据
$payload_delay->setQueueData([6,7,8,9]);
//设置60秒后执行的任务
$payload_delay->setDelayTime(60);
Manager::getInstance()->push($payload_delay);`

异常与重试机制

任务在执行过程中未抛出异常则默认执行成功,否则则进入重试阶段.
重试次数和时间由配置控制,重试间隔时间为当前重试次数的幂函数。
Playcat\Queue\Exceptions\DontRetry异常会忽略掉重试

Playcat\Queue\Model\Payload

  • getID: 当前任务的唯一id
  • getRetryCount(): 当前任务已经重试过的次数
  • getQueueData(): 当前任务传入的参数
  • getChannel(): 当前所执行的任务名称

License

MIT