ProtoBuf v3 语法简介

syntax

ProtoBuf 有两个语言版本:v2 与 v3,截止目前在使用 v3 的时候,需要在 *.proto 文件首行中明文标识 syntax:

person.proto:

syntax="proto3";

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

如果使用的是 v2 ,在首行可以缺省 syntax 标识,或者指定 syntax="proto2"; 都可以:
person.proto:

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

v3 与 v2 在语法上有一些区别例如:v3 去除了 optional、required 等,在语法上更为的简洁,我们这里主要介绍 v3,所以对 v2 就不做过多介绍了。

message

message 用来定义一个数据结构

  1. 命名:常规的命名方式建议使用驼峰法,即:HelloWorld 样式
  2. 注释: message 中支持 // 这样的单行注释
  3. repeated 的使用:被 repeated 标识的字段可以理解为是一个数组,示例:
message Person {
    int64 id = 1;
    string name = 2;
    repeated string skills = 3;  // 这里表示 skills 可以接受多个 string 类型的值
}
  1. enum 类型使用:枚举用来表示一定范围内具有相同属性的值,示例:
syntax = "proto3";
message Employee {
    int64 id = 1;
    string name = 2;
    enum Skills {
        GOLANG = 0;
        PYTHON = 1;
        JAVA = 2;
        RUST = 3;
        CPP = 4;
    }
    Skills skill = 3;
}
  1. message 类型的使用: message 在定义过程中是可以声明自己定义的 message 类型,示例:
syntax = "proto3";
message Employee {
    int64 id = 1;
    string name = 2;
    Skill skills = 3;  //这里声明的为自定义的 Skill 类型
}
message Skill {
    string name = 1;
}
  1. map 类型的使用:message 定义时可以使用 map 类型,示例:
syntax = "proto3";
message Employee {
    int64 id = 1;
    string name = 2;
    map<string, Skill> skills = 3;
}
message Skill {
    string name = 1;
}

package

每个 *.proto 文件可以指定 package 作为生成语言的 namespace,示例:

syntax = "proto3";
package exmple;
message Employee {
    int64 id = 1;
    string name = 2;
    map<string, Skill> skills = 3;
}
message Skill {
    string name = 1;
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • 0. 简介 实现了一个可扩展的微型C++序列化框架tiny-serializer。 项目地址:https://gi...
    davidpp阅读 551评论 0 0
  • 由于工程项目中拟采用一种简便高效的数据交换格式,百度了一下发现除了采用 xml、JSON 还有 ProtoBuf(...
    黄海佳阅读 48,492评论 1 23
  • 从今天开始,要改变自己的一些生活习惯了。 古人云,一年之际在于春,一日之际在于晨。很显然,无论是春或者是晨我都做的...
    孙麦函阅读 328评论 0 0
  • 我趴在床上,手中捧着一本散文集,正在看其中一篇,不自觉的瞥了一眼还在睡懒觉的女儿,看到她的小脚丫和脚踝,颇有骨感,...
    沉默岛主阅读 595评论 1 8