注册

ProtoBuf 基本语法总结,看这一篇就够了

前言

最近项目是采用微服务架构开发的,各服务之间通过gPRC调用,基于ProtoBuf序列化协议进行数据通信,因此接触学习了Protobuf,本文会对Protobuf的语法做下总结,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。

gRPC的调用模型如下:

基本规范

  • 文件以.proto做为文件后缀,除结构定义外的语句以分号结尾。
  • rpc方法定义结尾的分号可有可无。
  • Message命名采用驼峰命名方式,字段命名采用小写字母加下划线分隔方式。

基本语法

首先看一个简单的示例:

/*
头部相关声明
*/
syntax = "proto3"; // 语法版本为protobuf3.0
package user; // 定义包名,可以为.proto文件指定包名,防止消息名冲突。
import "common.proto"; // 导入common.proto
option go_package = ".;proto";

//服务
service User {
rpc SayHello (SayHelloRequest) returns (SayHelloResponse) {}
}

//定义请求消息体
message SayHelloRequest {
string name = 1;
int64 role = 2;
}

//定义响应消息体
message SayHelloResponse {
string message = 1;
}
  • .proto文件的第一个非注释行用于指定语法版本,默认为“proto2”;

package定义包

可以为.proto文件指定包名,防止消息名冲突。

import 导入包

可以通过import导入其它.proto中定义的消息;常用于导入一些公共的信息。

正常情况下只能使用直接导入的proto文件的定义;如果需要使用多级import导入的文件,import 可以使用 public 属性。示例如下:

a.proto

import public "common.proto"; // 注意此处使用的是import public
import "c.proto";

b.proto

import "a.proto";

在b.proto中可以用common.proto中定义的内容,但是不能用c中的定义的内容。

定义Message

定义message使用“message”关键字,消息的字段声明由4部分构成:字段修饰符 字段类型 字段名称 = 标志号。

格式如下:

message 消息名称 {

[字段修饰符] 字段类型 字段名称 = 标志号;

}

字段修饰符

  • singular:默认值,该字段可以出现0次或者1次(不能超过1次);
  • repeated:该字段可以重复任意多次(包括0次);

我们可以使用repeated关键字来表示动态数组,示例如下:

message User {
repeated int64 id = 1;
}

在请求的时候我们可以传[]int64{1, 2, 3, 4}

字段类型

关于字段类型,这里列举几个常用的,其它的如果有需要可以直接网上搜。

类型备注
string字符串
double64位浮点型
float32位浮点型
int32、int64整型
bool布尔型
uint32、uint64无符号整型
sint32、sint64有符号的整形

字段编号

每个字段都有一个编号,这些编号是 唯一的。该编号会用来识别二进制数据中的字段。编号在1-15范围内可以用一个字节编码表示,在16-2047范围用两个字节表示,所以将15以内得编号留给频繁出现的字段可以节省空间。

枚举类型

在定义消息类型时,我们有可能会为某个字段预定义值的一个列表,我们可以通过enum来添加一个枚举,为每个可能的值添加一个常量。示例如下:

message UserRequest {
string name = 1;
// 定义性别枚举
enum Gender {
UNKNOWN = 0;
MAN = 1;
WOMAN = 2;
}
// 定义一个枚举字段
Gender gender = 2;
}

注意:所有枚举定义都需要包含一个常量映射到0并且作为定义的首行。

嵌套类型

嵌套类型,也就是字面意思,在 message 消息体中,又嵌套了其它的 message 消息体,一共有两种模式,如下:

syntax = "proto3";
message UserResponse {
message User {
int64 id = 1;
string name = 2;
}
repeated User users = 1;
}

如果在外部消息之外使用内部消息,则需要使用“outermsg.innermsg”的方式,如,需要在UserResponse外使用User, 则应该使用:

UserResponse.User

Map类型

在返回列表的时候,map类型经常用到,可以使用map关键字可以创建一个映射,语法如:

map<key_type, value_type> map_field = N;
  • key_type 只能是整数或字符串,enum不能作为key_type;
  • value_type 是除了映射(map)意外的任意类型;

示例:

message User {
int64 id = 1;
string name = 2;
}

map[int64, User] users = 1;

定义Service

如果想在RPC中使用已经定义好的消息类型,可以在.proto文件中定一个消息服务接口,使用service关键字进行服务定义,如:

service User {
rpc SayHello (SayHelloRequest) returns (SayHelloResponse) {}
}


作者:1个俗人
链接:https://juejin.cn/post/7155399858004688926
来源:稀土掘金
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

0 个评论

要回复文章请先登录注册