Protocol Buffer usage

1. Protocol Buffer 使用

1.1. Prerequisites

1. Go, any one of the three latest major releases of Go.

For installation instructions, see Go’s Getting Started guide.

2. Protocol buffer compiler, protoc, version 3.

For installation instructions, see Protocol Buffer Compiler Installation.

3. Go plugins for the protocol compiler:

Install the protocol compiler plugins for Go using the following commands:

$ go install google.golang.org/protobuf/cmd/[email protected]
$ go install google.golang.org/grpc/cmd/[email protected]

Update your PATH so that the protoc compiler can find the plugins:

$ export PATH="$PATH:$(go env GOPATH)/bin"

1.2. protoc 工具使用

前面我们用 protoc 来编译 .proto 文件为 go 语言, 为了支持编译为 go, 需要安装 protoc-gen-go 插件, C# 可以安装 protoc-gen-zsharp 插件.

需要注意的是, 转换 .proto 为编程语言, 不一定要安装 protoc.

例如 C# 只需要把 .proto 文件放到项目中, 通过包管理器安装一个库, 就会自动转换为相应的代码.

回归正题, 聊一下 protoc 编译 .proto 文件的命令.

protoc 常用的参数如下:

 --proto_path=.		#指定proto文件的路径, 填写 . 表示就在当前目录下
 --go_out=.			#表示编译后的文件存放路径; 如果编译的是 csharp, 则 --csharp_out
 --go_opt={
    xxx.proto}={
    xxx.proto的路径}	# 示例: --go_opt=Mprotos/bar.proto=example.com/project/protos/foo

最简单的编译命令:

protoc --go_out=.  *.proto

--{xxx}_out 指令是必须的, 因为要输出具体的编程语言代码.

这个输出文件的路径是执行命令的路径, 如果我们不在 .proto 文件目录下执行命令, 则输出的代码便不是相同位置了.为了解决这个问题, 我们可以使用:

--go_opt=paths=source_relative

这样在别的地方执行命令, 生成的代码会跟 .proto 文件放在相同的位置.

1.3. protoc-gen-go

protoc-gen-go is a plugin for the Google protocol buffer compiler to generate Go code. Install it by building this program and making it accessible within your PATH with the name:

protoc-gen-go

The ‘go’ suffix becomes part of the argument for the protocol compiler, such that it can be invoked as:

protoc --go_out=paths=source_relative:. path/to/file.proto

This generates Go bindings for the protocol buffer defined by file.proto. With that input, the output will be written to:

path/to/file.pb.go

See the README and documentation for protocol buffers to learn more:

https://developers.google.com/protocol-buffers/

1.4. 参考

1. Protocol Buffer Compiler Installation
2. Quick start