
Protocol Buffers 是一种与语言、平台无关,可扩展的序列化结构化数据的方法,常用于通信协议,数据存储等等。相较于 JSON、XML,它更小、更快、更简单,因此也更受开发人员的青眯。
基本语法
syntax = “proto3”;
package model;
service MyServ {
rpc Query(Request) returns(Reply);
}
message Student {
int64 id = 1;
string name = 2;
int32 age = 3;
}
定义完 proto文件后,生成相应语言的代码
protoc --proto_path=. --go_out=plugins=grpc,paths=source_relative:. xxxx.proto
--proto_path 或者 -I 参数用以指定所编译源码(包括直接编译的和被导入的 proto 文件)的搜索路径
--go_out 参数之间用逗号隔开,最后用冒号来指定代码目录架构的生成位置 ,--go_out=plugins=grpc参数来生成gRPC相关代码,如果不加plugins=grpc,就只生成message数据
eg:--go_out=plugins=grpc,paths=import:. 。注意一下 paths 参数,他有两个选项,import 和 source_relative 。默认为 import ,代表按照生成的 go 代码的包的全路径去创建目录层级,source_relative 代表按照 proto 源文件的目录层级去创建 go 代码的目录层级,如果目录已存在则不用创建
protoc是通过插件机制实现对不同语言的支持。比如 --xxx_out 参数,那么protoc将首先查询是否有内置的xxx插件,如果没有内置的xxx插件那么将继续查询当前系统中是否存在protoc-gen-xxx命名的可执行程序。
在执行protoc的时候,我们要指定这些需文件的查找路径,在项目的根目录里执行protoc进行代码生成
protoc -I=. --go_out=plugins=grpc:. --go_opt=paths=source_relative protos/api/*.proto
上面的-I指定了当前目录,就是说可以从当前目录开始找proto文件
protoc 生成了什么
以 student.proto为例
syntax = "proto3";
package model;
option go_package = "protos/model";
option java_package = "com.proto.model";
message Student {
int64 id = 1;
string name = 2;
int32 age = 3;
}
message StudentList {
string class = 1;
repeated Student students = 2;
string teacher = 3;
repeated int64 score = 4;
}
执行完protoc后,大概看一下生成的的go文件
type Student struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
Age int32 `protobuf:"varint,3,opt,name=age,proto3" json:"age,omitempty"`
}
state 保存 proto文件的反射信息 sizeCache序列化的数据总长度 unknownFields 不能解析的字段
剩下的字段是我们message里定义的信息,主要看一下tag信息
protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty",说明这个字段是protobuf的varint类型,index为1 name为id,使用proto3协议
还有一个byte数组的
举报 0