十分鐘學會Golang開發gRPC服務
- 2022 年 4 月 20 日
- 筆記
gRPC是Google發起的一個開源RPC框架，使用HTTP/2傳輸協議，使用Protocol Buffers編碼協議，相比RESTful框架的程序性能提高不少，而且當前流行的編程語言基本都已經支持。
Golang開發gRPC應用程序的套路也已經很清晰，這篇文章就來做一個簡單的介紹，算是入門。
1、安裝protoc
這個工具也稱為proto編譯器，可以用來生成各種開發語言使用proto協議的代碼。
下載地址：//github.com/protocolbuffers/protobuf/releases
一般下載最新版本就行，注意要符合自己當前的操作系統。
解壓后里邊有個 protoc.exe ，拷貝到 GOPATH 的 bin 目錄下，我這裡就是 C:/Users/PC-001/go/bin ，PC-001 是登錄當前操作系統的用戶名，需要換成你自己的。GOPATH 可以通過執行 go env 查看到。
一般都是把 GOPATH 的 bin 目錄添加到環境變量的 PATH 變量中，如果沒有，請自行添加上。
2、安裝protoc的Golang gRPC插件
執行如下命令，會在 GOPATH 的 bin 目錄下生成兩個可執行文件：protoc-gen-go.exe 和 protoc-gen-go-grpc.exe。這兩個插件可以用來生成Golang版本的proto協議代碼和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語言規範的數據交換協議文件，就像以前WebService定義服務時使用的XML文件。現在一般都是用proto3了，這裡創建一個名為 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;
}
這個協議很簡單，有個名字為Hello的服務，提供一個名字為Say的rpc方法，這個方法有輸入輸出，輸入信息中有一個名為Name的參數，輸出信息中有一個名為Message的返回值。
4、生成gRPC代理代碼
在項目根目錄中執行如下命令，會在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 中是輸入輸出數據類型的Golang定義，hello_grpc.pb.go 中是客戶端和服務端的gRPC代理類型和方法的Golang定義。
也可以將文件生成到別的目錄中，比如修改 proto 文件中 go_package 的配置為：
option go_package="/business";
然後執行下面的命令，會生成到項目下的business目錄中：
protoc --go_out=. --go-grpc_out=. proto/hello.proto
具體這個命令還有哪些參數，可以執行 protoc -help 去探索下，這裡就不羅嗦了。
5、編寫gRPC服務端程序
這裡先上代碼：
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)
if err != nil {
fmt.Printf("failed to serve: %v", err)
return
}
}
整個過程如下：先定義一個名為 server 的類型，它去實現hello_grpc.pb.go中生成的HelloServer接口；然後通過grpc.NewServer創建一個gRPC服務器；然後將server類型的實例註冊到這個gRPC服務器；最後讓這個gRPC服務器在某個本地網絡端口監聽上開始接受客戶端請求。
代碼中注釋了一行：reflection.Register(s) 它是註冊了一個特殊的service，能讓外部獲得server中已註冊的服務和方法。這對於開發時可能比較有用，具體細節可以看這裡：//github.com/grpc/grpc-go/blob/master/Documentation/server-reflection-tutorial.md
如果直接粘貼這段代碼的話，會有很多包沒有引用進來，可以通過 go get 獲取這些包，也可以執行命令：go mod tidy 來引入需要的包。
這裡邊還import了一個 grpcdemo/proto ，這個是我這邊項目的mod是grpcdemo，gRPC代理程序的package是proto，如果你的不一樣，需要修改下。
6、編寫gRPC客戶端程序
訪問gRPC服務也是通過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",
})
if err != nil {
fmt.Println(err)
}
fmt.Println(rsp)
fmt.Println("按回車鍵退出程序...")
in := bufio.NewReader(os.Stdin)
_, _, _ = in.ReadLine()
}
上邊服務端程序的監聽端口指定的 8001，所以這裡先創建了一個到 127.0.0.1:8001 的連接；然後使用這個連接創建指定服務的客戶端 proto.NewHelloClient(conn) ；然後使用這個客戶端調用相應的方法。
hello_grpc.pb.go 已經生成了創建客戶端的函數以及調用方法的函數，開發人員直接調用就好了。
7、運行程序
可以使用 go run xxx.go 來編譯並運行程序。這裡為了方便測試，先使用 go build 將它們編譯為exe，然後再雙擊運行。實際運行效果如下：
以上就是本文的主要內容了，protoc-gen-go 和 protoc-gen-go-grpc 這兩個插件都是gPRC官方提供的，官方也提供了其它多種語言的代理生成插件，其它框架或者語言開發的gRPC程序，只要符合gRPC規範，就能實現相互之間的互相訪問。
完整代碼示例已經上傳到Github：//github.com/bosima/go-demo/tree/main/grpc-hello
收穫更多架構知識，請關注微信公眾號 螢火架構。原創內容，轉載請註明出處。
