protoc 自定义插件生成代码

protoc 自定义插件生成代码 - Jxy 博客

正常根据proto生成对应的go代码

首先安装 protoc编译工具，然后安装go代码生成插件go install github.com/golang/protobuf/protoc-gen-go@latest

protoc --go_out= [文件生成的位置] [proto所在的目录]

加上-I 则表示生成某个文件时会搜索需要导入的其他proto

此时生成的只有go代码，如果需要生成grpc连接客户端，则需要

protoc --go_out=plugins=grpc: [文件生成的位置] [proto所在的目录]

当protoc 执行命令的时候，插件解析步骤如下

1、解析proto 文件，类似于AST树的解析，将整个proto文件有用的语法内容提取出来

2、将解析的结果转为成二进制流，然后传入到protoc-gen-xx标准输入。也就是说protoc 会去程序执行路径去找protoc-gen-go 这个二进制，将解析结果写入到这个程序的标准输入。如果命令是--go_out，那么找到是protoc-gen-go，如果自己定义一个插件叫xxoo，那么--xxoo_out找到就是protoc-gen-xxoo了。所以我们得确保有这个二进制执行文件，要不然会报找不到的错误。

3、protoc-gen-xx 必须实现从标准输入读取上面解析完的二进制流，然后将得到的proto 信息按照自己的语言生成代码，最后将输出的代码写回到标准输出

4、protoc 接收protoc-gen-xx的标准输出，然后写入文件

实际调用过程中，可以将插件二进制文件放在环境变量PATH中，也可直接通过--plugin=[ plugin-name=plugin-path, ....] 传给protoc

protoc --plugin=protoc-gen-xx=path/to/xx --NAME_out=MY_OUT_DIR