protoc 插件开发

2022-10-28 本文已影响0人周群力

1. 原理

protoc 从proto文件中抠出来结构化的数据，然后以子进程的方式启动插件，调插件、把结构化数据传给插件，让插件做生成，然后 protoc 主进程把生成的内容写进文件里
https://www.hitzhangjie.pro/blog/2017-05-23-protoc%E5%8F%8A%E6%8F%92%E4%BB%B6%E5%B7%A5%E4%BD%9C%E5%8E%9F%E7%90%86%E5%88%86%E6%9E%90%E7%B2%BE%E5%8D%8E%E7%89%88

Q: 如何告诉 protoc 用什么插件
把插件编译好放进 path, 然后在运行 protoc 的时候带上命令行参数 –${NAME}_out, protoc 就会尝试运行该插件

image.png

再比如根据 service 生成 gRPC相关代码:

image.png

Q: gRPC 生成时，用的什么模板、传了什么struct 给模板
A: 没用模板文件，直接用代码命令式的拼字符串

比如，先生成一个 interface, 作为供开发者实现的 ”component interface“, 或者叫 "handler interface":

image.png

不过 component interface 里用到的 struct 还是 pb.go 里的struct，没有和 pb 解耦

生成 server struct 和工厂函数:

image.png

让 server struct 实现 http api 里的每个 method，并且生成实现逻辑，即先检查字段，最后委托给 component interface

image.png

生成出来的 server struct 代码长这样:

image.png

检查字段的逻辑，其实是靠 proto 里的 option 声明，然后在代码里做计算、得到关键 flag，最后模板渲染时根据 flag 渲染字段检查逻辑:

image.png

最好基于一些开发框架来写插件，写起来更方便

protoc-gen-markdown 开发教程
https://taoshu.in/go/create-protoc-plugin.html
如何通过 protoc 命令行传参，把参数传给 plugin
https://rotemtam.com/2021/03/22/creating-a-protoc-plugin-to-gen-go-code/

image.png
如何 debug
没法debug，只能靠打印日志。开发完 go install 之后，运行 protoc。
可以打印到文件里，或者stderr里：

如果每次调试都需要编译一下会特别麻烦，也无法使用debug等工具

image.png

Idea: