Go语言中有对应的实现Protobuf协议的库,Github地址:https://github.com/golang/protobuf (opens new window)
# 环境准备
使用Go语言的Protobuf库之前,需要相应的环境准备:
- 1、安装protobuf编译器。 可以在如下地址:https://github.com/protocolbuffers/protobuf/releases (opens new window) 选择适合自己系统的Proto编译器程序进行下载并解压,如图:
- 2、配置环境变量 protoc编译器正常运行需要进行环境变量配置,将protocke执行文件所在目录添加到当前系统的环境变量中。windows系统下可以直接在Path目录中进行添加;macOS系统下可以将protoc可执行文件拷贝至**/usr/local/include**目录下。具体的对应的系统的环境变量配置可以阅读解压后与bin目录同级的readme.txt的文件内容。
# 安装
通过如下命令安装protoc-gen-go库:
go get github.com/golang/protobuf/protoc-gen-go
安装完成以后,protoc-gen-go*可执行文件在本地环境GOPATH/bin目录下,如下图所示:
# Protobuf 协议语法
Protobuf 协议的格式 Protobuf协议规定:使用该协议进行数据序列化和反序列化操作时,首先定义传输数据的格式,并命名为以
".proto"
为扩展名的消息定义文件。message 定义一个消息 先来看一个非常简单的例子。假设想定义一个“订单”的消息格式,每一个“订单"都含有一个订单号ID、订单金额Num、订单时间TimeStamp字段。可以采用如下的方式来定义消息类型的.proto文件:
message Order{ required string order_id = 1; required int64 num = 2; optional int32 timestamp = 3; }
1
2
3
4
5Order消息格式有3个字段,在消息中承载的数据分别对应每一个字段。其中每个字段都有一个名字和一种类型。
指定字段类型:在proto协议中,字段的类型包括字符串(string)、整形(int32、int64…)、枚举(enum)等数据类型
分配标识符:在消息字段中,每个字段都有唯一的一个标识符。最小的标识号可以从1开始,最大到536870911。不可以使用其中的[19000-19999]的标识号, Protobuf协议实现中对这些进行了预留。如果非要在.proto文件中使用这些预留标识号,编译时就会报警。
指定字段规则:
字段的修饰符包含三种类型,分别是:
- required:一个格式良好的消息一定要含有1个这种字段。表示该值是必须要设置的;
- optional:消息格式中该字段可以有0个或1个值(不超过1个)。
- repeated:在一个格式良好的消息中,这种字段可以重复任意多次(包括0次)。重复的值的顺序会被保留。表示该值可以重复,相当于Go中的slice。
【注意:】使用required弊多于利;在实际开发中更应该使用optional和repeated而不是required。
- 添加更多消息类型 在同一个.proto文件中,可以定义多个消息类型。多个消息类型分开定义即可。
# 使用 Protobuf 的步骤
1、创建扩展名为
.proto
的文件,并编写代码。比如创建person.proto文件,内容如下:syntax = "proto2"; package example; message Person { required string Name = 1; required int32 Age = 2; required string From = 3; }
1
2
3
4
5
6
7
82、编译.proto文件,生成Go语言文件。执行如下命令:
protoc --go_out = . test.proto
1执行 protoc –go_out=. test.proto 生成对应的 person.pb.go 文件。并构建对应的example目录,存放生成的person.pb.go文件。
3、在程序中使用Protobuf 在程序中有如下代码:
package main import ( "fmt" "ProtocDemo/example" "github.com/golang/protobuf/proto" "os" ) func main() { fmt.Println("Hello World. \n") msg_test := &example.Person{ Name: proto.String("Davie"), Age: proto.Int(18), From: proto.String("China"), } //序列化 msgDataEncoding, err := proto.Marshal(msg_test) if err != nil { panic(err.Error()) return } msgEntity := example.Person{} err = proto.Unmarshal(msgDataEncoding, &msgEntity) if err != nil { fmt.Println(err.Error()) os.Exit(1) return } fmt.Printf("姓名:%s\n\n", msgEntity.GetName()) fmt.Printf("年龄:%d\n\n", msgEntity.GetAge()) fmt.Printf("国籍:%s\n\n", msgEntity.GetFrom()) }COPY
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
353、执行程序