基于知名微服務(wù)框架go-micro開發(fā)gRPC應(yīng)用程序

go-micro是golang的一個微服務(wù)框架伏蚊。

go-micro各個版本之間的兼容性問題一直被詬病拦盹,前幾年go-micro更是分化出了兩個分支:

一個延續(xù)了go-micro,只不過轉(zhuǎn)到了其公司CEO的個人Github倉庫中舍哄,訪問地址:

asim/go-micro: A Go microservices framework (github.com)

一個轉(zhuǎn)向了云原生方向宴凉,名字叫Micro,訪問地址:

micro/micro: API first cloud platform (github.com)

不過都還是開源的表悬,當(dāng)前的許可證都是Apache 2.0弥锄,不是某些人說的不能商用了,當(dāng)然無法保證以后不會改許可證蟆沫。


回到正文籽暇,這篇文章將介紹使用go-micro最新版本v4開發(fā)gRPC服務(wù)的方式。

1饥追、安裝protoc

這個工具也稱為proto編譯器图仓,可以用來生成各種開發(fā)語言使用proto協(xié)議的代碼。

下載地址:https://github.com/protocolbuffers/protobuf/releases

一般下載最新版本就行但绕,注意要符合自己當(dāng)前的操作系統(tǒng)。

img

解壓后里邊有個 protoc.exe 惶看,拷貝到 GOPATH 的 bin 目錄下捏顺,我這里就是 C:/Users/PC-001/go/bin ,PC-001 是登錄當(dāng)前操作系統(tǒng)的用戶名纬黎,需要換成你自己的幅骄。GOPATH 可以通過執(zhí)行 go env 查看到。

img

一般都是把 GOPATHbin 目錄添加到環(huán)境變量的 PATH 變量中本今,如果沒有拆座,請自行添加上。

2冠息、安裝protoc的go-micro插件

需要安裝兩個插件挪凑,它們用來生成 Golang 版本的 proto 協(xié)議代碼和 go-micro 的 gRPC 代理代碼。

執(zhí)行如下命令逛艰,會在 GOPATHbin 目錄下生成兩個可執(zhí)行文件:protoc-gen-go.exeprotoc-gen-micro.exe躏碳。

go install google.golang.org/protobuf/cmd/protoc-gen-go
go install go-micro.dev/v4/cmd/protoc-gen-micro@v4

3、編寫proto文件

proto文件是符合Protocol Buffers語言規(guī)范的數(shù)據(jù)交換協(xié)議文件散怖,就像以前WebService定義服務(wù)時使用的XML文件」矫啵現(xiàn)在一般都是用proto3了肄渗,這里創(chuàng)建一個名為 hello.proto 的文件,放到項目的proto目錄下:

syntax = "proto3";

option go_package="/proto";

package Business;

service Hello {
  rpc Say (SayRequest) returns (SayResponse);
}

message SayResponse {
  string Message = 1;
}

message SayRequest {
  string Name = 1;
}

這個協(xié)議很簡單咬最,有個名字為Hello的服務(wù)翎嫡,提供一個名字為Say的rpc方法,這個方法有輸入輸出永乌,輸入信息中有一個名為Name的參數(shù)惑申,輸出信息中有一個名為Message的返回值。

4铆遭、生成gRPC代理代碼

在項目根目錄中執(zhí)行如下命令硝桩,會在proto目錄下生成兩個文件:hello.pb.go 和 hello.pb.micro.go。

protoc --go_out=. --go_opt=paths=source_relative --micro_out=. --micro_opt=paths=source_relative proto/hello.proto

hello.pb.go 中是輸入輸出數(shù)據(jù)類型的Golang定義枚荣,hello.pb.micro.go 中是go-micro客戶端和服務(wù)端的gRPC代理程序碗脊。

也可以將文件生成到別的目錄中,比如修改 proto 文件中 go_package 的配置為:

option go_package="/business";

然后執(zhí)行下面的命令橄妆,會生成到項目下的business目錄中:

protoc --go_out=.  --micro_out=. proto/hello.proto

具體這個命令還有哪些參數(shù)衙伶,可以執(zhí)行 protoc -help 去探索下,這里就不羅嗦了害碾。

5矢劲、編寫gRPC服務(wù)端程序

這里先上代碼:

package main

import (
    "context"
    "fmt"
    "grpchello/proto"
    "log"
    "time"

    "github.com/asim/go-micro/plugins/server/grpc/v4"
    "go-micro.dev/v4"
    "go-micro.dev/v4/server"
)

type Hello struct{}

func (s *Hello) Say(ctx context.Context, req *proto.SayRequest, rsp *proto.SayResponse) error {
    fmt.Println("request:", req.Name)
    rsp.Message = "Hello " + req.Name
    return nil
}

func main() {

    grpcServer := grpc.NewServer()

    service := micro.NewService(
        micro.Server(grpcServer),
        micro.Name("grpchello.service"),
        micro.Address("0.0.0.0:8001"),
        micro.RegisterTTL(time.Second*30),
        micro.RegisterInterval(time.Second*10),
    )

    // optionally setup command line usage
    service.Init()

    // Register Handlers
    proto.RegisterHelloHandler(service.Server(), &Hello{})

    // Run server
    if err := service.Run(); err != nil {
        log.Fatal(err)
    }
}

整個過程如下:

先定義一個名為 Hello 的類型,它去實現(xiàn)hello.pb.micro.go中生成的HelloHandler接口慌随,也就是編寫具體的業(yè)務(wù)實現(xiàn)芬沉。

然后通過grpc.NewServer創(chuàng)建一個gRPC服務(wù)器,這里決定go-micro底層通信使用gPRC阁猜;

然后通過micro.NewService創(chuàng)建一個micro服務(wù)丸逸,這里需要傳入上面創(chuàng)建的grpc server,還要設(shè)置服務(wù)的名稱剃袍、監(jiān)聽端口黄刚,以及保持服務(wù)健康用的TTL和上報周期。go-mico當(dāng)前默認的服務(wù)發(fā)現(xiàn)機制是mdns民效,不用額外部署服務(wù)發(fā)現(xiàn)工具憔维,不過一般只建議在開發(fā)環(huán)境使用,生產(chǎn)環(huán)境建議使用etcd畏邢;

通過上面的步驟對服務(wù)進行一些初始化之后业扒,再將Hello類型的實例注冊到grpc server;

最后啟動服務(wù)棵红,就可以開始接客了凶赁。

如果直接粘貼這段代碼的話,會有很多包沒有引用進來,可以通過 go get 獲取這些包虱肄,也可以執(zhí)行命令:go mod tidy 來引入需要的包致板。

這里邊還import了一個 grpchello/proto ,這個是我這邊項目的mod是 grpchello咏窿,gRPC代理程序的package是proto斟或,如果你的不一樣,需要修改下集嵌。

6萝挤、編寫gRPC客戶端程序

訪問gRPC服務(wù)也是通過 hello.pb.micro.go 中生成的方法,直接上代碼:

package main

import (
    "bufio"
    "context"
    "fmt"
    "grpchello/proto"
    "os"

    "github.com/asim/go-micro/plugins/client/grpc/v4"
    "go-micro.dev/v4"
)

func main() {

    service := micro.NewService(
        micro.Client(grpc.NewClient()),
    )

    service.Init()
    client := proto.NewHelloService("grpchello.service", service.Client())

    rsp, err := client.Say(context.TODO(), &proto.SayRequest{Name: "BOSSMA"})
    if err != nil {
        fmt.Println(err)
    }

    fmt.Println(rsp)

    fmt.Println("按回車鍵退出程序...")
    in := bufio.NewReader(os.Stdin)
    _, _, _ = in.ReadLine()
}

上面的程序使用了 grpc.NewClient , 這決定了底層通信采用gRPC根欧;然后再使用生成的代碼 proto.NewHelloService 創(chuàng)建客戶端代理怜珍,這里指定的服務(wù)名字必須是服務(wù)端注冊的名字;最后使用這個客戶端代理調(diào)用相應(yīng)的方法凤粗。

7酥泛、運行程序

可以使用 go run xxx.go 來編譯并運行程序。這里為了方便測試嫌拣,先使用 go build 將它們編譯為exe柔袁,然后再雙擊運行。實際運行效果如下:

img

以上就是本文的主要內(nèi)容了异逐,完整代碼示例已經(jīng)上傳到 Github:https://github.com/bosima/go-demo/tree/main/go-micro-grpc-hello

收獲更多架構(gòu)知識捶索,請關(guān)注公眾號 螢火架構(gòu)。原創(chuàng)內(nèi)容灰瞻,轉(zhuǎn)載請注明出處腥例。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市酝润,隨后出現(xiàn)的幾起案子院崇,更是在濱河造成了極大的恐慌,老刑警劉巖袍祖,帶你破解...
    沈念sama閱讀 218,284評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異谢揪,居然都是意外死亡蕉陋,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評論 3 395
  • 文/潘曉璐 我一進店門拨扶,熙熙樓的掌柜王于貴愁眉苦臉地迎上來凳鬓,“玉大人,你說我怎么就攤上這事患民∷蹙伲” “怎么了?”我有些...
    開封第一講書人閱讀 164,614評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長仅孩。 經(jīng)常有香客問我托猩,道長,這世上最難降的妖魔是什么辽慕? 我笑而不...
    開封第一講書人閱讀 58,671評論 1 293
  • 正文 為了忘掉前任京腥,我火速辦了婚禮,結(jié)果婚禮上溅蛉,老公的妹妹穿的比我還像新娘公浪。我一直安慰自己,他們只是感情好船侧,可當(dāng)我...
    茶點故事閱讀 67,699評論 6 392
  • 文/花漫 我一把揭開白布欠气。 她就那樣靜靜地躺著,像睡著了一般镜撩。 火紅的嫁衣襯著肌膚如雪预柒。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,562評論 1 305
  • 那天琐鲁,我揣著相機與錄音卫旱,去河邊找鬼。 笑死围段,一個胖子當(dāng)著我的面吹牛顾翼,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播奈泪,決...
    沈念sama閱讀 40,309評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼适贸,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了涝桅?” 一聲冷哼從身側(cè)響起拜姿,我...
    開封第一講書人閱讀 39,223評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎冯遂,沒想到半個月后蕊肥,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,668評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡蛤肌,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,859評論 3 336
  • 正文 我和宋清朗相戀三年壁却,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片裸准。...
    茶點故事閱讀 39,981評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡展东,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出炒俱,到底是詐尸還是另有隱情盐肃,我是刑警寧澤爪膊,帶...
    沈念sama閱讀 35,705評論 5 347
  • 正文 年R本政府宣布,位于F島的核電站砸王,受9級特大地震影響推盛,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜处硬,卻給世界環(huán)境...
    茶點故事閱讀 41,310評論 3 330
  • 文/蒙蒙 一小槐、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧荷辕,春花似錦凿跳、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,904評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至骡显,卻和暖如春疆栏,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背惫谤。 一陣腳步聲響...
    開封第一講書人閱讀 33,023評論 1 270
  • 我被黑心中介騙來泰國打工壁顶, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人溜歪。 一個月前我還...
    沈念sama閱讀 48,146評論 3 370
  • 正文 我出身青樓若专,卻偏偏與公主長得像,于是被迫代替她去往敵國和親蝴猪。 傳聞我的和親對象是個殘疾皇子调衰,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,933評論 2 355

推薦閱讀更多精彩內(nèi)容