go-micro集成RabbitMQ實戰(zhàn)和原理詳解
在go-micro中異步消息的收發(fā)是通過Broker這個組件來完成的,底層實現(xiàn)有RabbitMQ、Kafka、Redis等等很多種方式,這篇文章主要介紹go-micro使用RabbitMQ收發(fā)數(shù)據(jù)的方法和原理。
Broker的核心功能
Broker的核心功能是Publish和Subscribe,也就是發(fā)布和訂閱。它們的定義是:
Publish(topic string, m *Message, opts ...PublishOption) error Subscribe(topic string, h Handler, opts ...SubscribeOption) (Subscriber, error)
發(fā)布
發(fā)布第一個參數(shù)是topic(主題),用于標識某類消息。
發(fā)布的數(shù)據(jù)是通過Message承載的,其包括消息頭和消息體,定義如下:
type Message struct {
Header map[string]string
Body []byte
}
消息頭是map,也就是一組KV(鍵值對)。
消息體是字節(jié)數(shù)組,在發(fā)送和接收時需要開發(fā)者進行編碼和解碼的處理。
訂閱
訂閱的第一個參數(shù)也是topic(主題),用于過濾出要接收的消息。
訂閱的數(shù)據(jù)是通過Handler處理的,Handler是一個函數(shù),其定義如下:
type Handler func(Event) error
其中的參數(shù)Event是一個接口,需要具體的Broker來實現(xiàn),其定義如下:
type Event interface {
Topic() string
Message() *Message
Ack() error
Error() error
}
- Topic() 用于獲取當前消息的topic,也是發(fā)布者發(fā)送時的topic。
- Message() 用于獲取消息體,也是發(fā)布者發(fā)送時的Message,其中包括Header和Body。
- Ack() 用于通知Broker消息已經(jīng)收到了,Broker可以刪除消息了,可用來保證消息至少被消費一次。
- Error() 用于獲取Broker處理消息過成功的錯誤。
開發(fā)者訂閱數(shù)據(jù)時,需要實現(xiàn)Handler這個函數(shù),接收Event的實例,提取數(shù)據(jù)進行處理,根據(jù)不同的Broker,可能還需要調(diào)用Ack(),處理出現(xiàn)錯誤時,返回error。
go-micro集成RabbitMQ實戰(zhàn)
大概了解了Broker的定義之后,再來看下如何使用go-micro收發(fā)RabbitMQ消息。
啟動一個RabbitMQ
如果你已經(jīng)有一個RabbitMQ服務器,請?zhí)^這個步驟。
這里介紹一個使用docker快速啟動RabbitMQ的方法,當然前提是你得安裝了docker。
執(zhí)行如下命令啟動一個rabbitmq的docker容器:
docker run --name rabbitmq1 -p 5672:5672 -p 15672:15672 -d rabbitmq
然后進入容器進行一些設置:
docker exec -it rabbitmq1 /bin/bash
啟動管理工具、禁用指標采集(會導致某些API500錯誤):
rabbitmq-plugins enable rabbitmq_management cd /etc/rabbitmq/conf.d/ echo management_agent.disable_metrics_collector = false > management_agent.disable_metrics_collector.conf
最后重啟容器:
docker restart rabbitmq1
最后瀏覽器中輸入 http://127.0.0.0:15672 即可訪問,默認用戶名和密碼都是 guest 。
編寫收發(fā)函數(shù)
為了方便演示,先來定義發(fā)布消息和接收消息的函數(shù)。其中發(fā)布函數(shù)使用了go-micro提供的Event類型,還有其它類型也可以提供Publish的功能,這里發(fā)送的數(shù)據(jù)格式是Json字符串。接收消息的函數(shù)名稱可以隨意取,但是參數(shù)和返回值必須符合規(guī)范,也就是下邊代碼中的樣子,這個函數(shù)也可以是綁定到某個類型的。
// 定義一個發(fā)布消息的函數(shù):每隔1秒發(fā)布一條消息
func loopPublish(event micro.Event) {
for {
time.Sleep(time.Duration(1) * time.Second)
curUnix := strconv.FormatInt(time.Now().Unix(), 10)
msg := "{\"Id\":" + curUnix + ",\"Name\":\"張三\"}"
event.Publish(context.TODO(), msg)
}
}
// 定義一個接收消息的函數(shù):將收到的消息打印出來
func handle(ctx context.Context, msg interface{}) (err error) {
defer func() {
if r := recover(); r != nil {
err = errors.New(fmt.Sprint(r))
log.Println(err)
}
}()
b, err := json.Marshal(msg)
if err != nil {
log.Println(err)
return
}
log.Println(string(b))
return
}
編寫主體代碼
這里先給出代碼,里面提供了一些注釋,后邊還會有詳細介紹。
func main() {
// RabbitMQ的連接參數(shù)
rabbitmqUrl := "amqp://guest:guest@127.0.0.1:5672/"
exchangeName := "amq.topic"
subcribeTopic := "test"
queueName := "rabbitmqdemo_test"
// 默認是application/protobuf,這里演示用的是Json,所以要改下
server.DefaultContentType = "application/json"
// 創(chuàng)建 RabbitMQ Broker
b := rabbitmq.NewBroker(
broker.Addrs(rabbitmqUrl), // RabbitMQ訪問地址,含VHost
rabbitmq.ExchangeName(exchangeName), // 交換機的名稱
rabbitmq.DurableExchange(), // 消息在Exchange中時會進行持久化處理
rabbitmq.PrefetchCount(1), // 同時消費的最大消息數(shù)量
)
// 創(chuàng)建Service,內(nèi)部會初始化一些東西,必須在NewSubscribeOptions前邊
service := micro.NewService(
micro.Broker(b),
)
service.Init()
// 初始化訂閱上下文:這里不是必需的,訂閱會有默認值
subOpts := broker.NewSubscribeOptions(
rabbitmq.DurableQueue(), // 隊列持久化,消費者斷開連接后,消息仍然保存到隊列中
rabbitmq.RequeueOnError(), // 消息處理函數(shù)返回error時,消息再次入隊列
rabbitmq.AckOnSuccess(), // 消息處理函數(shù)沒有error返回時,go-micro發(fā)送Ack給RabbitMQ
)
// 注冊訂閱
micro.RegisterSubscriber(
subcribeTopic, // 訂閱的Topic
service.Server(), // 注冊到的rpcServer
handle, // 消息處理函數(shù)
server.SubscriberContext(subOpts.Context), // 訂閱上下文,也可以使用默認的
server.SubscriberQueue(queueName), // 隊列名稱
)
// 發(fā)布事件消息
event := micro.NewEvent(subcribeTopic, service.Client())
go loopPublish(event)
log.Println("Service is running ...")
if err := service.Run(); err != nil {
log.Println(err)
}
}
主要邏輯是:
1、先創(chuàng)建一個RabbitMQ Broker,它實現(xiàn)了標準的Broker接口。其中主要的參數(shù)是RabbitMQ的訪問地址和RabbitMQ交換機,PrefetchCount是訂閱者(或稱為消費者)使用的。
2、然后通過 NewService 創(chuàng)建go-micro服務,并將broker設置進去。這里邊會初始化很多東西,最核心的是創(chuàng)建一個rpcServer,并將rpcServer和這個broker綁定起來。
3、然后是通過 RegisterSubscriber 注冊訂閱,這個注冊有兩個層面的功能:一是如果RabbitMQ上還不存在這個隊列時創(chuàng)建隊列,并訂閱指定topic的消息;二是定義go-micro程序從這個RabbitMQ隊列接收數(shù)據(jù)的處理方式。
這里詳細看下訂閱的參數(shù):
func RegisterSubscriber(topic string, s server.Server, h interface{}, opts ...server.SubscriberOption) error
- topic:go-micro使用的是Topic模式,發(fā)布者發(fā)送消息的時候要指定一個topic,訂閱者根據(jù)需要只接收某個或某幾個topic的消息;
- s:消息從RabbitMQ接收后會進入這個Server進行處理,它是NewService的時候內(nèi)部創(chuàng)建的;
- h:使用了上一步創(chuàng)建的接收消息的函數(shù) handle,Server中的方法會調(diào)用這個函數(shù);
- opts 是訂閱的一些選項,這里需要指定RabbitMQ隊列的名稱;另外SubscriberContext定義了訂閱的一些行為,這里DurableQueue設置RabbitMQ訂閱消息的持久化方式,一般我們都希望消息不丟失,這個設置的作用是即使程序與RabbitMQ的連接斷開,消息也會保存在RabbitMQ隊列中;AckOnSuccess和RequeueOnError定義了程序處理消息出現(xiàn)錯誤時的行為,如果handle返回error,消息會重新返回RabbitMQ,然后再投遞給程序。
4、然后這里為了演示,通過NewEvent創(chuàng)建了一個Event,通過它每隔一秒發(fā)送1條消息。
5、最后通過service.Run()把這個程序啟動起來。
辛苦寫了半天,看一下這個程序的運行效果:

注意一般發(fā)布者和訂閱者是在不同的程序中,這里只是為了方便演示,才把他們放在一個程序中。所以如果只是發(fā)布消息,就不需要訂閱的代碼,如果只是訂閱,也不需要發(fā)布消息的代碼,大家使用的時候根據(jù)需要自己裁剪吧。
go-micro集成RabbitMQ的處理流程
這個部分來看一下消息在go-micro和RabbitMQ中是怎么流轉(zhuǎn)的,我畫了一個示意圖:

這個圖有點復雜,這里詳細講解下。
首先分成三塊:RabbitMQ、消息發(fā)布部分、消息接收部分,這里用不同的顏色進行了區(qū)分。
- RabbitMQ不是本文的重點,就把它看成一個整體就行了。
- 消息發(fā)布部分:從生產(chǎn)者程序調(diào)用Event.Publish開始,然后調(diào)用Client.Publish,到這里為止,都是在go-micro的核心模塊中進行處理;然后再調(diào)用Broker.Publish,這里的Broker是RabbitMQ插件的Broker實例,從這里開始進入了RabbiitMQ插件部分,然后再依次通過RabbitMQ Connection的Publish方法、RabbitMQ Channle的Publish方法,最終發(fā)送到RabbitMQ中。
- 消息接收部分:Service.Run內(nèi)部會調(diào)用rpcServer.Start,這個方法內(nèi)部會調(diào)用Broker.Subscribe,這個方法是RabbitMQ插件中定義的,它會讀取RegisterSubscriber時的一些RabbitMQ隊列設置,然后再依次傳遞到RabbitMQ Connection的Consume方法、RabbitMQ Channel的ConsumeQueue方法,最終連接到RabbitMQ,并在RabbitMQ上設置好要訂閱的隊列;這些方法還會返回一個類型為amqp.Delivery的Go Channel,Broker.Subscribe不斷的從這個Go Channel中讀取數(shù)據(jù),然后再發(fā)送到調(diào)用Broker.Subscribe時傳入的一個消息處理方法中,這里就是rpcServer.HandleEvnet,消息經(jīng)過一些處理后再進入rpcServer內(nèi)部的路由處理模塊,這里就是route.ProcessMessage,這個方法內(nèi)部會根據(jù)當前消息的topic查找RegisterSubscriber時注冊的訂閱,并最終調(diào)用到當時注冊的用于接收消息的函數(shù)。
這個處理過程還可以劃分為業(yè)務部分、核心模塊部分和插件部分。
- 首先創(chuàng)建一個插件的Broker實現(xiàn),把它注冊到核心模塊的rpcServer中;
- 消息的發(fā)送從業(yè)務部分進入核心模塊部分,再進入具體實現(xiàn)Broker的插件部分;
- 消息的接收則首先進入插件部分,然后再流轉(zhuǎn)到核心模塊部分,再流轉(zhuǎn)到業(yè)務部分。
從上邊的圖中可以看到消息都需要經(jīng)過這個RabbitMQ插件進行處理,實際上可以只使用這個插件,就能實現(xiàn)消息的發(fā)送和接收。這個演示代碼我已經(jīng)提交到了Github,有興趣的同學可以在文末獲取Github倉庫的地址。
從上邊這些劃分中,我們可以理解到設計者的整體設計思路,把握關鍵節(jié)點,用好用對,出現(xiàn)問題時可以快速定位。
填的幾個坑
不能接收其它框架發(fā)布的消息
這個是因為route.ProcessMessage查找訂閱時使用了go-micro專用的一個頭信息:
// get the subscribers by topic subs, ok := router.subscribers[msg.Topic()]
這個msg.Topic返回的是如下實例中的topic字段:
rpcMsg := &rpcMessage{
topic: msg.Header["Micro-Topic"],
contentType: ct,
payload: &raw.Frame{Data: msg.Body},
codec: cf,
header: msg.Header,
body: msg.Body,
}
其它框架不會有這么一個頭信息,除非專門適配go-micro。
因為使用RabbitMQ的場景下,整個開發(fā)都是圍繞RabbitMQ做的,而且go-micro的處理邏輯沒有考慮RabbitMQ訂閱可以使用通配符的情況,發(fā)布消息的Topic、接收消息的Topic與Micro-Topic的值匹配時都是按照是否相等的原則處理的,因此可以用RabbitMQ消息自帶的topic來設置這個消息頭。rabbitmq.rbroker.Subscribe 中接收到消息后,就可以進行這個設置:
// Messages sent from other frameworks to rabbitmq do not have this header.
// The 'RoutingKey' in the message can be used as this header.
// Then the message can be transfered to the subscriber which bind this topic.
msgTopic := header["Micro-Topic"]
if msgTopic == "" {
header["Micro-Topic"] = msg.RoutingKey
}
這樣go-micro開發(fā)的消費者程序就能接收其它框架發(fā)布的消息了,其它框架無需適配。
RabbitMQ重啟后訂閱者和發(fā)布者無限阻塞
go-micro的RabbitMQ插件底層使用另一個庫:github.com/streadway/amqp
對于發(fā)布者,RabbitMQ斷開連接時amqp庫會通過Go Channel同步通知go-micro,然后go-micro可以發(fā)起重新連接。問題出現(xiàn)在這個同步通知上,go-micro的RabbitMQ插件設置了接收連接和通道的關閉通知,但是只處理了一個通知就去重新連接了,這就導致有一個Go Channel一直阻塞,而這個阻塞會導致某個鎖不能釋放,這個鎖又是Publish時候需要的,因此導致發(fā)布者無限阻塞。解決辦法就是外層增加一個循環(huán),等所有的通知都收到了,再去做重新連接。
對于訂閱者,RabbitMQ斷開連接時,它會一直阻塞在某個Go Channel上,直到它返回一個值,這個值代表連接已經(jīng)重新建立,訂閱者可以重建消費通道。問題也是出現(xiàn)在這個阻塞的Go Channel上,因為這個Go Channel在每次收到amqp的關閉通知時會重新賦值,而訂閱者等待的Go Channel可能是之前的舊值,永遠也不會返回,訂閱者也就無限阻塞了。解決辦法呢,就是在select時增加一個time.After,讓等待的Go Channel有機會更新到新值。
代碼就不貼了,有興趣的可以到Github中去看:https://github.com/go-micro/plugins/commit/9f64710807221f3cc649ba4fe05f75b07c66c00c
關于這兩個問題的修改已經(jīng)合并到官方倉庫中,大家去get最新的代碼就可以了。
這兩個坑填了,基本上就能滿足我的需要了。當然可能還有其它的坑,比如go-micro的RabbitMQ插件好像沒有發(fā)布者確認的功能,這個要實現(xiàn),還得好好想想怎么改。
好了,以上就是本文的主要內(nèi)容。
老規(guī)矩,代碼已經(jīng)上傳到Github,歡迎訪問:https://github.com/bosima/go-demo/tree/main/go-micro-broker-rabbitmq
到此這篇關于go-micro集成RabbitMQ實戰(zhàn)和原理詳解的文章就介紹到這了,更多相關go-micro集成RabbitMQ內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
基于Go語言實現(xiàn)高性能文件上傳下載系統(tǒng)
在Web應用開發(fā)中,文件上傳下載是一個非常常見的需求,本文將介紹如何使用Go語言實現(xiàn)一個安全、高效的本地文件存儲系統(tǒng),感興趣的小伙伴可以了解下2025-03-03
go mod 安裝依賴 unkown revision問題的解決方案
這篇文章主要介紹了go mod 安裝依賴 unkown revision問題的解決方案,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2021-05-05
intelliJ?idea安裝go開發(fā)環(huán)境并搭建go項目(打包)全過程
最近在配置idea開發(fā)go語言時碰到很多問題,所以這里給大家總結下,這篇文章主要給大家介紹了關于intelliJ?idea安裝go開發(fā)環(huán)境并搭建go項目(打包)的相關資料,需要的朋友可以參考下2023-10-10
golang(gin)的全局統(tǒng)一異常處理方式,并統(tǒng)一返回json
這篇文章主要介紹了golang(gin)的全局統(tǒng)一異常處理方式,并統(tǒng)一返回json,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-01-01

