作者:Maze-HYW_276 | 来源:互联网 | 2023-01-20 13:55
1.安装ProtoBuf编译器protoc(protobuf的编译器叫protoc)
(1)protobuf协议编译器是用c++编写的,根据自己的操作系统下载对应版本的protoc编译器:
https://github.com/protocolbuffers/protobuf/releases,
(2)这里下载的是:protoc-21.0-win64.zip,windows 64位系统版本的编译器,下载后解压,将文件夹重名为 protoc
目录结构为:
protoc|___bin|___include|___readme.txt我放在了:$GOPATH 下 ( C:\mygo\protoc ) 安装完成后,将protoc.exe所在目录路径,C:\mygo\protoc\bin 添加到Path环境变量中;打开cmd,命令窗口执行$ protoc --version 命令,没有报错的话,就已经安装成功;2.Protobuf下针对go语言的编译器、GRPC插件的安装:
protoc-gen-go:Go专用的protoc的编译器插件,安装后会在$GOPATH/bin目录下生成一个protoc-gen-go.exe
protoc-gen-go-grp:Go调用grpc的插件,安装后会在$GOPATH/bin目录下生成一个protoc-gen-go-grpc.exe$ go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.26
$ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.1安装完成后,在$GOPATH/bin下面会找到protoc-gen-go.exe,和 protoc-gen-go-grpc.exe将$GOPATH/bin路径添加到Path环境变量中:
C:\mygo\bin3.新建项目,在项目目录下,go mod init 初始化4.测试,定义一个proto例子api.proto
如果想要将消息类型用在RPC(远程方法调用)系统中,可以在.proto文件中定义一个RPC服务接口,protocol buffer编译器将会根据所选择的不同语言生成服务接口代码及存根;// 我们定义了一个 ProductInfo 服务,其中有两个方法,分别是添加商品和获取商品
syntax = "proto3";
option go_package = "./;api";package api;service ProductInfo {// 添加商品rpc addProduct(Product) returns (ProductId);// 获取商品rpc getProduct(ProductId) returns (Product);
}message Product {string id = 1;string name = 2;string description = 3;
}message ProductId {string id = 1;
}5.编译proto文件,生成go代码
cd 到api.proto所在路径
$ cd api
$ protoc --go_out=./ api.protoapi.pb.go 编译后没有生成service相应的服务接口,只生成了model相关类$ protoc --go_out=. --go-grpc_out=. api.proto
会生成两个文件
api.pb.go
api_grpc.pb.go 编译后生成了service相应的服务接口,grpc服务调用,需要用此文件protoc 表示调用protoc进行代码生成
--go_out= 表示生成golang的代码格式,也可以是java_out=
./ 表示生成路径6、至此golang使用protobuf例子结束
注意1:如果在生成时报错:
protoc-gen-go: unable to determine Go import path for "api.proto"Please specify either:• a "go_package" option in the .proto source file, or• a "M" argument on the command line.See https://developers.google.com/protocol-buffers/docs/reference/go-generated#package for more information.--go_out: protoc-gen-go: Plugin failed with status code 1.需要在api.proto文件中指定,生成的.go文件的存放地址
option go_package = "path;name";path 表示生成的go文件的存放地址,会自动生成目录的。
name 表示生成的go文件所属的包名
//option go_package = "path;name";syntax = "proto3";
option go_package = "../;api";/*** 注意位置**/
package api;
{}