@fastify/kafka

中文文档
4.0.1发布于 2026/10/08MITTypeScriptCommonJS构建来源已验证近 30 天下载 3836

快速化插件与 Apache Kafka 交互 .

中文使用文档
文档目录10 节
  1. 安装
  2. 兼容性
  3. 使用量
  4. 从 node-rdkafka
  5. API 密码
  6. 插件选项
  7. 制作人
  8. 消费者
  9. 承认
  10. 许可证

@ fastify/kafka (法语)

CI NPM version neostandard javascript style

快速化插件以互动 阿帕奇·卡夫卡支持卡夫卡生产商和消费者. 为了实现最佳性能,插件使用 @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 政策 更多细节.

使用量

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()
})

更多如何使用此插件的例子, 您可以查看 示例目录。 。 。 .

从 node-rdkafka

从版本开始 3.x,此插件使用 @platformatic/kafka 改为 node-rdkafka。 。 。 .

配置选项的主要差异是:

node-rdkafka (旧)@platformatic/kafka (新设)
metadata.broker.listbootstrapBrokers: ['host:port']
group.idgroupId
fetch.wait.max.msmaxWaitTime
enable.auto.commitautocommit
auto.offset.reset通过 consumerTopicConf
dr_cb无需

API 密码

这个模块暴露出以下API:

插件选项

{
  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) - 向一个专题发送信息
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) - 听取关于特定主题的信息
// 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()))
})

承认

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

过去提案国:

  • 莱兹

许可证

许可证根据 麻省理工学院。 。 。 .

版本与发布记录

@fastify/kafka 共发布 12 个版本,首次发布于 2022/04/27;过去 12 个月发布了 2 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.0.1latest2026/10/081 个月前
4.0.02026/07/024 个月前
3.0.22025/01/061.9 年前
3.0.12024/11/022 年前
3.0.0next2024/09/072 年前
3.0.0-pre.fv5.22024/08/082 年前

关于 @fastify/kafka 的常见问题

@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 和提交记录判断。