protobuf中.proto文件语法

一 基本说明

.proto文件使用基本说明
结构定义文件为.proto,可以使用import包含另一个.proto文件,注释使用//

二 语法

1 字段限制

required: 必须赋值的字符
optional: 可有可无的字段,可以使用[default = xxx]配置默认值
repeated: 可重复变长字段,类似数组

2 tag

每个字段都有独一无二的tag
tag 1-15是字节编码,16-2047使用2字节编码,所以1-15给频繁使用的字段

3 类型

图片.png

系统默认值
string默认为空字符串;
bool默认为false;
数值默认为0;
enum默认为第一个元素

4 解析与序列化

每个message都包含如下方法,用于解析和序列化,注意目标是字节形式,非文本。
bool SerializeToString(string* output) const: 将message序列化成二进制保存在output中,注意保存的是二进制,不是文本;仅仅是string作为容器。
bool ParseFromString(const string& data): 从给定的二进制数值中解析成message
bool SerializeToOstream(ostream* output) const: 序列化到ostream中
bool ParseFromIstream(istream* input): 从istream中解析出message

三 举例介绍

1 建立.proto文件

建立.proto文件定义message,如下addressbook.proto

syntax = "proto2"; // 定义语法类型,通常proto3好于proto2,proto2好于proto1

package tutorial; // 定义作用域

message Person {        // 生成类class Person : public ::google::protobuf::Message 
  required string name = 1;
  required int32 id = 2;
  optional string email = 3;

  enum PhoneType { // 定义枚举类型,生成Person_PhoneType类型
    MOBILE = 0;
    HOME = 1;
    WORK = 2;
  }

  message PhoneNumber { // 生成Person_PhoneNumber类
    required string number = 1;
    optional PhoneType type = 2 [default = HOME]; // 值必须是枚举类型中的一个
  }
  repeated PhoneNumber phones = 4;
}

message AddressBook {
  repeated Person people = 1;
}

2 生成源文件

protoc -I=$SRC_DIR --cpp_out=$DST_DIR $SRC_DIR/addressbook.proto
其中protoc工具地址:protoc

1) message Person{}

会生成源码如下:

class Person  : public ::google::protobuf::Message {
Person(); // 默认构造函数
~Person(); // 默认析构函数
Person(const Person& other); // 拷贝构造函数
Person& operator=(const Person& other); // 赋值构造函数
void Swap(Person* other); // 内容交换
const UnknownFieldSet& unknown_fields() const; 
UnknownFieldSet* mutable_unknown_fields(); 
static const Descriptor* descriptor();
static const Foo& default_instance();
};

2) required string name

生成源码如下:

bool has_name() const; // 返回true,如果name被设置
void clear_name(); // 清除name,has_name会返回false
const ::std::string& name() const; // 返回name字符串
void set_name(const ::std::string& value); // 设置name字符串
::std::string* mutable_name(); // 可以修改的字符串,has_name会返回true

3) required int32 id

生成源码如下:

bool has_id() const; // 返回true,如果id被设置
int32 id() const; // 返回id数值
void set_id(int32 value); // 设置id数值
void clear_id(); // 清除id,has_id会返回false

4) message Person { message PhoneNumber }

生成类Person_PhoneNumber,并在Person类内定义:

typedef Person_PhoneNumber PhoneNumber;

其他消息如果要使用PhoneNumber,使用方法如下:

message OtherPerson {
    optional Person.PhoneNumber number = 1;
}

3 定义prototxt文件

定义如下:

people{
   name : "Lucy"
   id : 120
   email : "lucy@163.com"
   phones{
       number : "13540737210"
       type : HOME
   }
}

4 代码中解析prototxt文件

/*************************************************************************                                                                                             
    > File Name: main.cpp
    > Author: ma6174
    > Mail: ma6174@163.com 
    > Created Time: Wed 09 Jan 2019 11:04:56 PM CST
 ************************************************************************/
#include<iostream>
#include "tutorial.AddressBook.pb.h"
using namespace std;

int main() {
    tutorial::Person one;
    string filename = "one.prototxt";
    ReadProtoFromTextFileOrDie(filename, &one);
    return 0;
}

编译命令:

g++ main.cpp *.cc -std=c++11 `pkg-config --cflags --libs protobuf`

这一步编译报错:

main.cpp:15:43: error: ‘ReadProtoFromTextFileOrDie’ was not declared in this scope
  ReadProtoFromTextFileOrDie(filename, &one);
                                           ^

需要进一步学习...

参考

[1] 官方指南.Protocol Buffer Basics: C++
[2] 博客.序列化之protobuf

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