Go protobuf
- 使用protobuf实现节点间通信、编码报文以提高传输效率
- protobuf全程Protocol Buffers,是Google开发的一种数据描述语言。
- protobuf是一种轻便高效的结构化数据存储格式。
- protobuf跟存储格式、语言、平台无关。
- protobuf可扩展可序列化
- protobuf以二进制方式存储,占用内存空间小。
protobuf广泛地应用于远程过程调用(PRC)的二进制传输,使用protobuf的目的是为了获得更高的性能。传输前使用protobuf编码,接收方再进行解码,可显著地降低二进制传输数据的大小。另外,protobuf非常适合传输结构化数据,便于通信字段的扩展。
protoc
protoc
是protobuf文件(.proto)的编译器,使用protoc
工具可以将.proto
文件转换为各种编程语言对应的源码,包含数据类型定义和调用接口等。
从 https://github.com/protocolbuffers/protobuf/releases 中下载最新的protobuf安装包 protoc-3.15.6-win64.zip
解压压缩包后将bin
目录下的protoc.exe
文件移动到$GOPATH/bin
目录下,注意$GOPATH/bin
需要提前添加到环境变量Path目录下。
$ protoc -help
$ protoc --version
libprotoc 3.15.6
protobuf
protobuf对于Golang有两个可选用的包分别是官方的goprotobuf和gogoprotobuf,gogoprotobuf是完全兼容Google Protobuf的,只是生成的代码质量要比goprotbuf要高。
安装protobuf库
$ go get github.com/golang/protobuf/proto
go: found github.com/golang/protobuf/proto in github.com/golang/protobuf v1.5.1
go: downloading github.com/golang/protobuf v1.5.0
go: github.com/golang/protobuf upgrade => v1.5.1
安装gogoprotobuf库
$ go get github.com/gogo/protobuf/proto
go: found github.com/gogo/protobuf/proto in github.com/gogo/protobuf v1.3.2
protoc-gen-go
protoc-gen-go 是 protobuf 编译插件系列中的Go版本,protoc-gen-to 使用Golang编写。
在Golang中使用protobuf需提前安装 protoc-gen-to工具,用于将.proto文件转换为Golang代码。
$ go get -u github.com/golang/protobuf/protoc-gen-go
protoc-gen-go将会自动安装到$GOPATH/bin
目录下,Windows中会生成 protoc-gen-go.exe 文件。
在当前项目下执行引入protobuf,会在go.mod文件中自动添加对protobuf的require
引入。
$ go get github.com/golang/protobuf/proto
go: found github.com/golang/protobuf/proto in github.com/golang/protobuf v1.5.1
protobuf会在.proto
文件中定义需要处理的结构化数据,通过protoc
工具可将.proto
文件转换为C、C++、Golang、Java、Python等多种语言的代码,因此兼容性好且易于使用。
$ protoc --go_out=. *.proto
命令之后理论上会将当前目录下的所有的.proto
文件生成.pb.go
文件,但实际测试发现报错,不推荐使用。
protoc-gen-go: unable to determine Go import path for "test.proto"
protoc-gen-gogo
gogoprotobuf有两个插件可用分别是protoc-gen-gogo和protoc-gen-gofast,protoc-gen-gogo生成的文件和protoc-gen-go一样性能略快,protoc-gen-gofast生成的Golang文件更为复杂,但性能却高出5~7倍。
安装gogoprotobuf插件
$ go get github.com/gogo/protobuf/protoc-gen-gogo
执行后会在$GOPATH
下的bin
目录下生成protoc-gen-gogo.exe
为文件,同时会在当前项目的go.mod
文件内自动引入require github.com/gogo/protobuf v1.3.2
。
$ protoc *.proto --gogo_out=.
执行后会将当前目录下的所有.proto
文件生成.pb.go
文件
protoc-gen-gofast
$ go get github.com/gogo/protobuf/protoc-gen-gofast
执行后会在$GOPATH
下的bin
目录下生成protoc-gen-gofast.exe
为文件
$ protoc *.proto --gofast_out=.
执行后会将当前目录下的所有.proto
文件生成.pb.go
文件
语法
- Protobuf协议规定:使用Protobuf协议进行数据序列化和反序列化操作时,首先需要定义传输数据的格式,并命名以
.proto
为扩展名的消息定义文件。 - 使用
message
定义一个消息 - 指定消息字段类型
- 分配标识符,在消息字段中每个字段都有唯一的一个标识符,最小标识号可以从1开始,最大到536870911。不可以使用[19000 ~ 19999]之间的标号。
- 指定字段规则,字段修饰符包括
required
、optional
、repeated
三种类型,注意required
弊大于利。
使用
- 按照protobuf语法,在
.proto
文件中定义数据结构,同时使用protoc
工具生成Golang代码。 - 在项目代码中引用生成的Golang代码
定义消息类型
$ vim ./proto/test.proto
syntax = "proto3";package proto;message User{string name = 1;bool male = 2;repeated int32 balance = 3;
}
运行命令
$ protoc --go_out=output_directory input_directory/file.proto
--go_out=
表示生成Go文件,protoc
会自动寻找系统环境变量Path中的protoc-gen-go
执行工具。
$ protoc --go_out=. *.proto
protoc-gen-go: unable to determine Go import path for "test.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.
原因未知,protoc-gen-go
插件无法生成.pb.go
文件,换用protoc-gen-gofast
插件。
$ protoc *.proto --gofast_out=.
标量类型
Protobuf类型 | Golang类型 | 描述 |
---|---|---|
int32 | int32 | 变长编码,对于负值效率较低。若域可能存在负值可使用sint64替代。 |
int64 | int64 | - |
uint32 | uint32 | 变长编码 |
uint64 | uint64 | 变长编码 |
sint32 | int32 | 变长编码,在负值时比int32高效。 |
sint64 | int64 | 变长编码,有符号整型值。编码时比int64高效。 |
fixed32 | uint32 | 固长编码,4个字节,若数值大于2^28则比uint32高效。 |
fixed64 | uint64 | 固长编码,8个字节,若数值大于2^56则比uint64高效。 |
sfixed32 | int32 | 固长编码,4个字节。 |
sfixed64 | int64 | 固长编码,8个字节。 |
float | float32 | - |
double | float64 | - |
bool | bool | 默认false |
bytes | []byte | 任意字节序列,长度不超过2^32,默认空数组。 |
string | string | UTF8编码或7-bit ASCII编码的文本,长度不超过2^32。 |
标量类型如果没有被赋值则不会被序列化,解析时会赋予默认值。
标量类型 | 默认值 |
---|---|
strings | 空字符串 |
bytes | 空序列 |
bools | false |
数值类型 | 0 |
风格
文件
- 文件名使用小写下划线的命名风格,例如
lower_snake_case.proto
。 - 每行不超过80个字符
- 使用2个空格缩进
包
- 包名应该和目录结构对应,例如文件在
my/package/
目录下,则包名为my.package
。
消息
- 消息名使用首字母大写驼峰风格(CamelCase),例如
message PlayerRequest{...}
。 - 字段名使用小写下划线风格,例如
string user_id = 1
。 - 枚举类型中枚举名使用首字母大写驼峰风格,例如
enum FooBar
,枚举值使用全大写下划线分割的风格(CAPITALS_WITH_UNDERSCORES),例如FOO_DEFAULT = 1
。
服务
- RPC服务名和方法名均使用首字母大写驼峰风格,例如
service FooService{rpc GetSomething()}
。
案例
创建.proto
文件
$ vim ./pb/lobby.proto
syntax = "proto3";
package pb;message Player{string user_id = 1;string name = 2;string icon = 3;int32 point = 4;int32 seat = 5;int32 identity = 6; //身份int32 status = 7; //状态
}
将.proto
生成.pb.go
文件
$ cd pb
$ protoc lobby.proto --gogo_out=.
测试代码
$ vim main.go
package mainimport ("fmt""gfw/pb""github.com/gogo/protobuf/proto"
)func main() {player := &pb.Player{UserId: "1",Name: "admin",}//序列化buf, err := proto.Marshal(player)if err != nil {panic(err)}fmt.Printf("%v\n", buf)// [10 1 49 18 5 97 100 109 105 110]fmt.Printf("%s\n", buf)// 1admin//反序列化obj := &pb.Player{}err = proto.Unmarshal(buf, obj)if err != nil {panic(err)}fmt.Printf("%v\n", obj)// user_id:"1" name:"admin" fmt.Printf("%v\n", obj.GetName()) // admin
}
$ go run main.go
http://www.taodudu.cc/news/show-5159543.html
相关文章:
- ProtoBuf在中C++使用介绍
- 【魅力开源】第7集:开源ERP系统Odoo发展史(Odoo中文社区野史2019版)
- 数据进化企业 浪潮ERP全面支撑企业数字化转型
- 浪潮ERP技术支持知识库
- 金蝶云星空与浪潮ERP对接集成应付单查询1连通新增凭证-定制webService(浪潮凭证测试)
- 浪潮服务器安装xp系统,浪潮ERP软件安装xp操作系统的电脑无法互相访问的解决方案 | 浪潮888博客...
- 浪潮小机装oracle数据库,浪潮ERP-PS V10.2安装手册.doc
- 金蝶,用友,浪潮erp介绍
- 新型智慧城市整体建设方案(图文)
- kali突然连不上网络的解决方案
- 健康大数据中心总体规划方案(ppt)
- 永久内外网互通解决方案
- 关于内外网隔离的网络访问解决方案
- Execution failed for task ‘:app:checkDebugAarMetadata‘.
- 写入epass1000nd 的 key1和key1(c#)
- 05_BootScrap——CRUD(动态页面中篇)
- HMAC在“挑战/响应”(Challenge/Response)身份认证的应用
- linux软件安装和项目部署
- 关于ePass1000在B/S结构下的文件内容读取(VBSCRIPT)
- java怎么调epass3003,帮助中心
- java怎么调epass3003,Snooper.Spec-003-apdu脚本_taoism版.pdf
- Epass 1000的验证以及修改PIN码的JavaScript代码
- 什么是ePass3000
- epass2000怎么使用
- epass1000 初始化 验证
- epass 1000ND 使用心得
- epass收集
- 有关epass1000nd 应用active控件的java示例_ePass1000ND
- USBKEY全解析---epass1000ND详解
- oracle实现将汉字字符串转换成拼音首字母缩写
Go protobuf相关推荐
- 使用Protobuf文件一键生成Java类
使用Protobuf文件生成Java类 .proto 文件生成 .java 参考 看了一篇文章:主题是 proto 先生成 desc,然后在用 FreeMarker 模板引擎来做代码自动生成了: .p ...
- 简单protobuf
protobuf的数据类型,有最简单的那种数据类型,就是一个文件中,定义了一个message 可以在一个文件中定义两个message,两个message之间是没有关联的 可以在一个文件中,定义两个me ...
- google ProtoBuf开发者指南
目录 1 概览 1.1 什么是protocol buffer 1.2 他们如何工作 1.3 为什么不用XML? 1.4 听起来像是为我的解决方案,如何开始? 1.5 一点历史 ...
- Ubuntu14.04上编译指定版本的protobuf源码操作步骤
Google Protobuf的介绍可以参考 http://blog.csdn.net/fengbingchun/article/details/49977903 ,这里介绍在Ubuntu14.04上 ...
- Windows7上配置Python Protobuf 操作步骤
1. 按照http://blog.csdn.net/fengbingchun/article/details/8183468 中步骤,首先安装Python 2.7.10: 2. 按照http:// ...
- 【C++】Google Protocol Buffer(protobuf)详解(二)
代码走读:caffe中protobuf的详细使用过程 [一]proto文件,以caffe.proto中BlobShape为例 syntax = "proto2"; //指明prot ...
- 【C++】Google Protocol Buffer(protobuf)详解(一)
1.简介 Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准, Protocol Buffers 是一种轻便高效的结构化数据存储格式 ...
- protobufjs 命令执行_【原码笔记】-- protobuf.js 与 Long.js
protobuf.js的结构和webpack的加载之后的结构很相似.这样的模块化组合是个不错的结构方式.1个是适应了不同的加载方式,2个模块直接很独立.webpack的功能更全一点.但如果自己封装js ...
- 在网络通讯中应用Protobuf
Protobuf的设计非常适用于在网络通讯中的数据载体,它序列化出来的数据量少再加上以K-V的方式来存储数据,对消息的版本兼容性非常强:还有一个比较大的优点就是有着很多的语言平台支持.下面讲解一下如何 ...
- 连信的protobuf数据格式
点击上方↑↑↑蓝字[协议分析与还原]关注我们 " 连信里用到的protobuf结构." 在看本文之前,可以先进行一下回顾,之前已经对协议的框架进行了整体的介绍: 连信协议整体框架 ...
最新文章
- linux下ELK搭建好之后配置sentinl插件,进行邮件告警
- Javascript(6)
- scikit-learn实现ebay数据分析 的随笔
- linux一直用户身份验证失败,linux – chsh:PAM身份验证失败
- 21 个非常有用的 .htaccess 提示和技巧
- 程序员看过来:阿里毕玄提升代码能力的4段经历
- 加勒比海兔_加勒比海海洋物种趋势
- 结对项目开发-电梯调度
- 那些不是秘密的微信earning方法
- 以太坊Bloom过滤器实现原理及应用场景分析
- ScheduledThreadPoolExecutor部分源码学习
- 苹果智能拨号软件_iPhone智能性升级 多功能通话辅助软件
- vue项目使用SockJS插件实现webSocket通信
- 基于RS的沈阳土地利用情况
- 初中英语多词性单词怎么办_初中英语单词按词性分类表
- 【Linux】域名解析
- Android 内外边距
- 教程┊解决使用USB键盘进行游戏后按任意键出现蓝屏的错误
- 太少的相濡以沫,太多的相忘江湖
- Tencent login函数登录成功后无法成功回传数据(无法返回回调方法) Android qq授权登录
热门文章
- CCF-GAIR人工智能峰会感悟
- [IOS]如何让手上的 iPhone 或 iPad 进入 DFU 或 Recovery 模式
- 在哪可以下载到免费的PPT模板?(直接可以下载的那种)
- #特辑# 统计字符串中出现次数最多的字符是哪个,并且出现了出现了几次 。
- uboot显示logo的方式
- 微信小游戏开发技术与应用
- 如何防止别人恶意攻击调用API接口
- 理解I/O:随机和顺序
- 用matlab画出一元二次的图,MATLAB 一元二次函数的画图.doc
- linux编译运行uart,嵌入式Linux裸机开发(七)——UART串口通信