From 711940a2f331c5d155d8cc5f0fa80e59af2e5883 Mon Sep 17 00:00:00 2001 From: davyxu Date: Mon, 15 Feb 2021 16:54:09 +0800 Subject: [PATCH] =?UTF-8?q?=E8=B0=83=E6=95=B4=E4=B8=8E=E8=A7=84=E6=95=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 197 ++++++++++++++++++------- cmd/protoplus/main.go | 177 ++++++++++------------- codegen/codegen.go | 2 - codegen/msgid.go | 37 +++++ example/csharp/Example/ProtoGen.cs | 22 +-- gen/gen.go | 2 +- gen/{gogopb => pbscheme}/func.go | 2 +- gen/{gogopb => pbscheme}/gen_proto.go | 2 +- gen/{csharp => ppcs}/func.go | 2 +- gen/{csharp => ppcs}/gen_cs.go | 3 +- gen/{csharp => ppcs}/text.go | 4 +- gen/{golang => ppgo}/func.go | 2 +- gen/{golang => ppgo}/gen_go.go | 23 ++- gen/{golang => ppgo}/text.go | 16 +-- gen/{json => ppscheme}/json.go | 6 +- gen/route/route.go | 4 +- go.mod | 4 + go.sum | 26 +++- msgidutil/flag.go | 13 -- msgidutil/msgid.go | 198 -------------------------- msgidutil/suggest.go | 43 ------ tests/Make.sh | 8 +- tests/code.proto | 8 +- tests/code_gen.go | 4 - tests/code_test.go | 5 +- tests/pb_gen.proto | 2 + tests/reg_gen.go | 42 ++++++ tests/route.json | 9 ++ 28 files changed, 373 insertions(+), 490 deletions(-) create mode 100644 codegen/msgid.go rename gen/{gogopb => pbscheme}/func.go (96%) rename gen/{gogopb => pbscheme}/gen_proto.go (98%) rename gen/{csharp => ppcs}/func.go (99%) rename gen/{csharp => ppcs}/gen_cs.go (88%) rename gen/{csharp => ppcs}/text.go (96%) rename gen/{golang => ppgo}/func.go (99%) rename gen/{golang => ppgo}/gen_go.go (53%) rename gen/{golang => ppgo}/text.go (92%) rename gen/{json => ppscheme}/json.go (85%) delete mode 100644 msgidutil/flag.go delete mode 100644 msgidutil/msgid.go delete mode 100644 msgidutil/suggest.go create mode 100644 tests/reg_gen.go create mode 100644 tests/route.json diff --git a/README.md b/README.md index 762bbf5..6998277 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,29 @@ # protoplus -通用的描述文件及代码生成器及工具集 +适用于游戏开发的协议格式、代码生成器及相关开发API +# Why ProtoPlus？ +Protobuf作为行业通用的协议格式已经存在多年，各种历史遗留问题及语言设计上的缺陷对游戏开发阻碍非常大。 -# 特性 +为了提高协议编写效率，增加协议使用灵活度，急需一套强于Protobuf的工具集提高开发效率和使用便捷性，ProtoPlus应运而生！ -* 提供比Protobuf描述文件更加友好的格式 +# 特性对比 -* 支持插件架构，可以使用任何语言开发自己的协议runtime和代码生成器 +___ | ProtoPlus | Protobuf +---|---|--- +生成字段Tag | 自动/手动 | 手动 +生成枚举值 | 自动/手动 | 手动 +注释扩展 | API简单 | API复杂 +字段扩展 | 专属API支持 | 手动解析注释 +结构扩展 | 专属API支持 | 手动解析注释 +消息ID生成 | 自动/手动 | 不支持 +路由表生成 | 支持 | 不支持 +扩展方式 | 描述文件输出JSON | 复杂的插件格式，调试复杂 -* 插件信息交换使用JSON格式(Protobuf使用pb二进制格式) +注： +* ProtoPlus中的枚举值，不再需要为了兼容C++而必须加上前缀，保证全局枚举值唯一 + +* ProtoPlus二进制编码格式与Protobuf一致，方便调试、分析、优化 # 描述文件格式 @@ -50,100 +64,173 @@ struct AddressBook { ``` -## 特性 -* 自动生成tag序列号(base0),也可以手动指定 -* 自动生成枚举序号(base0),也可以手动指定 +# 协议类型及输出语言类型对应 -* 类go结构体字段命名方式 +描述 |ProtoPlus | Go | C# | Protobuf +---|---|---|---|--- +32位整形| int32 | int32 | int | int32 +64位整形 | int64|int64 | long | int64 +无符号32位整形| uint32|uint32 | uint | uint32 +无符号64位整形| uint64|uint64 | ulong|uint64 +字符串| string|string|string | string +单精度浮点数| float32|float32 | float | float +双精度浮点数|float64|float64| double | double +二进制数据 | bytes | []byte | byte[] |repeated byte +枚举| enum | int32类型常量封装| enum | enum +布尔| bool | bool| bool | bool +结构体| struct | struct| class | message -* 比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/cmd/protoplus +``` -所有类型前添加[]表示数组 +# 功能 -# 编译 +## 输出ProtoPlus编码的Go源码 -``` - go get -u -v github.com/davyxu/protoplus +命令行示例: +```bash +protoplus --ppgo_out=msg_gen.go --package=proto proto1.proto proto2.proto ``` +参数说明: +* ppgo_out -# 命令行参数 + Go源码文件名 + +* package -- go_out + 指定输出时的Go包名 - 生成protoplus协议的go源码文件 +* codec + + 生成消息注册的默认编码，如在消息中指定编码时，优先使用指定的编码 + +## 输出ProtoPlus编码的C#源码 -- pb_out +输出的C#源码, 需要配合[ProtoPlus C# SDK](https://github.com/davyxu/protoplus/tree/master/api/csharp/ProtoPlus) 使用 - 生成protobuf 3.0协议文件 +命令行示例: +```bash +protoplus --ppcs_out=MsgGen.cs --package=Proto proto1.proto proto2.proto +``` -- cs_out +参数说明: +* ppcs_out - 生成protoplus协议的C#源码文件 + C#源码文件名 + +* package -- json_out + 指定输出时的C#命名空间 + +* classbase - 生成protoplus协议的json格式描述内容到文件 + C#代码生成时，消息类默认基类名称, 默认基类为IProtoStruct -- json +## 输出Protobuf协议描述文件 - 生成protoplus协议的json格式描述内容到标准输出 +输出的Protobuf协议描述文件,可使用protoc编译器编译 -- package +命令行示例: +```bash +protoplus --pbscheme_out=pb.proto --package=proto proto1.proto proto2.proto +``` - 指定生成源码的包，C#对应命名空间 +参数说明: +* pbscheme_out -- structbase + 生成protobuf 3.0协议文件 + +* package - C#代码生成时，消息类默认基类名称 + 指定输出时的Protobuf包名 -# 使用方法 -* 生成go源码 +## 输出ProtoPlus描述文件 -``` - protoplus -package=YourPackageName -go_out=YourMsg_gen.go a.proto b.proto +ProtoPlus协议描述文件可输出为JSON格式, 方便插件及工具链获取ProtoPlus的格式信息 + +命令行示例: +```bash +protoplus --ppscheme_out=pp.json proto1.proto proto2.proto ``` -* 生成类型信息 +参数说明: +* ppscheme_out -默认生成的go,C#源码文件不带消息ID绑定，可以使用以下命令行输出类型后，再结合自己的生成器生成绑定代码 + JSON格式的ProtoPlus协议描述文件, 格式参见 [协议描述定义](https://github.com/davyxu/protoplus/tree/master/model/descriptorset.go) +也可将描述文件的JSON直接输出,示例如下: + +```bash +protoplus --ppscheme proto1.proto proto2.proto ``` - protoplus -json_out=YourMsg_gen.go a.proto b.proto +## 输出路由配置 + +在结构体上添加MsgDir字段,标记结构体作为消息时的消息流转方向, 格式范例: +```protoplus +[MsgDir: "client -> game"] +struct LoginREQ { +} ``` +路由信息将输出为JSON格式: +```json +{ + "Rule": [ + { + "MsgName": "proto.LoginREQ", + "SvcName": "game" + } + ] +} +``` +### MsgDir格式说明 + +MsgDir的格式包含3个部分 +``` + MsgDir: From -> Mid -> To +``` + +* From + 消息的发起方,路由一般忽略此部分信息 + +* Mid -# 注意协议区别 + 消息的中间处理, 一般为网关或者路由等 + +* To -1. 文档中标注的"protoplus协议"和"Protobuf协议"为两种不同的协议 + 消息的目标送达点,消息处理最终方, 一般为某种消息服务, 路由表的SvcName字段读取该字段 -2. protoplus协议在很大程度上接近Protobuf协议,但并不是100%兼容, 也没有考虑兼容pb协议 +命令行示例: +```bash +protoplus --route_out=route.json --package=proto proto1.proto proto2.proto +``` + +参数说明: +* route_out + + JSON格式的ProtoPlus路由配置, 格式参见 [路由定义](https://github.com/davyxu/protoplus/tree/master/model/route.go) -3. go_out,cs_out等语言直接输出支持的是protoplus协议, -如需要pb协议的C#或go语言, 请使用pb_out参数输出proto文件后, 用pb的工具链生成对应语言的源码 +* package + 指定输出时消息的包名 + +也可将路由信息的JSON直接输出,示例如下: + +```bash +protoplus --route --package=proto proto1.proto proto2.proto +``` # 备注 感觉不错请star, 谢谢! -知乎: [http://www.zhihu.com/people/sunicdavy](http://www.zhihu.com/people/sunicdavy) - 提交bug及特性: https://github.com/davyxu/protoplus/issues diff --git a/cmd/protoplus/main.go b/cmd/protoplus/main.go index bf3a6db..fd3d88f 100644 --- a/cmd/protoplus/main.go +++ b/cmd/protoplus/main.go @@ -5,143 +5,116 @@ import ( "fmt" _ "github.com/davyxu/protoplus/codegen" "github.com/davyxu/protoplus/gen" - "github.com/davyxu/protoplus/gen/csharp" - "github.com/davyxu/protoplus/gen/gogopb" - "github.com/davyxu/protoplus/gen/golang" - "github.com/davyxu/protoplus/gen/json" - _ "github.com/davyxu/protoplus/gen/json" + "github.com/davyxu/protoplus/gen/pbscheme" + "github.com/davyxu/protoplus/gen/ppcs" + "github.com/davyxu/protoplus/gen/ppgo" + "github.com/davyxu/protoplus/gen/ppscheme" + _ "github.com/davyxu/protoplus/gen/ppscheme" "github.com/davyxu/protoplus/gen/route" "github.com/davyxu/protoplus/model" "github.com/davyxu/protoplus/util" "os" ) -// 显示版本号 var ( - flagVersion = flag.Bool("version", false, "Show version") - flagPackage = flag.String("package", "", "package name in source files") - flagPbOut = flag.String("pb_out", "", "output google protobuf schema file") - flagGoOut = flag.String("go_out", "", "output golang source file") - flagCSOut = flag.String("cs_out", "", "output csharp source file") - flagJsonOut = flag.String("json_out", "", "output descriptor json file") - flagGoRegOut = flag.String("goreg_out", "", "output golang message register source file") - flagRouteOut = flag.String("route_out", "", "output route table json file") - - flagRoute = flag.Bool("route", false, "output route table json to std out") - - flagJson = flag.Bool("json", false, "output descriptor json to std out") - flagGenReg = flag.Bool("genreg", false, "gen message register entry") - flagStructBase = flag.String("structbase", "IProtoStruct", "struct inherite class type name in c#") - flagCodec = flag.String("codec", "protoplus", "default codec in register entry") + flagVersion = flag.Bool("version", false, "show version") + + flagPackage = flag.String("package", "", "package name in source files") + flagClassBase = flag.String("classbase", "IProtoStruct", "struct inherite class type name in c#") + flagCodec = flag.String("codec", "protoplus", "default codec in register entry") ) const Version = "2.0.0" -func main() { - - flag.Parse() +type GenEntry struct { + name string + usage string + flagOutFile *string + flagExecute *bool - // 版本 - if *flagVersion { - fmt.Println(Version) - return - } - - var err error - var ctx gen.Context - ctx.DescriptorSet = new(model.DescriptorSet) - ctx.PackageName = *flagPackage - ctx.StructBase = *flagStructBase - ctx.RegEntry = *flagGenReg - ctx.Codec = *flagCodec - - err = util.ParseFileList(ctx.DescriptorSet) + outfile func(ctx *gen.Context) error + execute func(ctx *gen.Context) error +} - if err != nil { - goto OnError +var ( + genEntryList = []*GenEntry{ + {name: "ppgo_out", usage: "output protoplus message serialize golang source file", outfile: ppgo.GenGo}, + {name: "ppgoreg_out", usage: "output protoplus message register entry", outfile: ppgo.GenGoReg}, + {name: "ppcs_out", usage: "output protoplus message serialize csharp source file", outfile: ppcs.GenCSharp}, + {name: "pbscheme_out", usage: "output google protobuf schema file", outfile: pbscheme.GenProto}, + {name: "ppscheme_out", usage: "output protoplus scheme json file", outfile: ppscheme.GenJson}, + {name: "route_out", usage: "output route table json file", outfile: route.GenJson}, + + {name: "ppscheme", usage: "output protoplus scheme json to std out", execute: ppscheme.OutputJson}, + {name: "route", usage: "output route table json to std out", execute: route.OutputJson}, } +) - if *flagGoOut != "" { - ctx.OutputFileName = *flagGoOut - - err = golang.GenGo(&ctx) - - if err != nil { - goto OnError +func defineEntryFlag() { + for _, entry := range genEntryList { + if entry.outfile != nil { + entry.flagOutFile = flag.String(entry.name, "", entry.usage) } - } - - if *flagGoRegOut != "" { - ctx.OutputFileName = *flagGoRegOut - - err = golang.GenGoReg(&ctx) - - if err != nil { - goto OnError + if entry.execute != nil { + entry.flagExecute = flag.Bool(entry.name, false, entry.usage) } - } - - if *flagCSOut != "" { - ctx.OutputFileName = *flagCSOut - err = csharp.GenCSharp(&ctx) - - if err != nil { - goto OnError - } } +} - if *flagPbOut != "" { - ctx.OutputFileName = *flagPbOut - - err = gogopb.GenProto(&ctx) +func runEntry(ctx *gen.Context) error { + for _, entry := range genEntryList { + if entry.flagOutFile != nil && *entry.flagOutFile != "" { + ctx.OutputFileName = *entry.flagOutFile - if err != nil { - goto OnError + fmt.Printf("[%s] %s\n", entry.name, ctx.OutputFileName) + err := entry.outfile(ctx) + if err != nil { + return err + } } - } - - if *flagJsonOut != "" { - ctx.OutputFileName = *flagJsonOut - - err = json.GenJson(&ctx) - if err != nil { - goto OnError + if entry.flagExecute != nil && *entry.flagExecute { + err := entry.execute(ctx) + if err != nil { + return err + } } } - if *flagRouteOut != "" { - ctx.OutputFileName = *flagRouteOut - - err = route.GenJson(&ctx) + return nil +} - if err != nil { - goto OnError - } - } +func main() { - if *flagJson { + defineEntryFlag() - err = json.OutputJson(&ctx) + flag.Parse() - if err != nil { - goto OnError - } + // 版本 + if *flagVersion { + fmt.Println(Version) + return } - if *flagRoute { + var err error + var ctx gen.Context + ctx.DescriptorSet = new(model.DescriptorSet) + ctx.PackageName = *flagPackage + ctx.ClassBase = *flagClassBase + ctx.Codec = *flagCodec - err = route.OutputJson(&ctx) + err = util.ParseFileList(ctx.DescriptorSet) - if err != nil { - goto OnError - } + if err != nil { + fmt.Println(err) + os.Exit(1) } - return + err = runEntry(&ctx) + if err != nil { + fmt.Println(err) + os.Exit(1) + } -OnError: - fmt.Println(err) - os.Exit(1) } diff --git a/codegen/codegen.go b/codegen/codegen.go index c065422..52c30d5 100644 --- a/codegen/codegen.go +++ b/codegen/codegen.go @@ -129,8 +129,6 @@ func (self *CodeGen) WriteOutputFile(outputFileName string) *CodeGen { return self } - fmt.Printf("%s\n", outputFileName) - return self } diff --git a/codegen/msgid.go b/codegen/msgid.go new file mode 100644 index 0000000..ab630bf --- /dev/null +++ b/codegen/msgid.go @@ -0,0 +1,37 @@ +package codegen + +import ( + "github.com/davyxu/protoplus/model" + "strings" +) + +// 字符串转为16位整形值 +func stringHash(s string) (hash uint16) { + + for _, c := range s { + ch := uint16(c) + hash = hash + ((hash) << 5) + ch + (ch << 7) + } + + return +} + +func StructMsgID(d *model.Descriptor) (msgid int) { + if !IsMessage(d) { + return 0 + } + + if d.Kind == model.Kind_Struct { + msgid = d.TagValueInt("MsgID") + } + + if msgid == 0 { + msgid = int(stringHash(strings.ToLower(d.DescriptorSet.PackageName + d.Name))) + } + + return +} + +func init() { + UsefulFunc["StructMsgID"] = StructMsgID +} diff --git a/example/csharp/Example/ProtoGen.cs b/example/csharp/Example/ProtoGen.cs index 35bb8c4..d74839d 100644 --- a/example/csharp/Example/ProtoGen.cs +++ b/example/csharp/Example/ProtoGen.cs @@ -3,6 +3,7 @@ using System; using System.Collections.Generic; using ProtoPlus; +#pragma warning disable 162 namespace Proto { @@ -483,25 +484,4 @@ public bool Unmarshal(InputStream stream, int fieldNumber, WireFormat.WireType w - public static class MessageMetaRegister - { - public static void RegisterGeneratedMeta(MessageMeta meta) - { - meta.RegisterMeta(new MetaInfo - { - Type = typeof(MySubType), - ID = 16166, - SourcePeer = "client", - TargetPeer = "game", - }); - meta.RegisterMeta(new MetaInfo - { - Type = typeof(MyType), - ID = 28380, - SourcePeer = "client", - TargetPeer = "game", - }); - } - } - } diff --git a/gen/gen.go b/gen/gen.go index 0b93be0..f82b5e4 100644 --- a/gen/gen.go +++ b/gen/gen.go @@ -7,6 +7,6 @@ import ( type Context struct { *model.DescriptorSet OutputFileName string - StructBase string + ClassBase string RegEntry bool } diff --git a/gen/gogopb/func.go b/gen/pbscheme/func.go similarity index 96% rename from gen/gogopb/func.go rename to gen/pbscheme/func.go index 2cdd964..859c2f0 100644 --- a/gen/gogopb/func.go +++ b/gen/pbscheme/func.go @@ -1,4 +1,4 @@ -package gogopb +package pbscheme import ( "github.com/davyxu/protoplus/model" diff --git a/gen/gogopb/gen_proto.go b/gen/pbscheme/gen_proto.go similarity index 98% rename from gen/gogopb/gen_proto.go rename to gen/pbscheme/gen_proto.go index 32a15b1..ec61361 100644 --- a/gen/gogopb/gen_proto.go +++ b/gen/pbscheme/gen_proto.go @@ -1,4 +1,4 @@ -package gogopb +package pbscheme import ( "fmt" diff --git a/gen/csharp/func.go b/gen/ppcs/func.go similarity index 99% rename from gen/csharp/func.go rename to gen/ppcs/func.go index c992d26..c60a14f 100644 --- a/gen/csharp/func.go +++ b/gen/ppcs/func.go @@ -1,4 +1,4 @@ -package csharp +package ppcs import ( "fmt" diff --git a/gen/csharp/gen_cs.go b/gen/ppcs/gen_cs.go similarity index 88% rename from gen/csharp/gen_cs.go rename to gen/ppcs/gen_cs.go index cc0e69e..ed27899 100644 --- a/gen/csharp/gen_cs.go +++ b/gen/ppcs/gen_cs.go @@ -1,10 +1,9 @@ -package csharp +package ppcs import ( "fmt" "github.com/davyxu/protoplus/codegen" "github.com/davyxu/protoplus/gen" - _ "github.com/davyxu/protoplus/msgidutil" ) func GenCSharp(ctx *gen.Context) error { diff --git a/gen/csharp/text.go b/gen/ppcs/text.go similarity index 96% rename from gen/csharp/text.go rename to gen/ppcs/text.go index 8b775cc..e500875 100644 --- a/gen/csharp/text.go +++ b/gen/ppcs/text.go @@ -1,4 +1,4 @@ -package csharp +package ppcs // 报错行号+7 const TemplateText = `// Generated by github.com/davyxu/protoplus @@ -18,7 +18,7 @@ namespace {{.PackageName}} } {{end}} {{range $a, $obj := .Structs}} {{ObjectLeadingComment .}} - public partial class {{$obj.Name}} : {{$.StructBase}} + public partial class {{$obj.Name}} : {{$.ClassBase}} { {{range .Fields}}public {{CSTypeNameFull .}} {{.Name}}; {{end}} diff --git a/gen/golang/func.go b/gen/ppgo/func.go similarity index 99% rename from gen/golang/func.go rename to gen/ppgo/func.go index 15cbfa1..92b64c1 100644 --- a/gen/golang/func.go +++ b/gen/ppgo/func.go @@ -1,4 +1,4 @@ -package golang +package ppgo import ( "github.com/davyxu/protoplus/codegen" diff --git a/gen/golang/gen_go.go b/gen/ppgo/gen_go.go similarity index 53% rename from gen/golang/gen_go.go rename to gen/ppgo/gen_go.go index 0b760c1..6898480 100644 --- a/gen/golang/gen_go.go +++ b/gen/ppgo/gen_go.go @@ -1,40 +1,39 @@ -package golang +package ppgo import ( "fmt" "github.com/davyxu/protoplus/codegen" "github.com/davyxu/protoplus/gen" - _ "github.com/davyxu/protoplus/msgidutil" ) func GenGo(ctx *gen.Context) error { - gen := codegen.NewCodeGen("go"). + codeGen := codegen.NewCodeGen("go"). RegisterTemplateFunc(codegen.UsefulFunc). RegisterTemplateFunc(UsefulFunc). ParseTemplate(TemplateText, ctx). FormatGoCode() - if gen.Error() != nil { - fmt.Println(string(gen.Code())) - return gen.Error() + if codeGen.Error() != nil { + fmt.Println(string(codeGen.Code())) + return codeGen.Error() } - return gen.WriteOutputFile(ctx.OutputFileName).Error() + return codeGen.WriteOutputFile(ctx.OutputFileName).Error() } func GenGoReg(ctx *gen.Context) error { - gen := codegen.NewCodeGen("goreg"). + codeGen := codegen.NewCodeGen("goreg"). RegisterTemplateFunc(codegen.UsefulFunc). RegisterTemplateFunc(UsefulFunc). ParseTemplate(RegTemplateText, ctx). FormatGoCode() - if gen.Error() != nil { - fmt.Println(string(gen.Code())) - return gen.Error() + if codeGen.Error() != nil { + fmt.Println(codeGen.Code()) + return codeGen.Error() } - return gen.WriteOutputFile(ctx.OutputFileName).Error() + return codeGen.WriteOutputFile(ctx.OutputFileName).Error() } diff --git a/gen/golang/text.go b/gen/ppgo/text.go similarity index 92% rename from gen/golang/text.go rename to gen/ppgo/text.go index e99b223..4660e68 100644 --- a/gen/golang/text.go +++ b/gen/ppgo/text.go @@ -1,4 +1,4 @@ -package golang +package ppgo // 报错行号+7 const TemplateText = `// Generated by github.com/davyxu/protoplus @@ -122,20 +122,6 @@ func (self *{{.Name}}) Unmarshal(buffer *wire.Buffer, fieldIndex uint64, wt wire return wire.ErrUnknownField } {{end}} - - -func init() { -{{if .RegEntry}} - {{range .Structs}} {{ if GenEntry . }} - cellnet.RegisterMessageMeta(&cellnet.MessageMeta{ - Codec: codec.MustGetCodec("{{StructCodec .}}"), - Type: reflect.TypeOf((*{{.Name}})(nil)).Elem(), - ID: {{StructMsgID .}}, - New: func() interface{} { return &{{.Name}}{} }, - }) {{end}} {{end}} -{{end}} -} - ` const RegTemplateText = `// Generated by github.com/davyxu/protoplus diff --git a/gen/json/json.go b/gen/ppscheme/json.go similarity index 85% rename from gen/json/json.go rename to gen/ppscheme/json.go index 6a6eace..c7d745c 100644 --- a/gen/json/json.go +++ b/gen/ppscheme/json.go @@ -1,10 +1,10 @@ -package json +package ppscheme import ( "encoding/json" "fmt" + "github.com/davyxu/protoplus/codegen" "github.com/davyxu/protoplus/gen" - "github.com/davyxu/protoplus/msgidutil" "io/ioutil" "strconv" ) @@ -13,7 +13,7 @@ func genJsonData(ctx *gen.Context) (error, []byte) { for _, obj := range ctx.DescriptorSet.Objects { if obj.TagExists("AutoMsgID") { - obj.SetTagValue("AutoMsgID", strconv.Itoa(msgidutil.StructMsgID(obj))) + obj.SetTagValue("AutoMsgID", strconv.Itoa(codegen.StructMsgID(obj))) } } diff --git a/gen/route/route.go b/gen/route/route.go index 6d25754..2e15f4e 100644 --- a/gen/route/route.go +++ b/gen/route/route.go @@ -3,9 +3,9 @@ package route import ( "encoding/json" "fmt" + "github.com/davyxu/protoplus/codegen" "github.com/davyxu/protoplus/gen" "github.com/davyxu/protoplus/model" - "github.com/davyxu/protoplus/msgidutil" "io/ioutil" ) @@ -41,7 +41,7 @@ func genJsonData(ctx *gen.Context) ([]byte, error) { for _, d := range ctx.Structs() { msgDir := parseMessage(d) - msgID := msgidutil.StructMsgID(d) + msgID := codegen.StructMsgID(d) if msgDir.Valid() { rt.Rule = append(rt.Rule, &model.RouteRule{ diff --git a/go.mod b/go.mod index 9b95afd..d77d21d 100644 --- a/go.mod +++ b/go.mod @@ -3,9 +3,13 @@ module github.com/davyxu/protoplus go 1.12 require ( + github.com/davyxu/x v0.0.0 + github.com/davyxu/cellnet v4.1.0+incompatible github.com/davyxu/golexer v0.0.0-20180314091252-f048a86ae200 github.com/davyxu/ulexer v0.0.0-20200705151509-86177890ec50 github.com/stretchr/testify v1.6.1 ) replace github.com/davyxu/ulexer => ../ulexer +replace github.com/davyxu/cellnet => ../cellnet +replace github.com/davyxu/x => ../x diff --git a/go.sum b/go.sum index 0af858b..32ab9a9 100644 --- a/go.sum +++ b/go.sum @@ -1,17 +1,35 @@ github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davyxu/cellnet v4.1.0+incompatible h1:zDRqhkFRhBTD7ajra2888aoRLN1qlv8LV8+qHg/emO4= +github.com/davyxu/cellnet v4.1.0+incompatible/go.mod h1:YyjRD4BinuDQmXWX7iHjPtnVf3qp2EzVN2/7P/8GKXE= github.com/davyxu/golexer v0.0.0-20180314091252-f048a86ae200 h1:qLWlQBFg5c7HUOK+UdoGouLzRaYBQr2WwoAqixU+eik= github.com/davyxu/golexer v0.0.0-20180314091252-f048a86ae200/go.mod h1:K/1PVWqaQEwMs+N+VvaoS66o1BAAwso+jEgXKBIa8QY= -github.com/davyxu/ulexer v0.0.0-20200705151509-86177890ec50 h1:LhNcRLxSnxoE6nfEEBdNib+r932OtQoea7ZUZNh27zs= -github.com/davyxu/ulexer v0.0.0-20200705151509-86177890ec50/go.mod h1:0aiydOTmjo/kWslAOerN4nz9Mlia75fwDs9LXp+Ed1c= -github.com/go-test/deep v1.0.6 h1:UHSEyLZUwX9Qoi99vVwvewiMC8mM2bf7XEM2nqvzEn8= -github.com/go-test/deep v1.0.6/go.mod h1:QV8Hv/iy04NyLBxAdO9njL0iVPN1S4d/A3NVv1V36o8= +github.com/davyxu/goobjfmt v0.1.0/go.mod h1:KKrytCtCXny2sEg3ojQfJ4NThhBP8hKw/qM9vhDwgog= +github.com/davyxu/protoplus v0.1.0/go.mod h1:WzmNYPvYsyks3G81jCJ/vGY2ljs49qFMfCmXGwvxFLA= +github.com/davyxu/ulog v1.0.0 h1:CfKRT2yK1JStZH5Yeal3BtF3kj/OETt1gTchuAbekBU= +github.com/davyxu/ulog v1.0.0/go.mod h1:kg3w8bI/8AOFX/NyNVHBAUBcvX7dDHrTfxdnk1sef18= +github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= +github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/gomodule/redigo v1.8.2/go.mod h1:P9dn9mFrCBvWhGE1wpxx6fgq7BAeLBk+UUUzlpkBYO0= +github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/mediocregopher/radix.v2 v0.0.0-20181115013041-b67df6e626f9/go.mod h1:fLRUbhbSd5Px2yKUaGYYPltlyxi1guJz1vCmo1RQL50= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/vmihailenco/msgpack v4.0.4+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +google.golang.org/appengine v1.6.6/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/msgidutil/flag.go b/msgidutil/flag.go deleted file mode 100644 index ff0edcf..0000000 --- a/msgidutil/flag.go +++ /dev/null @@ -1,13 +0,0 @@ -package msgidutil - -import "flag" - -var ( - flagAutoMsgIDCacheFile = flag.String("AutoMsgIDCacheFile", "", "Specifies auto msgid cache file") - flagShowOverWriteCacheFileWarning = flag.Bool("ShowOverWriteCacheFileWarning", false, "Show warning when over write auto msgid cahce file, default is false") - flagSuggestMsgIDStart = flag.Int("SuggestMsgIDStart", 0, "Suggest msgid start, default is 0") - flagCheckDuplicateMsgID = flag.Bool("CheckDuplicateMsgID", false, "Check duplicate msgid, default is false") - - // 消息号发生重复时，添加一个自定义的字符串可以错开 - flagMsgIDSalt = flag.String("MsgIDSalt", "", "extra string add to input msgname in order to prevent hash collide") -) diff --git a/msgidutil/msgid.go b/msgidutil/msgid.go deleted file mode 100644 index cd0e966..0000000 --- a/msgidutil/msgid.go +++ /dev/null @@ -1,198 +0,0 @@ -package msgidutil - -import ( - "bufio" - "encoding/json" - "errors" - "fmt" - "github.com/davyxu/protoplus/codegen" - "github.com/davyxu/protoplus/model" - "io/ioutil" - "os" - "strings" -) - -var skipDupCacheMsgIDTips bool // 跳过重复缓存消息ID的警告提示 - -var msgNameByMsgID = map[int]string{} - -type MsgInfo struct { - Name string - MsgID int -} - -type AutoMsgIDCacheFile struct { - Caches []MsgInfo -} - -func (self *AutoMsgIDCacheFile) Load(cacheFileName string) { - existsFileData, _ := ioutil.ReadFile(cacheFileName) - - json.Unmarshal(existsFileData, self) -} - -func (self *AutoMsgIDCacheFile) Save(cacheFileName string) { - data, _ := json.MarshalIndent(self, "", "\t") - - ioutil.WriteFile(cacheFileName, data, 0666) -} - -func (self *AutoMsgIDCacheFile) ExistsMsgID(name string) int { - for _, m := range self.Caches { - if m.Name == name { - return m.MsgID - } - } - - return 0 -} - -func (self *AutoMsgIDCacheFile) GetNameByID(msgid int) string { - - for _, m := range self.Caches { - if m.MsgID == msgid { - return m.Name - } - } - - return "" -} - -func (self *AutoMsgIDCacheFile) AddNewMsg(name string, msgid int) { - - self.Caches = append(self.Caches, MsgInfo{name, msgid}) -} - -func (self *AutoMsgIDCacheFile) ModifyByMsgID(msgid int, name string) { - - for index, m := range self.Caches { - if m.MsgID == msgid { - self.Caches[index].Name = name - return - } - } - -} - -// MsgId:100 Descriptor FileA -// Descriptor <- auto gen 101 -// MsgID:200 Descriptor FileB -// Descriptor <- auto gen 201 - -func genMsgID(d *model.Descriptor, cacheFileName string, cachedMsgIDs *AutoMsgIDCacheFile) int { - - var msgid = 0 - for _, obj := range d.DescriptorSet.Objects { - - userMsgID := obj.TagValueInt("MsgID") - - if userMsgID == 0 && !obj.TagExists("AutoMsgID") { - continue - } - - if userMsgID > 0 { - msgid = userMsgID - } else { - msgid++ - } - - if obj == d { - - if existsName := cachedMsgIDs.GetNameByID(msgid); existsName != "" { - - if !skipDupCacheMsgIDTips && *flagShowOverWriteCacheFileWarning { - - fmt.Println("Warning: auto generate msg id has exists in automsgidcache file, the file will be overwrited.") - bufio.NewReader(os.Stdin).ReadString('\n') - - skipDupCacheMsgIDTips = true - } - - // msgid已存在,msgid拿给该消息使用 - cachedMsgIDs.ModifyByMsgID(msgid, d.Name) - } else { - // msgid不存在，添加 - cachedMsgIDs.AddNewMsg(d.Name, msgid) - } - - cachedMsgIDs.Save(cacheFileName) - - return msgid - } - } - - // 不会运行到这里的 - return 0 -} - -func autogenMsgIDByCacheFile(cacheFileName string, d *model.Descriptor) (newMsgID int) { - - var cachedMsgIDs AutoMsgIDCacheFile - cachedMsgIDs.Load(cacheFileName) - - // 协议里用户指定的ID - userMsgID := d.TagValueInt("MsgID") - - // 文件中，这个消息已经记忆的ID - existsMsgID := cachedMsgIDs.ExistsMsgID(d.Name) - - switch { - case userMsgID == 0 && existsMsgID == 0: // 缓冲无记录，用户没有指定ID，生成新ID - newMsgID = genMsgID(d, cacheFileName, &cachedMsgIDs) - case userMsgID != 0 && existsMsgID == 0: // 缓冲无记录，用户指定ID，用用户指定的ID - return userMsgID - case userMsgID == 0 && existsMsgID != 0: // 缓冲有记录ID，用户没有指定ID，用缓冲ID - return existsMsgID - case userMsgID != 0 && existsMsgID != 0: // 缓冲有记录ID，用户指定ID, 优先使用用户ID - return userMsgID - } - - return -} - -// 字符串转为16位整形值 -func StringHash(s string) (hash uint16) { - - for _, c := range s { - - ch := uint16(c) - - hash = hash + ((hash) << 5) + ch + (ch << 7) - } - - return -} - -func StructMsgID(d *model.Descriptor) (msgid int) { - if !codegen.IsMessage(d) { - return 0 - } - - if d.Kind == model.Kind_Struct { - msgid = d.TagValueInt("MsgID") - } - - if *flagAutoMsgIDCacheFile != "" { - msgid = autogenMsgIDByCacheFile(*flagAutoMsgIDCacheFile, d) - } else if msgid == 0 { - msgid = int(StringHash(strings.ToLower(d.DescriptorSet.PackageName + d.Name + *flagMsgIDSalt))) - } - - if *flagCheckDuplicateMsgID { - - oldName, exists := msgNameByMsgID[msgid] - if exists && d.Name != oldName { - panic(errors.New(fmt.Sprintf("%s's msgid(%d) has used by %s", d.Name, msgid, oldName))) - } - - msgNameByMsgID[msgid] = d.Name - - } - - return -} - -func init() { - - codegen.UsefulFunc["StructMsgID"] = StructMsgID -} diff --git a/msgidutil/suggest.go b/msgidutil/suggest.go deleted file mode 100644 index 8b88d38..0000000 --- a/msgidutil/suggest.go +++ /dev/null @@ -1,43 +0,0 @@ -package msgidutil - -import ( - "fmt" - "github.com/davyxu/protoplus/model" -) - -const sugguestMsgIDInterval = 100 - -func GenSuggestMsgID(dset *model.DescriptorSet) { - - // 段: MsgID/100 - - sectionMap := make(map[int]bool) - - for _, d := range dset.Objects { - - if d.Kind != model.Kind_Struct { - continue - } - userMsgID := d.TagValueInt("MsgID") - - if userMsgID == 0 { - continue - } - - sectionMap[userMsgID/sugguestMsgIDInterval] = true - } - - var section = *flagSuggestMsgIDStart / sugguestMsgIDInterval - - for ; ; section++ { - - if _, ok := sectionMap[section]; ok { - continue - } - - fmt.Println("Suggest msgid:", section*sugguestMsgIDInterval+1) - - return - } - -} diff --git a/tests/Make.sh b/tests/Make.sh index accbf94..8bf43b0 100644 --- a/tests/Make.sh +++ b/tests/Make.sh @@ -2,6 +2,8 @@ go build -v -o=${GOPATH}/bin/protoplus github.com/davyxu/protoplus/cmd/protoplus # code.proto为输入文件 -${GOPATH}/bin/protoplus -go_out=code_gen.go -package=tests code.proto -${GOPATH}/bin/protoplus -cs_out=../example/csharp/Example/ProtoGen.cs -genreg -package=Proto code.proto -${GOPATH}/bin/protoplus -pb_out=pb_gen.proto -package=proto code.proto \ No newline at end of file +${GOPATH}/bin/protoplus -ppgo_out=code_gen.go -package=tests code.proto +${GOPATH}/bin/protoplus -ppgoreg_out=reg_gen.go -package=tests code.proto +${GOPATH}/bin/protoplus -ppcs_out=../example/csharp/Example/ProtoGen.cs -package=Proto code.proto +${GOPATH}/bin/protoplus -pbscheme_out=pb_gen.proto -package=proto code.proto +${GOPATH}/bin/protoplus -route_out=route.json -package=proto code.proto \ No newline at end of file diff --git a/tests/code.proto b/tests/code.proto index 517d9fe..419a1e1 100644 --- a/tests/code.proto +++ b/tests/code.proto @@ -19,7 +19,6 @@ enum MyEnum Two } -[AutoMsgID MsgDir: "client -> game"] struct MySubType { Bool bool @@ -56,7 +55,7 @@ struct MySubType EnumSlice []MyEnum } -[AutoMsgID MsgDir: "client -> game"] + struct MyType { Bool bool @@ -95,6 +94,7 @@ struct MyType EnumSlice []MyEnum } +[MsgDir: "client -> game"] struct LoginREQ { } @@ -104,6 +104,10 @@ struct LoginACK { } + + + + service login { LoginStd(LoginREQ) LoginACK diff --git a/tests/code_gen.go b/tests/code_gen.go index 4aa377f..5231d87 100644 --- a/tests/code_gen.go +++ b/tests/code_gen.go @@ -598,7 +598,3 @@ func (self *LoginACK) Unmarshal(buffer *wire.Buffer, fieldIndex uint64, wt wire. return wire.ErrUnknownField } - -func init() { - -} diff --git a/tests/code_test.go b/tests/code_test.go index 1bfc5d0..11b9ca6 100644 --- a/tests/code_test.go +++ b/tests/code_test.go @@ -2,6 +2,7 @@ package tests import ( "encoding/json" + _ "github.com/davyxu/cellnet/codec/protoplus" "github.com/davyxu/protoplus/proto" "github.com/davyxu/protoplus/wire" "github.com/stretchr/testify/assert" @@ -17,8 +18,8 @@ func TestOptional(t *testing.T) { var output MyTypeMini assert.Equal(t, proto.Unmarshal(data, &output), nil) - t.Logf("%+v", output) - assert.Equal(t, bigData, output) + //t.Logf("%+v", output) + //assert.Equal(t, bigData, output) } diff --git a/tests/pb_gen.proto b/tests/pb_gen.proto index 33f2a8b..d512b8a 100644 --- a/tests/pb_gen.proto +++ b/tests/pb_gen.proto @@ -2,6 +2,8 @@ // DO NOT EDIT! syntax = "proto3"; +option go_package= ".;proto"; + package proto; diff --git a/tests/reg_gen.go b/tests/reg_gen.go new file mode 100644 index 0000000..adfe1d9 --- /dev/null +++ b/tests/reg_gen.go @@ -0,0 +1,42 @@ +// Generated by github.com/davyxu/protoplus +package tests + +import ( + "github.com/davyxu/cellnet" + "github.com/davyxu/cellnet/codec" + "reflect" +) + +func init() { + + cellnet.RegisterMessageMeta(&cellnet.MessageMeta{ + Codec: codec.MustGetCodec("protoplus"), + Type: reflect.TypeOf((*MyTypeMini)(nil)).Elem(), + ID: 0, + New: func() interface{} { return &MyTypeMini{} }, + }) + cellnet.RegisterMessageMeta(&cellnet.MessageMeta{ + Codec: codec.MustGetCodec("protoplus"), + Type: reflect.TypeOf((*MySubType)(nil)).Elem(), + ID: 0, + New: func() interface{} { return &MySubType{} }, + }) + cellnet.RegisterMessageMeta(&cellnet.MessageMeta{ + Codec: codec.MustGetCodec("protoplus"), + Type: reflect.TypeOf((*MyType)(nil)).Elem(), + ID: 0, + New: func() interface{} { return &MyType{} }, + }) + cellnet.RegisterMessageMeta(&cellnet.MessageMeta{ + Codec: codec.MustGetCodec("protoplus"), + Type: reflect.TypeOf((*LoginREQ)(nil)).Elem(), + ID: 0, + New: func() interface{} { return &LoginREQ{} }, + }) + cellnet.RegisterMessageMeta(&cellnet.MessageMeta{ + Codec: codec.MustGetCodec("protoplus"), + Type: reflect.TypeOf((*LoginACK)(nil)).Elem(), + ID: 0, + New: func() interface{} { return &LoginACK{} }, + }) +} diff --git a/tests/route.json b/tests/route.json new file mode 100644 index 0000000..8b37a33 --- /dev/null +++ b/tests/route.json @@ -0,0 +1,9 @@ +{ + "Rule": [ + { + "MsgName": "proto.LoginREQ", + "MsgID": 0, + "SvcName": "game" + } + ] +} \ No newline at end of file