Protocol Buffers Data Type Go Code Generation
External
https://protobuf.dev/reference/go/go-generated
Internal
Overview
The Go code that supports the data types defined in the .proto
files is generated withe the compiler is invoked with the go_out
flag, as shown below, and the Go plugin is installed.
Installation
The generic compiler must be installed with TODO.
To generate Go code, the Go plugin must be installed with:
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
This will install a protoc-gen-go
binary in ${GOBIN}
.
Code Generation
protoc \
--go_out=./pkg/person \
--proto_path=./proto \
--go_opt=Mperson.proto=. \
./proto/person.proto
The compiler creates a single source file for each .proto
file input that is provided on the command line. The name of the output file is the name of the corresponding .proto
file where the .proto
extension is replaced with .pb.go
. The newly created files will be placed under the directory specified by --go_out
, but where exactly depends on the --go_opt
compiler flags, as shown below. In the example above, a ./pkg/person/person.pb.go
file will be created.
Arguments
--go_out
The directory where the compiler writes the Go output. Where exactly in the directory depends on the value of the --go-opt
value.