(Simple 简单 easy 容易 expand 的拓展)
KafKa是由Apache基金会维护的一个分布式订阅分发系统,KafKa它最初的目的是为了解决,统一,高效低延时,高通量(同时能传输的数据量)并且高可用一个消息平台,它是分布式消息队列,分布式日志,数据传输通道的不二之选,但是可惜的时PHP的拓展实在不是很好用(php- kafka拓展已经长期不维护存在非常多的问题,rdkafkaC底层编写不利于使用),希望可以更加方便的来使用KafKa这块肥肉于是基于rdKafKa封装的一个简单舒适KafKa拓展诞生了!
附上:
GitHub地址:https://github.com/wenzhenxi/See-KafKa
rdkafka PHP拓展地址:https://github.com/arnaud-lb/php-rdkafka
服务底层依赖:https://github.com/edenhill/librdkafka
作者博客:http://w-blog.cn
(See-KafKa支持0.9~0.10版本,对0.8版本以及以前的版本协议不支持)
首先需要安装配置好zookeeper+KafKa:可以参考作者博客下的KafKa模块下的介绍安装,作者博客介绍是对于0.8.2.2的安装方式,但是和0.9和0.10的安装并没有区别,只需要去下载0.9和0.10的包即可
在使用之前需要按照顺序先安装 librdkafka ,在安装 php-rdkafka :
# 安装librdkafka git clone https://github.com/edenhill/librdkafka.git cd librdkafka ./configure make make install # 安装php-rdkafka git clone https://github.com/arnaud-lb/php-rdkafka.git cd php-rdkafka phpize ./configure make all -j 5 make install # 在php.ini加入如下信息 vim /usr/local/php/etc/php.ini extension=rdkafka.so
这个时候使用 php -m 可以看到拓展列表内存在 rdkafka这项证明拓展已经安装成功
See-KafKa完美支持PhalApi,只需要把去拓展库中获取kafka拓展即可,当然不是PhalApi的也可以使用只需要 include 文件下的kafka.php即可使用
KafKa最基础的两个角色其中一个就是Producer(可以参考作者博客介绍)
向KafKa中的一个Topic写入一条消息,需要写入多条可以多次使用setMassage
<?php /** * See-kafka Producer例子 * 循环写入1w条数据15毫秒 */ // 配置KafKa集群(默认端口9092)通过逗号分隔 $KafKa_Lite = new KafKa_Lite("127.0.0.1,localhost"); // 设置一个Topic $KafKa_Lite->setTopic("test"); // 单次写入效率ok 写入1w条15 毫秒 $Producer = $KafKa_Lite->newProducer(); // 参数分别是partition,消息内容,消息key(可选) // partition:可以设置为KAFKA_PARTITION_UA会自动分配,比如有6个分区写入时会随机选择Partition $Producer->setMessage(0, "hello");
对于Consumer来说支持4种从offset的获取方式分别为:
KAFKA OFFSET STORED #通过group来获取消息的offset(必须设置group)
KAFKA OFFSET END #获取尾部的offset
KAFKA OFFSET BEGINNING #获取头部的offset
手动指定offset开始值
此例子适合获取一段数据就结束的场景,每一次getMassage都会建立连接然后关闭连接,当循环使用getMassage会造成相对严重的效率问题
<?php /** * See-kafka Consumer例子1 */ // 配置KafKa集群(默认端口9092)通过逗号分隔 $KafKa_Lite = new KafKa_Lite("127.0.0.1,localhost"); // 设置一个Topic $KafKa_Lite->setTopic("test"); // 设置Consumer的Group分组(不使用自动offset的时候可以不设置) $KafKa_Lite->setGroup("test"); // 获取Consumer实例 $consumer = $KafKa_Lite->newConsumer(); // 获取一组消息参数分别为:Partition,maxsize最大返回条数,offset(可选)默认KAFKA_OFFSET_STORED $rs = $consumer->getMassage(0,100); //返回结果是一个数组,数组元素类型为Kafka_Message
例子2适合脚本队列任务
<?php /** * See-kafka Consumer例子1 * 889 毫秒 获取1w条 */ // 配置KafKa集群(默认端口9092)通过逗号分隔 $KafKa_Lite = new KafKa_Lite("127.0.0.1,localhost"); // 设置一个Topic $KafKa_Lite->setTopic("test"); // 设置Consumer的Group分组(不使用自动offset的时候可以不设置) $KafKa_Lite->setGroup("test"); // 此项设置决定 在使用一个新的group时 是从 最小的一个开始 还是从最大的一个开始 默认是最大的(或尾部) $KafKa_Lite->setTopicConf('auto.offset.reset', 'smallest'); // 此项配置决定在获取数据后回自动作为一家消费 成功 无需在 一定要 stop之后才会 提交 但是也是有限制的 // 时间越小提交的时间越快,时间越大提交的间隔也就越大 当获取一条数据之后就抛出异常时 更具获取之后的时间来计算是否算作处理完成 // 时间小于这个时间时抛出异常 则不会更新offset 如果大于这个时间则会直接更新offset 建议设置为 100~1000之间 $KafKa_Lite->setTopicConf('auto.commit.interval.ms', 1000); // 获取Consumer实例 $consumer = $KafKa_Lite->newConsumer(); // 开启Consumer获取,参数分别为partition(默认:0),offset(默认:KAFKA_OFFSET_STORED) $consumer->consumerStart(0); for ($i = 0; $i < 100; $i++) { // 当获取不到数据时会阻塞默认10秒可以通过$consumer->setTimeout()进行设置 // 阻塞后由数据能够获取会立即返回,超过10秒回返回null,正常返回格式为Kafka_Message $message = $consumer->consume(); } // 关闭Consumer(不关闭程序不会停止) $consumer->consumerStop();
See-kafka提供两种配置文件的配置,分别传入key和value,具体配置项已经作用参看如下地址:
https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md
配置文件说明:https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md
$KafKa_Lite->setTopicConf(); $KafKa_Lite->setKafkaConf();
在使用Consumer的Group(KAFKA OFFSET STORED)中需要注意以下配置项,否则你在使用一个新的group会从当前开始计算offset(根据场景):
// 此项设置决定 在使用一个新的group时 是从 最小的一个开始 还是从最大的一个开始 默认是最大的(或尾部) $KafKa_Lite->setTopicConf('auto.offset.reset', 'smallest');
Consumer获取之后是需要提交告诉KafKa获取成功并且更新offset,但是如果中途报错没有提交offset则下次还是会从头获取,此项配置设置一个自动提交时间,当失败后之前处理的也会吧offset提交到KafKa:
// 此项配置决定在获取数据后回自动作为一家消费 成功 无需在 一定要 stop之后才会 提交 但是也是有限制的 // 时间越小提交的时间越快,时间越大提交的间隔也就越大 当获取一条数据之后就抛出异常时 更具获取之后的时间来计算是否算作处理完成 // 时间小于这个时间时抛出异常 则不会更新offset 如果大于这个时间则会直接更新offset 建议设置为 100~1000之间 $KafKa_Lite->setTopicConf('auto.commit.interval.ms', 1000);
在初始化KafKa_Lite会对集群端口进行验证,如果无任何一个可用的则会抛出一个 No can use KafKa 异常,也可以主动触发ping操作检查集群是否有有可用机器
当获取Consumer异常了会抛出一个 KafKa Exception Base异常,异常有一个code号可参考,Exception/err.php文件,推荐使用try-catch进行处理
See- KafKa的宗旨是为了更加方便把KafKa和PHP相结合,并且能够方便的进行使用,如果大家感兴趣可以使用看看,有问题可以进行反馈,此拓展作者会长期维护下去!
