go-micro v4默認(rèn)使用mdns做服務(wù)發(fā)現(xiàn)。不過(guò)也支持采用其它的服務(wù)發(fā)現(xiàn)中間件踢代,因?yàn)槎嗄陙?lái)一直使用Consul做服務(wù)發(fā)現(xiàn)盲憎,為了方便和其它服務(wù)集成,所以還是選擇了Consul胳挎。這篇文章將介紹go-micro使用Consul做服務(wù)發(fā)現(xiàn)的方法饼疙。關(guān)于Consul的使用方式請(qǐng)參考我的另一篇文章:使用Consul做服務(wù)發(fā)現(xiàn)的若干姿勢(shì) 。
安裝Consul
如果你已經(jīng)安裝Consul慕爬,或者對(duì)Consul很熟悉了窑眯,按照自己的方式處理Consul就行了。
這里提供一個(gè)通過(guò)docker快速安裝Consul的方式澡罚,當(dāng)然前提是你得安裝了docker伸但。
執(zhí)行命令:
docker run --name consul1 -p 8500:8500 -p 8300:8300 -p 8301:8301 -p 8302:8302 -d consul:latest
這會(huì)在docker容器中啟動(dòng)一個(gè)最新版本的Consul服務(wù),并將相關(guān)端口開(kāi)放給主機(jī)留搔。
安裝Consul插件
使用Consul作為服務(wù)注冊(cè)和服務(wù)發(fā)現(xiàn)更胖,需要先安裝go-micro的consul插件:
go get github.com/go-micro/plugins/v4/registry/consul
服務(wù)端使用Consul
服務(wù)注冊(cè)
為了使用Consul做服務(wù)注冊(cè),需要為go-micro server顯式的指定Consul Registry隔显。直接看代碼吧:
func main() {
registry := consul.NewRegistry()
rpcServer := server.NewServer(
server.Name("registry-consul.service"),
server.Address("0.0.0.0:8001"),
server.Registry(registry),
)
proto.RegisterHelloHandler(rpcServer, &Hello{})
service := micro.NewService(
micro.Server(rpcServer),
)
service.Init()
// Run server
if err := service.Run(); err != nil {
log.Fatal(err)
}
}
通過(guò) consul.NewRegistry() 創(chuàng)建一個(gè)Consul 注冊(cè)中心却妨,然后使用 server.NewServer 創(chuàng)建Server的時(shí)候把它設(shè)置進(jìn)去;同時(shí)我們需要指定服務(wù)的名稱(chēng)括眠,這里設(shè)置的是 registry-consul.service彪标;另外這里不使用隨機(jī)端口,指定了一個(gè)服務(wù)的監(jiān)聽(tīng)地址掷豺。這樣基本就OK了捞烟。
這里并沒(méi)有指定Consul的連接地址,因?yàn)榘凑胀扑]的Consul部署方式当船,服務(wù)所在機(jī)器或者容器中應(yīng)該部署一個(gè)Consul的客戶(hù)端题画,程序可以直接通過(guò) 127.0.0.1:8500 訪問(wèn)到它。如果要顯示指定德频,可以在NewRegistry時(shí)設(shè)置:
registry := consul.NewRegistry(
registry.Addrs("127.0.0.1:8500"),
)
注冊(cè)過(guò)程
通過(guò)一張圖來(lái)看一下苍息,go-micro注冊(cè)服務(wù)到Consul時(shí)都做了什么。
服務(wù)注冊(cè)關(guān)鍵是實(shí)現(xiàn)兩個(gè)動(dòng)作:
1、注冊(cè): rpcServer啟動(dòng)的時(shí)候竞思,會(huì)調(diào)用到自身的Register方法表谊,Register方法會(huì)調(diào)用consul插件的Register方法,然后調(diào)用到consul自身SDK提供的Agent.ServiceRegister方法盖喷,將服務(wù)注冊(cè)到Consul中爆办。注冊(cè)的服務(wù)名稱(chēng)就是NewServer時(shí)的server.Name。
2传蹈、健康上報(bào): 即刷新TTL押逼,服務(wù)注冊(cè)成功后,會(huì)啟動(dòng)一個(gè)定時(shí)器定時(shí)調(diào)用consul插件的Register方法惦界,這個(gè)方法內(nèi)部判斷服務(wù)注冊(cè)過(guò)挑格,則會(huì)調(diào)用consul自身SDK提供的Agent.PassTTL方法,刷新Consul中對(duì)應(yīng)服務(wù)的TTL沾歪。
健康檢查
go-micro服務(wù)的健康狀態(tài)是通過(guò)TTL維護(hù)的漂彤,服務(wù)需要定時(shí)去刷新TTL,如果TTL超過(guò)指定的時(shí)間沒(méi)有被刷新灾搏,則服務(wù)會(huì)被認(rèn)為是不健康的挫望。默認(rèn)情況下有三個(gè)設(shè)置會(huì)涉及到TTL,還是先來(lái)看代碼:
registry := consul.NewRegistry()
regCheckFunc := func(ctx context.Context) error {
fmt.Println(time.Now().Format("2006-01-02 15:04:05") + " do register check")
if 1+1 == 2 {
return nil
}
return errors.New("this not earth")
}
rpcServer := server.NewServer(
server.Name("registry-consul.service"),
server.Address("0.0.0.0:8001"),
server.Registry(registry),
server.RegisterCheck(regCheckFunc),
server.RegisterInterval(10*time.Second),
server.RegisterTTL(20*time.Second),
)
proto.RegisterHelloHandler(rpcServer, &Hello{})
service := micro.NewService(
micro.Server(rpcServer),
)
//service.Init()
if err := service.Run(); err != nil {
log.Fatal(err)
}
關(guān)于這三個(gè)設(shè)置狂窑,這里簡(jiǎn)單介紹下:
**1媳板、server.RegisterCheck(regCheckFunc) ** 服務(wù)刷新TTL之前,會(huì)調(diào)用一個(gè)函數(shù)檢查服務(wù)的狀態(tài)泉哈,這個(gè)函數(shù)的返回值是error類(lèi)型蛉幸。默認(rèn)的函數(shù)不進(jìn)行任何檢查,直接返回nil丛晦,代表服務(wù)狀態(tài)正常奕纫;我們可以自己寫(xiě)一個(gè)函數(shù),進(jìn)行一些檢查邏輯烫沙,比如是否要下線維護(hù)匹层。如果返回的error不是nil,go-micro會(huì)嘗試在Consul中注銷(xiāo)服務(wù)锌蓄,則調(diào)用方將不會(huì)再訪問(wèn)到這個(gè)服務(wù)節(jié)點(diǎn)升筏。
2、server.RegisterInterval(10*time.Second) 這個(gè)設(shè)置指定程序去刷新TLL的頻率瘸爽。
3仰冠、server.RegisterTTL(20*time.Second) 這個(gè)設(shè)置指定TTL的生存周期,如果超過(guò)這個(gè)時(shí)間沒(méi)有刷新TTL蝶糯,則Consul會(huì)認(rèn)為服務(wù)是不健康。
另外需要注意不要使用service.Init()辆沦,因?yàn)檫@里邊會(huì)覆蓋 RegisterInterval 和 RegisterTTL 的設(shè)置昼捍,除非你不關(guān)心這兩個(gè)參數(shù)识虚。關(guān)于這個(gè)問(wèn)題可以參考:https://github.com/asim/go-micro/issues/2488
客戶(hù)端使用Consul
調(diào)用服務(wù)
為了使用Consul做服務(wù)發(fā)現(xiàn),需要為go-micro service顯式的指定Consul Registry妒茬。還是直接看代碼:
registry := consul.NewRegistry()
service := micro.NewService(
micro.Client(client.NewClient()),
micro.Registry(registry),
)
service.Init()
client := proto.NewHelloService("registry-consul.service", service.Client())
rsp, err := client.Say(context.TODO(), &proto.SayRequest{Name: "BOSSMA"})
if err != nil {
fmt.Println(err)
}
fmt.Println(rsp)
代碼很簡(jiǎn)單担锤,指定consul作為服務(wù)發(fā)現(xiàn)組件后,調(diào)用服務(wù)的時(shí)候傳遞的服務(wù)名稱(chēng)就會(huì)使用consul進(jìn)行解析乍钻,獲取到IP肛循、端口后,再進(jìn)行實(shí)際調(diào)用银择。
發(fā)現(xiàn)過(guò)程
還是先來(lái)看張圖多糠,從調(diào)用 XXXService 的方法 YYY 開(kāi)始:
整個(gè)過(guò)程分為兩個(gè)大的步驟,第一步獲取要調(diào)用服務(wù)的地址浩考,第二步通過(guò)http請(qǐng)求調(diào)用服務(wù)夹孔。我們重點(diǎn)看第一步通過(guò)Consul獲取服務(wù)這塊。
首先進(jìn)入一個(gè)Selector析孽,就是選擇器的意思搭伤。Selector首先看緩存中有沒(méi)有緩存請(qǐng)求服務(wù)的地址信息,如果沒(méi)有就去Consul查詢(xún)袜瞬,查詢(xún)到之后再通過(guò)指定的選擇策略選出來(lái)一個(gè)地址怜俐,用于后續(xù)http請(qǐng)求。這里默認(rèn)的選擇策略是隨機(jī)選擇邓尤,比如查詢(xún)到這個(gè)服務(wù)有三個(gè)部署節(jié)點(diǎn)拍鲤,隨機(jī)策略會(huì)隨機(jī)返回其中某一個(gè)地址。
除了隨機(jī)策略裁赠,go-micro還提供了一個(gè)輪詢(xún)策略殿漠,這時(shí)候需要自己創(chuàng)建一個(gè)Selector:
registry := consul.NewRegistry()
selector := selector.NewSelector(
selector.SetStrategy(selector.RoundRobin),
selector.Registry(registry),
)
service := micro.NewService(
micro.Client(client.NewClient()),
micro.Selector(selector),
//micro.Registry(registry),
)
另外從上面的示意圖中,我們可以看到Selector調(diào)用了Registry佩捞,所以這里創(chuàng)建Selector的時(shí)候绞幌,我們把Registry設(shè)置了進(jìn)去,然后再把創(chuàng)建的Selector設(shè)置到Service中一忱。其實(shí)還有另一種方式莲蜘,把設(shè)置Registry放到設(shè)置Selector后邊,同樣可以把Registry注冊(cè)到Selector中帘营,但是這樣比較隱晦票渠,還需要注意設(shè)置順序,我不推薦芬迄。不過(guò)如果在Selector之外需要使用Registry的時(shí)候问顷,還是需要使用micro.Registry(registry)進(jìn)行注冊(cè),這個(gè)例子中并沒(méi)有相關(guān)場(chǎng)景。
效果展示
先啟動(dòng)服務(wù)端杜窄,然后啟動(dòng)客戶(hù)端肠骆,截圖如下:
以上就是本文的主要內(nèi)容,如有錯(cuò)漏歡迎反饋塞耕。
演示代碼已上傳到Github:https://github.com/bosima/go-demo/tree/main/go-micro-registry-consul
收獲更多架構(gòu)知識(shí)蚀腿,請(qǐng)關(guān)注公眾號(hào) 螢火架構(gòu)。原創(chuàng)內(nèi)容扫外,轉(zhuǎn)載請(qǐng)注明出處莉钙。