Golang 語言中 kafka 客戶端庫 Sarama
01、介紹
Apache Kafka 是一款開源的消息引擎系統。它在項目中的作用主要是削峰填谷和解耦。本文我們只介紹 Apache Kafka 的 Golang 客戶端庫 Sarama。Sarama 是 MIT 許可的 Apache Kafka 0.8 及更高版本的 Golang 客戶端庫。
如果讀者朋友對 Apache Kafka 服務端還不了解,建議先閱讀官方文檔中的入門部分,本文使用的版本是 Apache Kafka 2.8。
02、生產者
我們可以使用 Sarama 庫的 AsyncProducer 或 SyncProducer 生產消息。在大多數情況下首選使用 AsyncProducer 生產消息。它通過一個 channel 接收消息,并在后臺盡可能高效的異步生產消息。
SyncProducer 發送 Kafka 消息后阻塞,直到接收到 ACK 確認。SyncProducer 有兩個警告:它通常效率較低,并且實際的耐用性保證取決于 Producer.RequiredAcks 的配置值。在某些配置中,有時仍會丟失由 SyncProducer 確認的消息,但是使用比較簡單。
為了讀者朋友們容易理解,本文我們介紹 SyncProducer 作為生產者的使用方式。如果讀者朋友想了解 AsyncProducer 作為生產者的使用方式,請參考官方文檔。
使用 SyncProducer 作為生產者的示例代碼:
- func sendMessage (brokerAddr []string, config *sarama.Config, topic string, value sarama.Encoder) {
- producer, err := sarama.NewSyncProducer(brokerAddr, config)
- if err != nil {
- fmt.Println(err)
- return
- }
- defer func() {
- if err = producer.Close(); err != nil {
- fmt.Println(err)
- return
- }
- }()
- msg := &sarama.ProducerMessage{
- Topic: topic,
- Value: value,
- }
- partition, offset, err := producer.SendMessage(msg)
- if err != nil {
- fmt.Println(err)
- return
- }
- fmt.Printf("partition:%d offset:%d\n", partition, offset)
- }
閱讀上面這段代碼,我們調用 NewSyncProducer() 創建一個新的 SyncProducer,給定 broker 地址和配置信息。調用 SendMessage() 生產給定的消息,并且僅在生產成功或失敗時返回。它將返回分區(Partition)和生產的消息的偏移量(Offset),如果消息生產失敗,則返回錯誤。
需要注意的是,為了避免泄露,必須在生產者上調用 Close(),因為當它超出范圍時,可能不會自動垃圾回收。
03、消費者
我們可以使用 Sarama 庫的消費者 Consumer 或消費者組 ConsumerGroup API 消費消息。為了讀者朋友們容易理解,本文我們介紹使用 Consumer 消費消息。
Consumer 管理 PartitionConsumers,該 PartitionConsumers 處理來自 brokers 的 Kafka 消息。
Consumer 消費消息的示例代碼:
- func consumer (brokenAddr []string, topic string, partition int32, offset int64) {
- consumer, err := sarama.NewConsumer(brokenAddr, nil)
- if err != nil {
- fmt.Println(err)
- return
- }
- defer func() {
- if err = consumer.Close(); err != nil {
- fmt.Println(err)
- return
- }
- }()
- partitionConsumer, err := consumer.ConsumePartition(topic, partition, offset)
- if err != nil {
- fmt.Println(err)
- return
- }
- defer func() {
- if err = partitionConsumer.Close(); err != nil {
- fmt.Println(err)
- return
- }
- }()
- for msg := range partitionConsumer.Messages() {
- fmt.Printf("partition:%d offset:%d key:%s val:%s\n", msg.Partition, msg.Offset, msg.Key, msg.Value)
- }
- }
閱讀上面這段代碼,我們調用 NewConsumer() 創建一個新的 consumer,給定 broker 地址和配置信息。調用 ConsumePartition() 創建 PartitionConsumer,給定 topic、partition 和 offset。PartitionConsumer 處理來自給定 topic 和 partition 的 Kafka 消息。
需要注意的是,為了防止泄露,必須調用 consumer 和 partitionConsumer 的 Close(),因為當它超出范圍時,可能不會自動垃圾回收。
04、總結
本文主要介紹如何使用 Apache Kafka 的 Golang 語言客戶端庫 Sarama 生產和消費 Kafka 消息。關于生產者和消費者,分別列舉了一個簡單示例。除此之外,Sarama 庫還提供了很多其它 Api,感興趣的讀者朋友可以閱讀官方文檔了解更多。