Node.js环境下使用proto3版本生成pb文件失败问题
Node.js 开发场景 proto3 编译gRPC代码报不支持optional字段的解决方法
问题复现路径
- 安装依赖:执行命令
yarn add grpc-tools - 执行proto编译:执行命令
protoc --js_out=import_style=commonjs,binary:./ --plugin=protoc-gen-grpc=./grpc_node_plugin.exe --grpc_out=./ UHDInterface.proto - 编译终止并抛出错误:
UHDInterface.proto: is a proto3 file that contains optional fields, but code generator protoc-gen-grpc hasn't been updated to support optional fields in proto3. Please ask the owner of this code generator to support proto3 optional.--grpc_out
问题根因
旧版本grpc-tools内置的*grpc_node_plugin未适配proto3规范中引入的原生optional字段语法*(该语法从Protobuf 3.15版本开始正式成为稳定特性),当编译的proto文件包含该语法时,插件会直接阻断编译流程。
可落地解决方法
- 方法1:升级grpc-tools至兼容版本
卸载当前本地旧版本依赖,拉取已适配proto3 optional特性的最新稳定版依赖:
安装完成后,删除项目根目录下手动放置的旧版yarn remove grpc-tools yarn add grpc-tools@latestgrpc_node_plugin.exe文件,将编译命令里硬编码的插件路径替换为node_modules下安装生成的实际插件路径,避免加载到缓存中的旧插件导致报错复现。 - 方法2:低版本依赖下的临时兼容写法
如果受项目版本约束无法升级grpc-tools,可手动调整proto文件的字段定义,绕开插件不支持的原生optional语法:
把原有写法optional string user_name = 1;调整为不依赖编译器特性的存在性标记写法:
该写法可被旧版插件正常编译,仅需要在业务代码中手动维护字段存在性的判断逻辑。string user_name = 1; // 手动维护字段存在性,替代原生optional的存在判断逻辑 uint32 user_name_has_value = 2; - 方法3:切换适配的代码生成工具链
无需修改proto文件、也不强制升级旧版本依赖的前提下,可切换为@grpc/grpc-js配套的原生代码生成插件,该插件从早期版本就完整支持proto3 optional特性,对应的编译命令调整为:protoc --js_out=import_style=commonjs,binary:./ --grpc_out=./ --plugin=protoc-gen-grpc=./node_modules/.bin/grpc_tools_node_protoc_plugin UHDInterface.proto
内容的提问来源于stack exchange,提问作者Hoopig Zhu
相关产品推荐
相关产品推荐

