首页
/ protoc-gen-gotag(PGGT):优化 Protobuf 消息结构标签的利器

protoc-gen-gotag(PGGT):优化 Protobuf 消息结构标签的利器

2024-05-20 01:29:12作者:余洋婵Anita

在软件开发中,我们经常需要为结构体添加各种类型的标签,例如 XML、SQL 或 BSON 等。protoc-gen-gotag(简称 PGGT)是一个为 Protobuf 消息生成或替换这些标签的强大插件。通过简单的命令行操作,你可以轻松地定制你的 Protobuf 代码。

项目简介

PGGT 是一个基于 Go 语言编写的 Protobuf 插件,其主要功能是为生成的 Protobuf 消息结构体添加或替换结构标签。支持多种标签语法,并提供自动化标签生成功能。安装这个工具非常简单,只需一条 go get 命令:

go get github.com/srikrsna/protoc-gen-gotag

项目技术分析

该插件的工作原理是在 Protobuf 编译之后运行,它读取已生成的消息结构并应用指定的标签。支持以下特性:

  1. Add/Replace Tags:可以向 Protobuf 结构体添加新的标签,如 GraphQL 和 XML,同时也可以替换已有的标签,如 JSON。
  2. Auto add tags on field:能够自动为消息字段添加自定义标签,通过配置可以实现多种转换规则。
  3. Add tags to XXX fields*:对 Protobuf 自动生成的 XXX* 字段添加特定标签,比如用于忽略它们在序列化中的表现。

应用场景

PGGT 在多种场景下大有用武之地:

  • 需要对 Protobuf 结构体进行 ORM 映射时,可方便地添加 SQL 查询所需的 sql 标签。
  • 对于 GraphQL API 开发,可以直接在 Protobuf 定义中添加 graphql 标签,简化接口处理。
  • 通过自动化标签添加,可以使代码更整洁,减少手动修改工作量。

项目特点

  • 易用性:仅需一行命令即可完成标签的添加和替换,无需繁琐的手动操作。
  • 灵活性:提供多种标签控制选项,可以精确地满足你的需求。
  • 自动化:自动为字段添加标签,可以根据字段名称生成不同的格式,如 snake_case、camelCase 等。
  • 兼容性:应当在 Protobuf 编译后执行,以确保不会干扰原有的生成过程。

例如,可以通过以下命令为 .proto 文件添加标签:

protoc -I /usr/local/include \
    	-I . \
    	--gotag_out=:. example/example.proto

或者自动为字段添加标签:

protoc -I /usr/local/include \
    	-I . \
    	--gotag_out=auto="form+db-as-camel":. example/example.proto

最后,值得注意的是,PGGT 应始终在 Protobuf 编译后运行,以保证正确性。

总之,protoc-gen-gotag 是一个高效且灵活的工具,可以帮助你在 Protobuf 开发过程中节省大量时间,提高代码质量。如果你在日常工作中依赖 Protobuf,那么这个项目绝对值得尝试!

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
14
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
289
828
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
485
388
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
110
195
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
58
139
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
364
37
cjoycjoy
一个高性能、可扩展、轻量、省心的仓颉Web框架。Rest, 宏路由,Json, 中间件,参数绑定与校验,文件上传下载,MCP......
Cangjie
60
7
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
977
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
96
250
CangjieMagicCangjieMagic
基于仓颉编程语言构建的 LLM Agent 开发框架,其主要特点包括:Agent DSL、支持 MCP 协议,支持模块化调用,支持任务智能规划。
Cangjie
578
41