七叶笔记 » golang编程 » golang使用protobuf

golang使用protobuf

分类: golang编程 | 浏览: 845

1 Protobuf简介

Google Protocol Buffer( 简称 Protobuf)是Google公司内部的混合语言数据标准，他们主要用于RPC系统和持续数据存储系统。

2 Protobuf 应用场景

Protocol Buffers 是一种轻便高效的 结构化数据 存储格式，可以用于结构化数据串行化，或者说序列化。它很适合做数据存储或RPC数据交换格式。可用于通讯协议、数据存储等领域的语言无关、平台无关、可扩展的序列化结构数据格式。

简单来说，Protobuf的功能类似于XML，即负责把某种数据结构的信息，以某种格式保存起来。主要用于数据存储、传输协议等使用场景。

3 Protobuf 优缺点

优点

  • 性能好/效率高 时间维度：XML, JSON 格式对数据进行序列化和反序列化时性能差。空间维度：XML,JSON格式为了可读性，必然在进行存储数据时，也会消耗空间。整体而言，Protobuf以高效的 二进制 方式存储，比XML小3到10倍，快20到100倍。
  • 代码生成机制 代码生成机制能够极大解放开发者编写数据协议解析过程的时间，提高工作效率；于开发者维护和迭代。
  • 支持“向后兼容”和“向前兼容”
  • 支持多种编程语言 Protobuf不仅仅Google开源的一个数据协议，还有很多种语言的开源项目实现。

缺点

  • 可读性较差 为了提高性能，Protobuf采用了二进制格式进行 编码 。二进制格式编码对于开发者来说，是没办法阅读的。在进行程序调试时，比较困难。对于可读性要求高的数据报文程序就不建议使用。
  • 缺乏自描述 Protobuf是通过二进制格式进行数据传输，开发者面对二进制格式的Protobuf，没有办法知道所对应的真实的数据结构，因此在使用Protobuf协议传输时，必须配备对应的proto配置文件。

Protobuf3 语法指南:

4 Go语言中的编程实现

4.1 安装protobuf编译器

使用release版本下载地址:

方式一:

下载对应平台的 二进制文件 ,配置环境变量即可

image.png

方式二

由于我本机下载二进制文件太慢,这里使用编译安装

Ubuntu 安装(如果是centos直接将 apt-get 改为 yum ,如果是alpine将apt-get install 改为apk add)

4.2 安装go插件 protoc-gen-go

  • proto:实现了对编码，解码等,在后面会用到。
  • protoc-gen-go: 编译器插件:生成Go源文件。 

 # 下载
go get  -u -v github.com/golang/protobuf/protoc-gen-go
# 安装
cd $GOPATH/src/github.com/golang/protobuf/protoc-gen-go/
 go install

此时会在$GOPATH/ bin /生成二进制文件 

 ls  $GOPATH/bin/protoc-gen-go
/home/jinchunguang/go/bin/protoc-gen-go

5 使用Protobuf的步骤

5.1 编写proto文件 

 
# 创建项目目录
mkdir -pv protobuf-app/pb
cd protobuf-app

#  使用go mod
go mod init protobuf-app

# 编写协议文件
touch pb/person.proto
vim pb/person.proto

person.proto文件内容 

 syntax = "proto3";
package pb;

 message  Person {
    string Name = 1;
    int32 Age = 2;
    string From = 3;
}

5.2 生成协议文件 

 protoc --proto_path=./pb --go_out=./pb ./pb/person.proto

此时就会发现多了一个person.pb.go,这个就是生成的的协议文件 

 tree
.
├── go.mod
└── pb
    ├── person.pb.go
    └── person.proto

1 directory, 3 files

5.3 测试

下载编码解码库,也可以不下载,运行时go mod会自动解决依赖. 

 go get -u -v github.com/golang/protobuf/proto

main.go

执行程序

image.png

6 使用protobuf实现简单的Tcp通讯

6.1 新建proto文件 message.proto

文件内容 

 syntax = "proto3";
package pb;

message Message{
    string message = 1;
    int32 length = 2;
}

生成协议文件 

 protoc --proto_path=./pb --go_out=./pb ./pb/message.proto

6.2 新建立srv目录,添加 client, server 目录并且新建对应的go程序

client.go

server.go

6.3 测试

启动服务: 

 go run server.go

相关文章