如何编译gRPC Proto文件？非Node环境下用protoc编译至指定语言

一、前置准备 #

• 安装protoc编译器：下载对应平台的二进制包，解压后将可执行文件加入系统PATH。
• 安装目标语言的gRPC插件：不同语言的插件安装方式不同，下面会针对主流语言说明。

二、通用编译逻辑 #

protoc核心命令格式如下：

protoc --proto_path=<proto文件目录> \
       --<目标语言>_out=<输出目录> \
       --<目标语言>_grpc_out=<输出目录> \
       <proto文件名>

其中--proto_path（可简写为-I）指定proto文件的搜索路径，--<目标语言>_out生成普通Protobuf代码，--<目标语言>_grpc_out生成gRPC服务端/客户端代码。

三、主流语言具体命令示例 #

1. Python #

• 安装插件：

pip install grpcio-tools

• 编译命令：

protoc -I./proto \
       --python_out./gen/python \
       --grpc_python_out./gen/python \
       ./proto/your_service.proto

生成的代码会放在./gen/python目录，包含普通Protobuf的your_service_pb2.py和gRPC的your_service_pb2_grpc.py。

2. Go #

• 安装插件：

go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

确保$GOPATH/bin在系统PATH中。

• 编译命令：

protoc -I./proto \
       --go_out./gen/go \
       --go-grpc_out./gen/go \
       ./proto/your_service.proto

生成的代码会在./gen/go下的对应包路径中，包含your_service.pb.go和your_service_grpc.pb.go。

3. Java #

• 安装插件：可通过Maven/Gradle引入依赖，或直接下载protoc-gen-grpc-java二进制包加入PATH。
• 编译命令：

protoc -I./proto \
       --java_out./gen/java \
       --grpc-java_out./gen/java \
       ./proto/your_service.proto

生成的Java代码会按proto中指定的package结构存放在./gen/java目录。

4. C++ #

• 安装依赖：通过包管理器（如apt、brew）或源码编译安装gRPC和Protobuf开发库。
• 编译命令：

protoc -I./proto \
       --cpp_out./gen/cpp \
       --grpc_out./gen/cpp \
       --plugin=protoc-gen-grpc=`which grpc_cpp_plugin` \
       ./proto/your_service.proto

生成your_service.pb.h、your_service.pb.cc（Protobuf代码）和your_service.grpc.pb.h、your_service.grpc.pb.cc（gRPC代码）。

四、注意事项 #

• 确保proto文件语法正确，gRPC服务定义需符合service关键字规范。
• 不同语言的插件版本要和protoc版本匹配，避免兼容性问题。
• 输出目录需提前创建，否则protoc会报错。

内容的提问来源于stack exchange，提问作者Mohammad Imani