如何在golang 中使用 protobuf

Protobuf是什么

Protobuf实际是一套类似Json或者XML的数据传输格式和规范，用于不同应用或进程之间进行通信时使用。通信时所传递的信息是通过Protobuf定义的message数据结构进行打包，然后编译成二进制的码流再进行传输或者存储。

Protobuf的优点

相比较而言，Protobuf有如下优点：

• 足够简单
• 序列化后体积很小:消息大小只需要XML的1/10 ~ 1/3
• 解析速度快:解析速度比XML快20 ~ 100倍
• 多语言支持
• 更好的兼容性,Protobuf设计的一个原则就是要能够很好的支持向下或向上兼容

1.下载https://github.com/google/protobuf/releases

window：

下载: protoc-3.3.0-win32.zip
解压，把bin目录下的protoc.exe复制到GOPATH/bin下，GOPATH/bin加入环境变量。
当然也可放在其他目录，需加入环境变量，能让系统找到protoc.exe

linux：

下载：protoc-3.3.0-linux-x86_64.zip 或 protoc-3.3.0-linux-x86_32.zip
解压，把bin目录下的protoc复制到GOPATH/bin下，GOPATH/bin加入环境变量。
如果喜欢编译安装的，也可下载源码自行安装，最后将可执行文件加入环境变量。

2、获取protobuf的编译器插件protoc-gen-go

进入GOPATH目录
运行go get -u github.com/golang/protobuf/protoc-gen-go 如果成功，会在GOPATH/bin下生成protoc-gen-go.exe文件

3、创建一个test.proto文件

//指定版本
//注意proto3与proto2的写法有些不同
syntax = "proto3";
//包名，通过protoc生成时go文件时

package test;
//手机类型

//枚举类型第一个字段必须为0

enum PhoneType {

HOME = 0;

WORK = 1;

}
//手机

message Phone {

PhoneType type = 1;

string number = 2;

}
//人

message Person {

//后面的数字表示标识号

    int32 id = 1;

string name = 2;

//repeated表示可重复

    //可以有多个手机

    repeated Phone phones = 3;

}
//联系簿

message ContactBook {

repeated Person persons = 1;

}

4、运行如下命令

protoc --go_out=. *.proto

会生成一个test.pb.go的文件

5、在go语言中使用protobuf

package main;
import (

"github.com/golang/protobuf/proto"

"protobuf/test"

"io/ioutil"

"os"

"fmt"

)
func write() {

p1 := &test.Person{

Id:   1,

Name: "小张",

Phones: []*test.Phone{

{test.PhoneType_HOME, "111111111"},

{test.PhoneType_WORK, "222222222"},

},

};

p2 := &test.Person{

Id:   2,

Name: "小王",

Phones: []*test.Phone{

{test.PhoneType_HOME, "333333333"},

{test.PhoneType_WORK, "444444444"},

},

};
<span class="highlight-o">//</span><span class="highlight-n">创建地址簿</span>
<span class="highlight-n">book</span> <span class="highlight-o">:=</span> <span class="highlight-o">&amp;</span><span class="highlight-n">test</span><span class="highlight-o">.</span><span class="highlight-n">ContactBook</span><span class="highlight-p">{};</span>
<span class="highlight-n">book</span><span class="highlight-o">.</span><span class="highlight-n">Persons</span> <span class="highlight-o">=</span> <span class="highlight-n">append</span><span class="highlight-p">(</span><span class="highlight-n">book</span><span class="highlight-o">.</span><span class="highlight-n">Persons</span><span class="highlight-p">,</span> <span class="highlight-n">p1</span><span class="highlight-p">);</span>
<span class="highlight-n">book</span><span class="highlight-o">.</span><span class="highlight-n">Persons</span> <span class="highlight-o">=</span> <span class="highlight-n">append</span><span class="highlight-p">(</span><span class="highlight-n">book</span><span class="highlight-o">.</span><span class="highlight-n">Persons</span><span class="highlight-p">,</span> <span class="highlight-n">p2</span><span class="highlight-p">);</span>

<span class="highlight-o">//</span><span class="highlight-n">编码数据</span>
<span class="highlight-n">data</span><span class="highlight-p">,</span> <span class="highlight-n">_</span> <span class="highlight-o">:=</span> <span class="highlight-n">proto</span><span class="highlight-o">.</span><span class="highlight-n">Marshal</span><span class="highlight-p">(</span><span class="highlight-n">book</span><span class="highlight-p">);</span>
<span class="highlight-o">//</span><span class="highlight-n">把数据写入文件</span>
<span class="highlight-n">ioutil</span><span class="highlight-o">.</span><span class="highlight-n">WriteFile</span><span class="highlight-p">(</span><span class="highlight-s2">&#34;./test.txt&#34;</span><span class="highlight-p">,</span> <span class="highlight-n">data</span><span class="highlight-p">,</span> <span class="highlight-n">os</span><span class="highlight-o">.</span><span class="highlight-n">ModePerm</span><span class="highlight-p">);</span>

}
func read() {

//读取文件数据

data, _ := ioutil.ReadFile("./test.txt");

book := &test.ContactBook{};

//解码数据

proto.Unmarshal(data, book);

for _, v := range book.Persons {

fmt.Println(v.Id, v.Name);

for _, vv := range v.Phones {

fmt.Println(vv.Type, vv.Number);

}

}

}
func main() {

write();

read();

}