protobuf3基础语法

本文作者：陈进坚
个人博客：https://jian1098.github.io
CSDN博客：https://blog.csdn.net/c_jian
简书：https://www.jianshu.com/u/8ba9ac5706b6
联系方式：jian1098@qq.com

简介

ProtoBuf （Google Protocol Buffer）是由google公司用于数据交换的序列结构化数据格式，具有跨平台、跨语言、可扩展特性，同类型有常用的XML及JSON，但具有更小的传输体积、更高的编码、解码能力，特别适合于数据存储、网络数据传输等对存储体积、实时性要求高的领域，目前已经发展到protoc3 版本。

优点：空间效率高，时间效率要高，对于数据大小敏感，传输效率高的

缺点：消息结构可读性不高，序列化后的字节序列为二进制序列不能简单的分析有效性

基本结构

syntax="proto3";					//文件第一行指定使用的protobuf版本，如果不指定，默认使用proto2
package services;					//定义proto包名,可以为.proto文件新增一个可选的package声明符，可选
option go_package = ".;services";	  //声明编译成go代码后的package名称，可选的，默认是proto包名

message ProdRequest{				//messaage可以理解为golang中的结构体,可以嵌套
    int32 prod_id=1;				//变量的定义格式为：[修饰符][数据类型][变量名] = [唯一编号] ,同一个message中变量的编号不能相同
}

message ProdResponse{
    int32 pro_stock=1;
}

service ProdService{									 //定义服务
	rpc GetProdStock (ProdRequest) returns (ProdResponse);	//rpc方法
}

变量类型

ProtoBuf	Golang
int32/sint32/sfixed32	int32
int64/sint64/sfixed64	int64
uint32/fixed32	uint32
uint64/fixed64	uint64
float	float32
double	float64
bool	bool
string	string
bytes	[]byte
enum	数组或slice
google.protobuf.Timestamp	timestamp.Timestamp

备注：最后的时间类型golang需要引入包github.com/golang/protobuf/ptypes/timestamp,定义如下

1	t:=timestamp.Timestamp(time.Now().Unix())

然后.protp文件需要导入google/protobuf/timestamp.proto

修饰符

repeated

如果一个字段被repeated修饰，则表示它是一个列表类型的字段，相当于golang里的切片

1
2
3

message SearchRequest {
  repeated string args = 1 // 列表类型
}

reserved

如果你希望可以预留一些数字标签或者字段可以使用reserved修饰符

message Foo {
  reserved 2, 15, 9 to 11;
  reserved "foo", "bar";
  string foo = 3 // 编译报错，因为‘foo’已经被标为保留字段
}

默认值

类型	默认值
string	“”
bytes	空字节
bool	false
数字	0
enum	第一个值
message	跟编程语言有关
repeated	空列表

枚举类型

第一个枚举值的数值必须是0且至少有一个枚举值，一个数值可以对应多个枚举值，必须标明option allow_alias = true;不推荐使用负数值

message SearchRequest {
  string query = 1;
  int32 page_number = 2;
  int32 result_per_page = 3;
  enum Corpus {
    UNIVERSAL = 0;
    WEB = 1;
    IMAGES = 2;
    LOCAL = 3;
    NEWS = 4;
    PRODUCTS = 5;
    VIDEO = 6;
  }
  Corpus corpus = 4;
}


enum EnumAllowingAlias {
  option allow_alias = true;
  UNKNOWN = 0;
  STARTED = 1;
  RUNNING = 1;
}

导入文件

1	import "myproject/other_protos.proto"; // 这样就可以引用在other_protos.proto文件中定义的message,不能导入不使用的.proto文件

定义服务

在你的 .proto 文件中指定 service,然后在service里定义rpc方法即可，要注意指定参数和返回值

1
2
3

service RouteGuide {
   rpc GetFeature(Point) returns (Feature) {}
}

rpc方法

gRPC 允许你定义4种类型的 service 方法

简单rpc

客户端使用存根发送请求到服务器并等待响应返回，就像平常的函数调用一样

1
2
3

service RouteGuide {
   rpc GetFeature(Point) returns (Feature) {}
}

服务端流式rpc

通过在 响应返回参数 类型前插入 stream 关键字，可以指定一个服务器端的流方法。客户端发送请求到服务器，拿到一个流去读取返回的消息序列。客户端读取返回的流，直到里面没有任何消息。

1
2
3

service RouteGuide {
   rpc ListFeatures(Rectangle) returns (stream Feature) {}
}

客户端流式rpc

通过在 请求参数 类型前指定 stream 关键字来指定一个客户端的流方法。客户端写入一个消息序列并将其发送到服务器，同样也是使用流。一旦客户端完成写入消息，它等待服务器完成读取返回它的响应。

1
2
3

service RouteGuide {
   rpc RecordRoute(stream Point) returns (RouteSummary) {}
}

双向流式rpc

通过在请求和响应前加 stream 关键字去制定方法的类型。两个流独立操作，因此客户端和服务器可以以任意喜欢的顺序读写：比如，服务器可以在写入响应前等待接收所有的客户端消息，或者可以交替的读取和写入消息，或者其他读写的组合。

1
2
3

service RouteGuide {
   rpc RouteChat(stream RouteNote) returns (stream RouteNote) {}
}