Golang開發(fā)gRPC服務(wù)入門介紹
gRPC是Google發(fā)起的一個開源RPC框架,使用HTTP/2傳輸協(xié)議,使用Protocol Buffers編碼協(xié)議,相比RESTful框架的程序性能提高不少,而且當前流行的編程語言基本都已經(jīng)支持。
Golang開發(fā)gRPC應(yīng)用程序的套路也已經(jīng)很清晰,這篇文章就來做一個簡單的介紹,算是入門。
1、安裝protoc
這個工具也稱為proto編譯器,可以用來生成各種開發(fā)語言使用proto協(xié)議的代碼。
下載地址:https://github.com/protocolbuffers/protobuf/releases
一般下載最新版本就行,注意要符合自己當前的操作系統(tǒng)。
解壓后里邊有個 protoc.exe ,拷貝到 GOPATH 的 bin 目錄下,我這里就是 C:/Users/PC-001/go/bin ,PC-001 是登錄當前操作系統(tǒng)的用戶名,需要換成你自己的。GOPATH 可以通過執(zhí)行 go env 查看到。
一般都是把 GOPATH 的 bin 目錄添加到環(huán)境變量的 PATH 變量中,如果沒有,請自行添加上。
2、安裝protoc的Golang gRPC插件
執(zhí)行如下命令,會在 GOPATH 的 bin 目錄下生成兩個可執(zhí)行文件:protoc-gen-go.exe 和 protoc-gen-go-grpc.exe。這兩個插件可以用來生成Golang版本的proto協(xié)議代碼和gRPC代理代碼。
go install google.golang.org/protobuf/cmd/protoc-gen-go go install google.golang.org/grpc/cmd/protoc-gen-go-grpc
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_grpc.pb.go。
protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative proto/hello.proto
hello.pb.go 中是輸入輸出數(shù)據(jù)類型的Golang定義,hello_grpc.pb.go 中是客戶端和服務(wù)端的gRPC代理類型和方法的Golang定義。
也可以將文件生成到別的目錄中,比如修改 proto 文件中 go_package 的配置為:
option go_package="/business";
然后執(zhí)行下面的命令,會生成到項目下的business目錄中:
protoc --go_out=. --go-grpc_out=. proto/hello.proto
具體這個命令還有哪些參數(shù),可以執(zhí)行 protoc -help 去探索下,這里就不羅嗦了。
5、編寫gRPC服務(wù)端程序
這里先上代碼:
package main import ( "context" "fmt" "grpcdemo/proto" "net" "google.golang.org/grpc" ) type server struct { proto.UnimplementedHelloServer } func (s *server) Say(ctx context.Context, req *proto.SayRequest) (*proto.SayResponse, error) { fmt.Println("request:", req.Name) return &proto.SayResponse{Message: "Hello " + req.Name}, nil func main() { listen, err := net.Listen("tcp", ":8001") if err != nil { fmt.Printf("failed to listen: %v", err) return } s := grpc.NewServer() proto.RegisterHelloServer(s, &server{}) //reflection.Register(s) defer func() { s.Stop() listen.Close() }() fmt.Println("Serving 8001...") err = s.Serve(listen) fmt.Printf("failed to serve: %v", err)
整個過程如下:先定義一個名為 server 的類型,它去實現(xiàn)hello_grpc.pb.go中生成的HelloServer接口;然后通過grpc.NewServer創(chuàng)建一個gRPC服務(wù)器;然后將server類型的實例注冊到這個gRPC服務(wù)器;最后讓這個gRPC服務(wù)器在某個本地網(wǎng)絡(luò)端口監(jiān)聽上開始接受客戶端請求。
代碼中注釋了一行:reflection.Register(s) 它是注冊了一個特殊的service,能讓外部獲得server中已注冊的服務(wù)和方法。這對于開發(fā)時可能比較有用,具體細節(jié)可以看這里:https://github.com/grpc/grpc-go/blob/master/Documentation/server-reflection-tutorial.md
如果直接粘貼這段代碼的話,會有很多包沒有引用進來,可以通過 go get 獲取這些包,也可以執(zhí)行命令:go mod tidy 來引入需要的包。
這里邊還import了一個 grpcdemo/proto ,這個是我這邊項目的mod是grpcdemo,gRPC代理程序的package是proto,如果你的不一樣,需要修改下。
6、編寫gRPC客戶端程序
訪問gRPC服務(wù)也是通過hello_grpc.pb.go中生成的方法,直接上代碼:
package main import ( "bufio" "context" "fmt" "grpchello/proto" "os" "google.golang.org/grpc" "google.golang.org/grpc/credentials/insecure" ) func main() { var serviceHost = "127.0.0.1:8001" conn, err := grpc.Dial(serviceHost, grpc.WithTransportCredentials(insecure.NewCredentials())) if err != nil { fmt.Println(err) } defer conn.Close() client := proto.NewHelloClient(conn) rsp, err := client.Say(context.TODO(), &proto.SayRequest{ Name: "BOSIMA", }) fmt.Println(rsp) fmt.Println("按回車鍵退出程序...") in := bufio.NewReader(os.Stdin) _, _, _ = in.ReadLine() }
上邊服務(wù)端程序的監(jiān)聽端口指定的 8001,所以這里先創(chuàng)建了一個到 127.0.0.1:8001 的連接;然后使用這個連接創(chuàng)建指定服務(wù)的客戶端 proto.NewHelloClient(conn) ;然后使用這個客戶端調(diào)用相應(yīng)的方法。
hello_grpc.pb.go 已經(jīng)生成了創(chuàng)建客戶端的函數(shù)以及調(diào)用方法的函數(shù),開發(fā)人員直接調(diào)用就好了。
7、運行程序
可以使用 go run xxx.go 來編譯并運行程序。這里為了方便測試,先使用 go build 將它們編譯為exe,然后再雙擊運行。實際運行效果如下:
以上就是本文的主要內(nèi)容了,protoc-gen-go 和 protoc-gen-go-grpc 這兩個插件都是gPRC官方提供的,官方也提供了其它多種語言的代理生成插件,其它框架或者語言開發(fā)的gRPC程序,只要符合gRPC規(guī)范,就能實現(xiàn)相互之間的互相訪問。
完整代碼示例已經(jīng)上傳到Github:https://github.com/bosima/go-demo/tree/main/grpc-hello
到此這篇關(guān)于Golang開發(fā)gRPC服務(wù)的文章就介紹到這了,更多相關(guān)Golang開發(fā)gRPC服務(wù)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Go語言編程學(xué)習(xí)golang配置golint
這篇文章主要為大家介紹了Go語言編程學(xué)習(xí)golang配置golint的過程示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2021-11-11golang cobra使用chatgpt qdrant實現(xiàn)ai知識庫
這篇文章主要為大家介紹了golang cobra使用chatgpt qdrant實現(xiàn)ai知識庫,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-09-09go語言區(qū)塊鏈實戰(zhàn)實現(xiàn)簡單的區(qū)塊與區(qū)塊鏈
這篇文章主要為大家介紹了go語言區(qū)塊鏈的實戰(zhàn)學(xué)習(xí),來實現(xiàn)簡單的區(qū)塊與區(qū)塊鏈示例過程,有需要的朋友可以借鑒參考下,希望能夠有所幫助2021-10-10GO 函數(shù)式選項模式(Functional Options Pattern)
Option模式支持傳遞多個參數(shù),并且在參數(shù)個數(shù)、類型發(fā)生變化時保持兼容性,任意順序傳遞參數(shù),下面給大家介紹GO 函數(shù)式選項模式(Functional Options Pattern)的相關(guān)知識,感興趣的朋友一起看看吧2021-10-10