go使用protobuf的过程以及可能出现的问题
1. 下载proto windows版本并安装
官方地址:protobuf
解压后复制bin目录下的
protoc.exe
到
GOPATH\bib
目录中
2. 安装protoc-gen-go
如果使用
go get -u github.com/golang/protobuf/protoc-gen-go
可能会出现如下错误:
go: module github.com/golang/protobuf is deprecated: Use the "google.golang.org/protobuf" module instead.go get: installing executables with 'go get' in module mode is deprecated. Use 'go install pkg@version' instead.For more information, see https://golang.org/doc/go-get-install-deprecation or run 'go help get' or 'go help install'.
使用下面的命令进行下载
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
安装成功后,在
GOPATH\bib
目录中可以看到
proroc-gen-go.exe
两个全部安装成功后,查看下版本号
3. proto文件转go文件报错protoc-gen-go: unable to determine go import path for “xxxx.proto”
需要注意的是在proto文件中,记得设置
option go_package
属性
syntax="proto3";//版本号package protobuf;//包名
option go_package ="./protobuf";
enum ClassName{//枚举
class1=0;//标号 必须从 0开始
class2=1;
class3=2;}
message Student{//消息,对应于Go的结构体string name=1;//1:标号,唯一 即可(相当于数据库中的Id,不一定要从1 ,2的顺序依次排列。)int32 age=2;//必须指定整型的范围,如int32,int64string address=3;
ClassName cn=4;}
message Students{
repeated Student person=1;// repeated 修饰,相当于Go中切片string school=2;}
再使用
protoc --go_out=. test.proto
命令生成go文件
4. 生成的go文件中google.golang.org/protobuf/reflect/protoreflect依赖爆红
import(
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl")
在
GOPATH/src
目录下新建
google.golang.org
文件夹,在该文件下使用命令:
git clone https://e.coding.net/robinqiwei/googleprotobuf.git protobuf
重新保存生成的
xxx.pb.go
文件,爆红消失
5. 基本使用
- 创建一个
.proto
文件(用于定义某些需要传输的message格式) - 编译
proto
文件,可以使用protoc --go_out=. *.proto
一次性编译当前文件夹下的多个proto
文件 - 编译完成后,protoc编译器将
proto
文件编译成.pb.go
文件
syntax ="proto3";// 版本信息,不指定会报错package pb;//生成go文件的包名
option go_package ="./pb";// 表示在当前文件夹下的pb包中// message为关键字 用于定义一种消息类型 1234表示打包时字段封装的先后顺序
message Person {string name =1;int32 age=2;
repeated string email =3;// repeated表示字段允许重复 => 类似于string[]
repeated PhoneNumber phones =4;}// enum关键字 定义一种枚举类型
enum PhoneType{
MOBILE=0;
HOME=1;
WORK=2;}// message也可以定义一种可以被其他消息嵌套的消息类型
message PhoneNumber{string number=1;
PhoneType type=2;}
测试传输
- 定义与protobuf对应的结构体
data, err := proto.Marshal(person
序列化编码得到结构体的二进制文件err = proto.Unmarshal(data, person)
接收到的数据反序列化得到person结构体
import("fmt""protobuf_test/pb""google.golang.org/protobuf/proto")funcmain(){
person :=&pb.Person{
Name:"Huzhen",
Age:27,
Email:[]string{"[email protected]","[email protected]"},
Phones:[]*pb.PhoneNumber{&pb.PhoneNumber{
Number:"18714859632",
Type: pb.PhoneType_MOBILE,},&pb.PhoneNumber{
Number:"18714857878",
Type: pb.PhoneType_HOME,},&pb.PhoneNumber{
Number:"18714854545",
Type: pb.PhoneType_WORK,},},}
fmt.Println("person: ", person)// 编码: 将person对象进行序列化,得到二进制文件
data, err := proto.Marshal(person)if err !=nil{
fmt.Println("encode err: ", err)return}
fmt.Println("data: ", data)// 解码(反序列化)
person2 :=&pb.Person{}
err = proto.Unmarshal(data, person2)if err !=nil{
fmt.Println("decode err: ", err)return}
fmt.Println("person2: ", person2)}
版权归原作者 从现在开始壹并超 所有, 如有侵权,请联系我们删除。