02-Protobuf 语法

高级葡萄Ya
167 阅读3分钟

持续创作，加速成长！这是我参与「掘金日新计划 · 6 月更文挑战」的第4天，点击查看活动详情

定义消息 message

syntax = "proto3" // 指定版本号
package HelloPackage; // 定义包
​
option go_package=".";// 定义结构体可选项
import "other.proto";  // 引入其他结构体
​
message 消息名{
  // 消息体
}
  • synatx 定义 proto 语法版本。没有指定时将默认为 proto2 版本
  • package 关键字，是将此消息结构体封装在包里，同时也可以避免出现 message 类型一样的名字时产生冲突，有了包名就可以进行区分。
  • import 引入其他的 proto 文件
import  "other.proto";
import public "other2.proto";
import weak "other.proto";

引入时支持 public 和 week 关键字。一般尽量少使用，因其在规范中介绍比较少。

  1. public 关键字：文件中使用 public 引入其他文件时，另外文件引入你的文件时也会引入第三方文件。

  2. week 关键字： 允许引入的文件不存在，只为了 Google 内部使用。

  • option 关键字 是用于定义 proto 文件时进行标注一些列的 options 。 Options 不会改变整个文件声明的含义，但能够影响特定环境下处理方式。它也可用在 message、enum、service 的定义中。

数据类型

proto类型go类型备注proto类型go类型备注
doublefloat64floatfloat32
int32int32int64int64
uint32uint32uint64uint64
sint32int32适合负数sint64int64适合负数
fixed32uint32固长编码，适合大于2^28的值fixed64uint64固长编码，适合大于2^56的值
sfixed32int32固长编码sfixed64int64固长编码
boolboolstringstringUTF8 编码，长度不超过 2^32
bytes[]byte任意字节序列，长度不超过 2^32

标量类型如果没有被赋值，则不会被序列化，解析时，会赋予默认值

  • strings：空字符串
  • bytes：空序列
  • bools：false
  • 数值类型：0

枚举

当 message 结构中的字段需要一组预定义的值时，就可以使用枚举

syntax = "proto3";
​
enum GenderType //枚举消息类型，使用enum关键词定义,一个电话类型的枚举类型
{
    femail = 0; //proto3版本中，首成员必须为0，成员不应有相同的值
    mail = 1;
}
​
message Student {
  string name;
  GenderType gender;
}
  • 枚举类型的第一个选项的标识符必须时0

当枚举中出现相同值的标识符时，可以通过开启允许别名 allow_alias

enum status //枚举消息类型，使用enum关键词定义,一个电话类型的枚举类型
{
    option allow_alias = true; // 允许为不同的枚举值赋予相同的标识符
    unknow = 0; //proto3版本中，首成员必须为0，成员不应有相同的值
    start = 1;
    running = 
}

数组类型

数组类型，通过在字段前加 repeated 关键字，标记当前字段是一个数组。

message Msg {
  // 只要使用repeated标记类型定义，就表示数组类型。
  repeated int32 arrays = 1;
}

Map 类型

语法：map<key_type, value_type> map_field = N;

  • key_type类型可以是内置的标量类型(除浮点类型和bytes)
  • value_type可以是除map以外的任意类型
  • map字段不支持repeated属性
  • 不要依赖map类型的字段顺序
syntax = "proto3";
message Product
{
    string name = 1; // 商品名
    // 定义一个k/v类型，key是string类型，value也是string类型
    map<string, string> attrs = 2; // 商品属性，键值对
}

定义服务 service

在 RPC 中，可以直接使用 protobuf 来定义 rpc 服务接口

service HelloService {
  rpc sayHello(HellpRequest) return (HelloResponse);
}

官方仓库也提供了一个插件列表，帮助开发基于 Protocol Buffer 的 RPC 服务。

基本规范

  • 文件以 .proto 为后缀，除了结构定义外的语句以分号结尾

    • 结构定义：message 、service 、enum
    • rpc 方法定义结尾的分号可有可无

  • message 命名是 驼峰命名方式，字段命名采用小写字母加下划线分隔方式

  • Enums类型名采用驼峰命名方式，字段命名采用大写字母加下划线分隔方式

  • Service名称与RPC方法名统一采用驼峰式命名

message HelloRequest {
  string person_name = 1;
}
​
enum FooType {
  FIRST_VALUE = 1;
  SECOND_VALUE = 2;
}

更多 proto3 代码风格，可参考：developers.google.com/protocol-bu…

参考资料：

avatar
文章
阅读
粉丝