Protocol Buffers 生成代码

1. 生成结果
2. 命令行

1. 生成结果

protobuf 编译器运行一个 .proto 文件，会编译生成具体语言的源代码（定义的类型、get/set 接口，序列化和反序列化接口）。

Language	result file	note
C++	.h/.cc	message => class
Java	.java	message => class，以及用于消息类创建的特殊 `Builder` 类
Python		生成一个模块，包含消息类型的静态描述符，和 metaclass 一起使用，运行时创建必要的 Python 数据访问类
Go	.pb.go	message => struct
Ruby	.rb	Ruby module include message types
Objective-C	pbobjc.h/pbobjc.m	message => class
C#	.cs	message => class
Dart	.pb.dart	message => class

2. 命令行

安装编译器（用于将 .proto 文件生成不同语言的源代码）：

# macOS
brew install protobuf -> protoc 命令
# Ubuntu
apt install protobuf-compiler

protoc --proto_path=IMPORT_PATH \
       --cpp_out=DST_DIR --java_out=DST_DIR \
       --python_out=DST_DIR \
       --go_out=DST_DIR \
       --ruby_out=DST_DIR \
       --objc_out=DST_DIR \
       --csharp_out=DST_DIR \
       path/to/file.proto

IMPORT_PATH 指定要 import 指令导入 .proto 文件所在目录，多个目录通过指定多次来实现。 --proto_path 可以用 -I 来简写。

--xxx_out 指定语言和输出目录。如果目录指定成 .zip 或者 .jar 。编译器会生成一个压缩文件。

比如：

syntax = "proto3";

message User {
  enum Gender {
        MALE = 0;
        FEMALE = 1;
  }
  string username = 1;
  int32 age = 2;
  Gender gender = 3;
}

生成 C++ 代码：

protoc -I=. --cpp_out=. user.proto

生成 Python 代码：

protoc -I=. --python_out=. user.proto

生成 Go 代码

https://developers.google.com/protocol-buffers/docs/reference/go-generated

对于 Go，protobuf 编译器需要 Go 代码插件 proto-gen-go。安装方式：

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

另外 .proto 文件包含一个完全的 Go package 导入路径来指示生成的包，类似：

option go_package = "github.com/zhangjie2012/xxxx/libproto"

如果这指了 go_package ，输出文件会放在 go 当前目录中的的 github.com/zhangjiee2020/xxx/libproto/ 下面。上面的例子中会相对于 .proto 目录。

如果想改变输出目录可以设置项目目录，给 protoc 指定了 --go_opt=paths=source_relative 参数，输出文件和输出文件为止在相同的相对目录中。

protoc -I=pblib --go-grpc_out=pblib --go-grpc_opt=paths=source_relative  pblib/*.proto

Protocol Buffers 生成代码

Table of Contents

1. 生成结果

2. 命令行