# phpkafka

**Repository Path**: longzhiyan/phpkafka

## Basic Information

- **Project Name**: phpkafka
- **Description**: PHP Kafka 客户端，支持 PHP-FPM、Swoole 环境使用。
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 102
- **Forks**: 19
- **Created**: 2020-11-09
- **Last Updated**: 2024-12-13

## Categories & Tags

**Categories**: message-server

**Tags**: None

## README

# longlang/phpkafka

[![Latest Version](https://poser.pugx.org/longlang/phpkafka/v/stable)](https://packagist.org/packages/longlang/phpkafka)
[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg)](https://secure.php.net/)
[![License](https://img.shields.io/github/license/longyan/phpkafka.svg)](https://github.com/longyan/phpkafka/blob/master/LICENSE)

## 简介

[English](README.md) | 简体中文

PHP Kafka 客户端，支持 PHP-FPM、Swoole 环境使用。

通讯协议的结构基于 Java 版本中的 JSON 文件生成，这可能是有史以来支持消息类型最多的 PHP Kafka 客户端，支持全部 50 个 API。

> 目前已实现消息的生成及消费，本组件仍处于开发及测试阶段。

## 功能特性

- [x] 支持全部 50 个 API
- [x] 消息压缩支持 (gzip、snappy、lz4、zstd)
- [x] PHP-FPM、Swoole 智能环境识别兼容
- [x] 生产者类
- [x] 消费者类
- [ ] SSL 加密通信
- [ ] SASL 鉴权
- [ ] 更多功能的封装及测试用例编写

## 环境要求

- PHP >= 7.1
- Kafka >= 1.0.0
- Swoole >= 4.5 (可选)

## 安装

`composer require longlang/phpkafka`

## 文档及示例

- [生产者](doc/producer.md)

- [消费者](doc/consumer.md)

示例代码请参考 `examples` 目录