这个教程中将会描述protocol buffer编译器通过给定的.proto会编译生成什么Go代码。教程针对的是proto3版本的protobuf。在阅读之前确保你已经阅读过Protobuf语言指南。
编译器调用
Protobuf核心的工具集是C++语言开发的,官方的protoc编译器中并不支持Go语言,需要安装一个插件才能生成Go代码。用如下命令安装:
$ go get github.com/golang/protobuf/protoc-gen-go
提供了一个protoc-gen-go二进制文件,当编译器调用时传递了--go_out命令行标志时protoc就会使用它。--go_out告诉编译器把Go源代码写到哪里。编译器会为每个.proto文件生成一个单独的源代码文件。
输出文件的名称是通过获取.proto文件的名称并进行两处更改来计算的:
生成文件的扩展名是.pb.go。比如说player_record.proto编译后会得到player_record.pb.go。
proto路径(使用--proto_path或-I命令行标志指定)将替换为输出路径(使用--go_out标志指定)。
当你运行如下编译命令时:
protoc --proto_path=src --go_out=build/gen src/foo.proto src/bar/baz.proto
编译器会读取文件src/foo.proto和src/bar/baz.proto,这将会生成两个输出文件build/gen/foo.pb.go和build/gen/bar/baz.pb.go
如果有必要,编译器会自动生成build/gen/bar目录,但是他不能创建build或者build/gen目录,这两个必须是已经存在的目录。
包
如果一个.proto文件中有包声明,生成的源代码将会使用它来作为Go的包名,如果.proto的包名中有. 在Go包名中会将.转换为_。举例来说proto包名example.high_score将会生成Go包名example_high_score。
在.proto文件中可以使用option go_package指令来覆盖上面默认生成Go包名的规则。比如说包含如下指令的一个.proto文件
package example.high_score;
option go_package = "hs";
生成的Go源代码的包名是hs。
如果一个.proto文件中不包含package声明,生成的源代码将会使用.proto文件的文件名(去掉扩展名)作为Go包名,.会被首先转换为_。举例来说一个名为high.score.proto不包含pack声明