# @fastify/kafka 中文文档

规范地址：https://npmcn.com/package/%40fastify/kafka/

版本：4\.0\.1
npm 元数据更新时间：2026-10-18T12:30:34.886Z
中文译文更新时间：2026-11-14T11:29:27.342Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fastify/kafka
原文对照：https://npmcn.com/package/%40fastify/kafka/?lang=original
项目主页：https://github.com/fastify/fastify-kafka#readme
源码仓库：https://github.com/fastify/fastify-kafka

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：39.3 kB，19 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2022-04-27T13:58:22.979Z
- 最新版本发布：2026-10-08T13:17:41.078Z
- 近 30 天下载量：3836（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 2 个）

## 中文简介

快速化插件与 Apache Kafka 交互 .

## 安装

```sh
npm install @fastify/kafka
```

也可以使用：`pnpm add @fastify/kafka`、`yarn add @fastify/kafka`、`bun add @fastify/kafka`

## README

# @ fastify/kafka (法语)

[![CI](https://github.com/fastify/fastify-kafka/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/fastify-kafka/actions/workflows/ci.yml) [![NPM version](https://img.shields.io/npm/v/@fastify/kafka.svg?style=flat)](https://www.npmjs.com/package/@fastify/kafka) [![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)

快速化插件以互动 [阿帕奇·卡夫卡](https://kafka.apache.org/)支持卡夫卡生产商和消费者. 为了实现最佳性能,插件使用 [`@platformatic/kafka`](https://github.com/platformatic/kafka)。 。 。 .

## 安装

```
npm i @fastify/kafka
```

## 兼容性

| 插件版本 | 快速化版本 |
| --- | --- |
| `>=3.x` | `^5.x` |
| `>=0.x <3.x` | `^4.x` |
| `>=0.x <3.x` | `^3.x` |
| `>=0.x <3.x` | `^2.x` |
| `>=0.x <3.x` | `^1.x` |

请注意,如果一个快取版本没有支持,那么该插件的相应版本也一样 上表列出. 见 [快速化 LTS 政策](https://github.com/fastify/fastify/blob/main/docs/Reference/LTS.md) 更多细节.

## 使用量

```js
const crypto = require('node:crypto')
const fastify = require('fastify')()
const group = crypto.randomBytes(20).toString('hex')

fastify
  .register(require('@fastify/kafka'), {
    producer: {
      bootstrapBrokers: ['127.0.0.1:9092'],
      clientId: 'my-producer',
      allowAutoTopicCreation: true
    },
    consumer: {
      bootstrapBrokers: ['127.0.0.1:9092'],
      groupId: group,
      clientId: 'my-consumer',
      allowAutoTopicCreation: true
    }
  })

fastify.post('/data', (req, reply) => {
  fastify.kafka.push({
    topic: 'updates',
    payload: req.body,
    key: 'dataKey'
  })
  reply.send({ ok: true })
})

fastify.kafka.subscribe('updates')
fastify.kafka.on('updates', (msg, commit) => {
  console.log(msg.value.toString())
  commit()
})

fastify.listen({ port: 3000 }, err => {
  if (err) throw err
  console.log(`Server listening on ${fastify.server.address().port}`)
  fastify.kafka.consume()
})
```

更多如何使用此插件的例子, 您可以查看 [示例目录](https://npmcn.com/package/%40fastify/kafka/examples)。 。 。 .

## 从 `node-rdkafka`

从版本开始 `3.x`,此插件使用 [`@platformatic/kafka`](https://github.com/platformatic/kafka) 改为 `node-rdkafka`。 。 。 .

配置选项的主要差异是:

| `node-rdkafka` (旧) | `@platformatic/kafka` (新设) |
| --- | --- |
| `metadata.broker.list` | `bootstrapBrokers: ['host:port']` |
| `group.id` | `groupId` |
| `fetch.wait.max.ms` | `maxWaitTime` |
| `enable.auto.commit` | `autocommit` |
| `auto.offset.reset` | 通过 `consumerTopicConf` |
| `dr_cb` | 无需 |

## API 密码

这个模块暴露出以下API:

### 插件选项

```ts
{
  producer?: Record<string, unknown>   // @platformatic/kafka Producer options
  consumer?: Record<string, unknown>   // @platformatic/kafka Consumer options
  producerTopicConf?: Record<string, unknown>
  consumerTopicConf?: Record<string, unknown>
  metadataOptions?: Record<string, unknown>
}
```

### 制作人

-   `fastify.kafka.producer` - 生产者实例
-   `fastify.kafka.push(message)` - 向一个专题发送信息

```js
fastify.kafka.push({
  topic: 'my-topic',   // required
  payload: 'hello',    // required - string or Buffer
  key: 'myKey',        // optional
  partition: 0         // optional
})
```

### 消费者

-   `fastify.kafka.consumer` - 消费者案例
-   `fastify.kafka.subscribe(topic | topic[])` ——订阅一个或多个课题
-   `fastify.kafka.consume()` ——开始流出消息(流程模式)
-   `fastify.kafka.consume(n, callback)` - 获取准确的 `n` 信件( 批量模式)
-   `fastify.kafka.on(topic, handler)` - 听取关于特定主题的信息

```js
// Flow mode
fastify.kafka.subscribe(['topic-a', 'topic-b'])
fastify.kafka.on('topic-a', (msg, commit) => {
  console.log(msg.value.toString())
  commit() // manually commit the offset
})
fastify.kafka.consume()

// Batch mode
fastify.kafka.subscribe('topic-a')
fastify.kafka.consume(10, (err, messages) => {
  if (err) throw err
  messages.forEach(msg => console.log(msg.value.toString()))
})
```

## 承认

这个项目由下列各方慷慨赞助:

-   [台词](https://platformatic.dev/)

过去提案国:

-   莱兹

## 许可证

许可证根据 [麻省理工学院](https://npmcn.com/package/%40fastify/kafka/LICENSE)。 。 。 .

## 常见问题

### @fastify/kafka 是什么？

快速化插件与 Apache Kafka 交互 \.

### 如何安装 @fastify/kafka？

在项目目录运行 npm install @fastify/kafka，或使用 pnpm add / yarn add / bun add。

### @fastify/kafka 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @fastify/kafka 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @fastify/kafka 可以商用吗？

@fastify/kafka 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fastify/kafka 的下载量有多少？

根据 npm 官方下载统计，@fastify/kafka 在 2026/10/15 – 2026/11/13 这 30 天内被下载 3,836 次，日均约 128 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fastify/kafka 还在维护吗？

最新版本 4\.0\.1 发布于 2026/10/08（1 个月前）；至今共发布 12 个版本，其中过去 12 个月发布了 2 个；首次发布于 2022/04/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。