protoplus
通用的描述文件及代码生成器及工具集
特性
-
提供比Protobuf描述文件更加友好的格式
-
支持插件架构，可以使用任何语言开发自己的协议runtime和代码生成器
-
插件信息交换使用JSON格式(Protobuf使用pb二进制格式)
描述文件格式
enum Vocation {
Monkey
Monk
Pig
}
struct PhoneNumber {
number string
type int32
}
struct Person {
name string
id int32
email string
phone PhoneNumber
voc Vocation
}
struct AddressBook {
person []Person
}
特性
-
自动生成tag序列号(base0),也可以手动指定
-
自动生成枚举序号(base0),也可以手动指定
-
类go结构体字段命名方式
-
比Protobuf更方便的导出注释内容做协议扩充
支持类型
- int32: 32位整形
- int64: 64位整形
- uint32: 无符号32位整形
- uint64: 无符号64位整形
- string: 字符串
- float32: 单精度浮点数
- float64: 双精度浮点数
- bytes: 二进制数据
- enum: int32封装
- bool: 布尔
- struct 结构体
所有类型前添加[]表示数组
编译
go get -u -v github.com/davyxu/protoplus
命令行参数
-
go_out
生成protoplus协议的go源码文件
-
pb_out
生成protobuf 3.0协议文件
-
cs_out
生成protoplus协议的C#源码文件
-
json_out
生成protoplus协议的json格式描述内容到文件
-
json
生成protoplus协议的json格式描述内容到标准输出
-
package
指定生成源码的包，C#对应命名空间
-
structbase
C#代码生成时，消息类默认基类名称
使用方法
- 生成go源码
protoplus -package=YourPackageName -go_out=YourMsg_gen.go a.proto b.proto
- 生成类型信息
默认生成的go,C#源码文件不带消息ID绑定，可以使用以下命令行输出类型后，再结合自己的生成器生成绑定代码
protoplus -json_out=YourMsg_gen.go a.proto b.proto
注意协议区别
-
文档中标注的"protoplus协议"和"Protobuf协议"为两种不同的协议
-
protoplus协议在很大程度上接近Protobuf协议,但并不是100%兼容, 也没有考虑兼容pb协议
-
go_out,cs_out等语言直接输出支持的是protoplus协议, 如需要pb协议的C#或go语言, 请使用pb_out参数输出proto文件后, 用pb的工具链生成对应语言的源码
备注
感觉不错请star, 谢谢!