GRPC: 使用 Buf 快速編譯 GRPC proto 文件

介紹

使用過 GRPC 的用戶都應(yīng)該知道，protocol buffer 文件需要使用相關(guān)的命令行，把 *.proto 文件編譯成 *.go 文件。

根據(jù)不同需要，會使用到不同的命令行文件。以 Go 語言為例，我們需要大致如下幾個命令行文件。

除了安裝上述命令行，我們還需要根據(jù)需要，運(yùn)行至少4種不同命令來編譯 *.proto 文件，非常晦澀難懂。

使用 Buf 快速編譯

我們可以通過 Buf 快速配置編譯流程。雖然前期需要一定的配置，但是比起寫復(fù)雜的腳本，要簡單安全的多。

下面我們就通過一個例子來瀏覽一下。

例子

我們以簡單的 Hello World 為例子，一步一步生成基于 GRPC 的微服務(wù)。

例子

文檔

第一步：安裝命令行

建議通過 rk 命令行，快速安裝所需要的工具。

# Install RK CLI $ go get -u github.com/rookie-ninja/rk/cmd/rk # List available installation $ rk install COMMANDS: buf install buf on local machine cfssl install cfssl on local machine cfssljson install cfssljson on local machine gocov install gocov on local machine golangci-lint install golangci-lint on local machine mockgen install mockgen on local machine pkger install pkger on local machine protobuf install protobuf on local machine protoc-gen-doc install protoc-gen-doc on local machine protoc-gen-go install protoc-gen-go on local machine protoc-gen-go-grpc install protoc-gen-go-grpc on local machne protoc-gen-grpc-gateway install protoc-gen-grpc-gateway on local machine protoc-gen-openapiv2 install protoc-gen-openapiv2 on local machine swag install swag on local machine rk-std install rk standard environment on local machine help, h Shows a list of commands or help for one command # Install protobuf, buf, protoc-gen-go, protoc-gen-go-grpc, protoc-gen-grpc-gateway, protoc-gen-openapiv2 $ rk install protobuf $ rk install protoc-gen-go $ rk install protoc-gen-go-grpc $ rk install protoc-gen-go-grpc-gateway $ rk install protoc-gen-openapiv2 $ rk install buf

也可以自行在官網(wǎng)安裝

第二步：創(chuàng)建 api/v1/greeter.proto

syntax = "proto3"; package api.v1; option go_package = "api/v1/greeter"; service Greeter { rpc Greeter (GreeterRequest) returns (GreeterResponse) {} } message GreeterRequest { string name = 1; } message GreeterResponse { string message = 1; }

第三步：創(chuàng)建 api/v1/gw_mapping.yaml

我們通過 gw_mapping.yaml 文件來映射 GRPC -> Restful API。這樣我們可以避免在 *.proto 文件里寫一堆 option 代碼。

具體語法，可以參考：https://github.com/googleapis/googleapis/blob/master/google/api/http.proto

type: google.api.Service config_version: 3 # Please refer google.api.Http in https://github.com/googleapis/googleapis/blob/master/google/api/http.proto file for details. http: rules: - selector: api.v1.Greeter.Greeter get: /api/v1/greeter

第四步：創(chuàng)建 buf.yaml

我們通過 buf.yaml 告訴 buf 在那里尋找 proto 文件。我們指定 api/ 文件夾。

version: v1beta1 name: github.com/rk-dev/rk-demo build: roots: - api

第五步：創(chuàng)建 buf.gen.yaml

下面的參數(shù)，告訴 buf 編譯的時候，應(yīng)該做哪些事情。我們的文件中，主要做了如下的事情。

指定編譯后的文件，放到 api/gen 文件夾中

編譯 proto 文件

編譯 GRPC 相關(guān)的 proto 文件

編譯 GRPC-Gateway 相關(guān)的 proto 文件

從 proto 文件，編譯出 openapi-v2 相關(guān)的文件（Swagger）

version: v1beta1 plugins: # protoc-gen-go needs to be installed, generate go files based on proto files - name: go out: api/gen opt: - paths=source_relative # protoc-gen-go-grpc needs to be installed, generate grpc go files based on proto files - name: go-grpc out: api/gen opt: - paths=source_relative - require_unimplemented_servers=false # protoc-gen-grpc-gateway needs to be installed, generate grpc-gateway go files based on proto files - name: grpc-gateway out: api/gen opt: - paths=source_relative - grpc_api_configuration=api/v1/gw_mapping.yaml # protoc-gen-openapiv2 needs to be installed, generate swagger config files based on proto files - name: openapiv2 out: api/gen opt: - grpc_api_configuration=api/v1/gw_mapping.yaml

第六步：編譯 proto

上述配置都完成以后，無論 *.proto 文件如何修改，我們只要運(yùn)行 buf generate，即可編譯 *.proto 文件，非常方便。

$ buf generate

如下的文件會被創(chuàng)建。

$ tree api/gen api/gen └── v1 ├── greeter.pb.go ├── greeter.pb.gw.go ├── greeter.swagger.json └── greeter_grpc.pb.go 1 directory, 4 files

第七步：在 main.go 中引用

我們已經(jīng)編譯好了 *.proto 文件，剩下的就是在 main.go 文件中引用了剛剛生成的 proto API 了。

這里，我們介紹 rk-boot 庫，通過 rk-boot 用戶可以快速搭建基于 GRPC 的微服務(wù)。

文檔

源代碼

例子

--- grpc: - name: greeter # Name of grpc entry port: 8080 # Port of grpc entry enabled: true # Enable grpc entry sw: enabled: true # Enable Swagger UI jsonPath: "api/gen/v1" # Boot will look for swagger config files from this folder

package main import ( "context" "fmt" "github.com/rookie-ninja/rk-boot" "github.com/rookie-ninja/rk-demo/api/gen/v1" "google.golang.org/grpc" ) // Application entrance. func main() { // Create a new boot instance. boot := rkboot.NewBoot() // *************************************** // ******* Register GRPC & Gateway ******* // *************************************** // Get grpc entry with name grpcEntry := boot.GetGrpcEntry("greeter") // Register grpc registration function grpcEntry.AddRegFuncGrpc(registerGreeter) // Register grpc-gateway registration function grpcEntry.AddRegFuncGw(greeter.RegisterGreeterHandlerFromEndpoint) // Bootstrap boot.Bootstrap(context.Background()) // Wait for shutdown sig boot.WaitForShutdownSig(context.Background()) } // Implementation of [type GrpcRegFunc func(server *grpc.Server)] func registerGreeter(server *grpc.Server) { greeter.RegisterGreeterServer(server, &GreeterServer{}) } // Implementation of grpc service defined in proto file type GreeterServer struct{} func (server *GreeterServer) Greeter(ctx context.Context, request *greeter.GreeterRequest) (*greeter.GreeterResponse, error) { return &greeter.GreeterResponse{ Message: fmt.Sprintf("Hello %s!", request.Name), }, nil }

$ tree . ├── api │ ├── gen │ │ └── v1 │ │ ├── greeter.pb.go │ │ ├── greeter.pb.gw.go │ │ ├── greeter.swagger.json │ │ └── greeter_grpc.pb.go │ └── v1 │ ├── greeter.proto │ └── gw_mapping.yaml ├── boot.yaml ├── buf.gen.yaml ├── buf.yaml ├── go.mod ├── go.sum └── main.go 4 directories, 12 files

$ go run main.go

$ curl "localhost:8080/api/v1/greeter?name=rk-dev" {"message":"Hello rk-dev!"}

訪問 Swagger: localhost:8080/sw

API Go 開源

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實后本網(wǎng)站將在24小時內(nèi)刪除侵權(quán)內(nèi)容。

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實后本網(wǎng)站將在24小時內(nèi)刪除侵權(quán)內(nèi)容。