{"id":15160890,"url":"https://github.com/stalomeow/protolinker","last_synced_at":"2026-01-21T01:10:03.574Z","repository":{"id":220949870,"uuid":"752615050","full_name":"stalomeow/protolinker","owner":"stalomeow","description":"Protobuf 消息分组 + 自动编号，支持 C# 和 Go","archived":false,"fork":false,"pushed_at":"2024-05-26T13:39:21.000Z","size":25,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-23T00:36:09.711Z","etag":null,"topics":["csharp","go","golang","protobuf","protocol-buffers","unity"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stalomeow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-04T11:20:33.000Z","updated_at":"2024-08-03T08:18:39.000Z","dependencies_parsed_at":"2024-02-05T11:31:01.389Z","dependency_job_id":"a5c3b48e-c89a-458a-a8d0-29bb3e5a82c8","html_url":"https://github.com/stalomeow/protolinker","commit_stats":{"total_commits":4,"total_committers":1,"mean_commits":4.0,"dds":0.0,"last_synced_commit":"05d667293c25dcf9928a5261f17cb99d8f3f91db"},"previous_names":["stalomeow/protolinker"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/stalomeow/protolinker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stalomeow%2Fprotolinker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stalomeow%2Fprotolinker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stalomeow%2Fprotolinker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stalomeow%2Fprotolinker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stalomeow","download_url":"https://codeload.github.com/stalomeow/protolinker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stalomeow%2Fprotolinker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28620576,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T23:49:58.628Z","status":"ssl_error","status_checked_at":"2026-01-20T23:47:29.996Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","go","golang","protobuf","protocol-buffers","unity"],"created_at":"2024-09-26T23:41:47.582Z","updated_at":"2026-01-21T01:10:03.547Z","avatar_url":"https://github.com/stalomeow.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# protolinker\n\nProtobuf 消息分组 + 自动编号，支持 C# 和 Go。\n\n该插件会额外生成一个 Message 汇总文件，方便根据 id 创建 Message 对象。\n\n## 安装\n\n```\ngo install github.com/stalomeow/protolinker/...@latest\n```\n\n## 配置\n\nTOML 配置文件，可以起名为 `link.toml`。\n\n``` toml\n# 配置 C# 的 Message 汇总文件\n[out.csharp]\nnamespace = \"Examples\"\nclass = \"NetMessageStore\"\nfilename = \"NetMessageStore.cs\"\ndisposable_message = false # 是否让 Message 实现 IDisposable 接口\n\n# 配置 Go 的 Message 汇总文件\n[out.go]\nimport_path = \"github.com/stalomeow/protolinker/examples\"\npackage = \"examples\"\n\n# Go 的文件名配置比较特殊，请参考下面文档中 output directory 相关内容\n# https://protobuf.dev/reference/go/go-generated/#invocation\nfilename = \"github.com/stalomeow/protolinker/examples/net_message.go\"\n\n# 第一组消息\n[[groups]]\nname = \"group/one\"\nmin = 100 # 该组消息的 uint16 id 的最小值（包含）\nmax = 300 # 该组消息的 uint16 id 的最大值（包含）\n\n# 第二组消息\n[[groups]]\nname = \"group/two\"\nmin = 400\nmax = 900\n\n# ...\n```\n\n## 分组\n\n分组信息写在 Message 的 Leading Comments 里，独占一行，格式为 `@group=\"GROUP_NAME\"`。`=` 左右不要有空格。\n\n``` protobuf\nsyntax = \"proto3\";\n\noption csharp_namespace = \"Examples\";\noption go_package = \"github.com/stalomeow/protolinker/examples\";\n\n// @group=\"group/one\"\nmessage MessageA {\n    int32 i = 1;\n}\n\n// @group=\"group/one\"\nmessage MessageB {\n    int32 i = 1;\n}\n\n// @group=\"group/two\"\nmessage MessageC {\n    int32 i = 1;\n}\n\n// @group=\"group/two\"\nmessage MessageD {\n    int32 i = 1;\n}\n```\n\n## 生成\n\nid 的分配顺序取决于：\n\n1. protoc 参数中 `.proto` 文件的顺序。\n2. `.proto` 文件中 Message 的定义顺序。\n\n如果分开调用 protoc，先生成 C# 再生成 Go 的话，需要保证上面几个顺序一致。\n\n### C#\n\n``` make\nprotoc ./*.proto -I=.        \\\n  --csharp_out=$(CSHARP_OUT) \\\n  --csharp_opt=$(CSHARP_OPT) \\\n  --cslink_out=$(CSHARP_OUT) \\\n  --cslink_opt=config=link.toml\n```\n\n- `--cslink_out`：指定输出目录。\n- `--cslink_opt`：\n\n    - `config`：配置文件的路径。\n    - `base_namespace`：同 `--csharp_opt` 里的 `base_namespace`。\n\n### Go\n\n``` make\nprotoc ./*.proto -I=.        \\\n  --go_out=$(GOLANG_OUT)     \\\n  --go_opt=$(GOLANG_OPT)     \\\n  --golink_out=$(GOLANG_OUT) \\\n  --golink_opt=$(GOLANG_OPT),config=link.toml\n```\n\n- `--golink_out`：指定输出目录。\n- `--golink_opt`：\n\n    - `config`：配置文件的路径。\n    - 所有 `--go_opt` 的参数。\n\n## 使用\n\n[examples 文件夹](examples) 中有生成的样例代码。\n\n### C#\n\n``` csharp\nvar store = new Examples.NetMessageStore();\n\n// 从某处获得 msgId、msgSize 以及 data\n\n// 过滤消息\nif (msgId \u003c store.MsgGroupMin_GroupOne || msgId \u003e store.MsgGroupMax_GroupOne)\n{\n    return;\n}\n\n// 解析消息\nMessageParser parser = store.GetMsgParserById(msgId);\nvar span = new ReadOnlySpan\u003cbyte\u003e(data, msgSize);\nIMessage msg = parser.ParseFrom(span);\n\n// 处理消息\nswitch (msgId)\n{\n    case Examples.MessageA.MsgId:\n        // ...\n        break;\n\n    case Examples.MessageB.MsgId:\n        // ...\n        break;\n\n    // ...\n}\n```\n\n``` csharp\n// INetMessage 是插件生成的接口\n// 它派生自 IMessage，包含了 MsgId 和 MsgName 信息\nINetMessage msg = new Examples.MessageA();\n\n// 消息长度\nint msgSize = msg.CalculateSize();\n\n// 消息 id\nushort msgId = msg.MsgId;\n\n// 写入消息\nmsg.WriteTo(span);\n```\n\n### Go\n\n``` go\n// 从某处获得 msgId、msgSize 以及 data\n\n// 过滤消息\nif msgId \u003c examples.MsgGroupMin_GroupOne || msgId \u003e examples.MsgGroupMax_GroupOne {\n    return\n}\n\n// 解析消息\nmsg, err := examples.NewMsgById(msgId)\nif err != nil {\n    panic(err)\n}\nerr = pb.Unmarshal(data[:msgSize], msg)\nif err != nil {\n    panic(err)\n}\n\n// 处理消息\nswitch msgId {\ncase examples.MessageA_MsgId:\n    // ...\n\ncase examples.MessageB_MsgId:\n    // ...\n\n// ...\n}\n```\n\n``` go\n// NetMessage 是插件生成的接口，同 C#\nmsg := new(examples.MessageA).(examples.NetMessage)\n\n// 消息 id\nmsgId := msg.MsgId()\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstalomeow%2Fprotolinker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstalomeow%2Fprotolinker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstalomeow%2Fprotolinker/lists"}