Go语言代码生成protoc插件_Golang自定义代码生成器开发

阿芳吖_2457

阿芳吖_2457

2026-06-01

591人浏览

原创

必须使用protogen.options.run,因其封装了codegeneratorrequest解析、parameter校验、supported_features设置及文件过滤逻辑;跳过会导致漏文件、重复写入或自定义选项失效。

go语言代码生成protoc插件_golang自定义代码生成器开发

能直接复用 protogen.Plugin,不用从零解析 CodeGeneratorRequest;但必须理解插件启动时的生命周期和文件过滤逻辑,否则生成的代码会漏文件或重复写入。

为什么不能跳过 protogen.Options.Run 直接读 stdin

Protobuf 插件协议要求插件必须按标准流程响应:接收 CodeGeneratorRequest、校验参数、返回 CodeGeneratorResponse。手动读 stdin 写 stdout 容易出错,比如:

  • 忽略 parameter 字段导致自定义选项(如 --myplugin_opt=xxx)无法传入
  • 没处理 supported_features,导致 proto3 optional 字段生成失败
  • 未正确设置 gen.Files 的 Generate 标志,使部分 .proto 被跳过
  • 忘记调用 gen.SupportedFeatures = uint64(...),触发 protoc 报错 Feature not supported

官方 protogen 包已封装好这些细节,protogen.Options.Run 是唯一推荐入口。

generateFile 里怎么拿到服务/方法/字段的扩展信息

扩展信息(如 (myapi.http_get) = "/v1/users")不是默认加载的,必须显式启用依赖描述符并解析。关键步骤是:

  • 在 protogen.Options 初始化时传入 protogen.Option{ImportPath: "google.golang.org/protobuf/types/descriptorpb"}(如果要用 descriptorpb 类型)
  • 确保 .proto 文件 import 了定义扩展的 .proto,例如 import "myapi/options.proto";
  • 在 generateFile 中对每个 *protogen.Service 调用 service.Desc.Options().(*descriptorpb.ServiceOptions),再用 proto.GetExtension 提取值
  • 字段级扩展需遍历 field.Desc.Options(),注意 field.Desc 返回的是 protoreflect.FieldDescriptor,不是 protogen.Field

漏掉 import 或类型断言失败会导致 panic,建议用 proto.HasExtension 先判断。

Golang Uber Dig
Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器,提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象,支持命名依赖等

下载

--myplugin_out=. 生成路径和包名怎么控制

输出路径由 --myplugin_out 后的参数决定,但最终文件写入位置和 Go 包声明受两个因素控制:

  • file.GoPkg.Path 决定生成文件的 package xxx 声明,它来自 .proto 中的 go_package 选项;没设则 fallback 到 file.Desc.Path()(即 .proto 文件路径)
  • file.GeneratedFilename 默认是 file.GoPkg.Path + ".myplugin.go",但可通过 gen.NewGeneratedFile(filename, file.GoPkg) 覆盖
  • 若想让生成文件和 .proto 同目录(如 user.proto → user.myplugin.go),需用 filepath.Base(file.Desc.Path()) 拼接,并确保 go_package 正确指向该目录的模块路径
  • 错误配置会导致 import "xxx" not found 或编译器报 package xxx; expected xxx

别硬编码路径拼接,优先用 file.GoPkg 和 gen.NewGeneratedFile 组合,这是唯一能与 Go Modules 兼容的方式。

调试插件时 stderr 不显示、生成文件为空的常见原因

protoc 运行插件时会捕获 stderr 并吞掉,除非插件进程 panic 或 exit code 非 0。空文件通常意味着:

  • gen.Files 循环里没调用 gen.NewGeneratedFile,或调用后没写内容(g.P(...) 必须执行)
  • file.Generate 为 false,常见于 .proto 文件没被 protoc 显式指定(如只写了 protoc --myplugin_out=. a.proto,但 a.proto import 了 b.proto,而 b.proto 不在命令行列表中)
  • 插件二进制没加可执行权限(Linux/macOS 下 chmod +x 必须)
  • Go 模块未初始化(go mod init 缺失)导致 protogen 包版本冲突,静默失败

最有效的调试方式是:先在 main 函数开头加 log.Println("plugin started"),然后用 protoc --plugin=protoc-gen-myplugin=./myplugin --myplugin_out=. a.proto 2>&1 查看原始输出——stderr 真的会被重定向到终端。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

golang go语言

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3229

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2328

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1260

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1218

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1356

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2198

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3520

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

16135

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程