初试 Protocol Buffer

@(c++)

前言

如下, 一般情况下,进行消息发送的时候,对于 c/c++, 双方统一使用相同的结构体,发送时直接按内存块丢出去,接收后内存块直接赋值给结构体即可。但是这种对于其他语言,诸如 python,java 就没那么方便了。

struct Message {
    int id;
    char msg[256];
};

// 发送端
Message client_message = {
    .id = 1,
    .msg = "iamclient",
}
send(cfd, &client_message, sizeof(client_message));

//接收端
Message server_message;
memset(&server_message, 0, sizeof(server_message));
receive(sfd, &server_message, &length);
...

接触到谷歌的序列化方法 protocol buffer, 感觉挺好玩的,所以了解下。
pb 是用于结构化数据序列化的灵活,高效,自动的方法,类似 xml,但是比之更加高效,简单。
并且了解到,pb可以保证不同版本消息间的兼容性,具体实现后续探索。
Protocol buffer github 主页

定义一个 pb 消息

使用 pb 作为协议解析,首先需要根据自己的需要定义自己的协议文件 xxx.proto,然后借助 pb 提供的转换工具转换成使用语言的定义文件。

举个最简单的例子,定义一个简单消息协议 message.proto,如下所示:

syntax = "proto2";
option optimize_for = LITE_RUNTIME;

message TestMessage {
    required int64 id = 1;
    required string message = 2;
}

忽略其他,只看类似 c 结构体那部分,定义了一个消息,包含一个idmessage, 其中要注意,变量后面的数字1,2不是赋值,而是指定消息序列化后在内存中的位置,编解码需要,按顺序写,同一个消息中,注意该值不能重复。 另外,pb 中,数字在1 - 15的编码时有优化,占用字节更少。

下面再看一个比较复杂的消息定义 message2.proto

syntax = "proto2";
option optimize_for = LITE_RUNTIME;
// 这是注释
// 定义枚举类型
enum UserStatus {
    OFFLINE = 0;
    ONLINE = 1;
}
enum LogResult {
    LOGON_RESULT_SUCCESS = 0;
    LOGON_RESULT_NOTEXIST = 1;
    LOGON_RESULT_ERROR_PASSWD = 2;
    LOGON_RESULT_ALREADY_LOGON = 3;
    LOGON_RESULT_SERVER_ERROR = 4;
}
message UserInfo {
    required int64 acctID = 1;
    required string name = 2;
    required UserStatus status = 3;
}
// 嵌套消息,注意数字
message LogonRespMessage {
    required LogResult logonResult = 1;
    required UserInfo UserInfo = 2;
}

诸如此列消息定义后,通过pb工具生成对应不同语言的文件。

protoc --proto_path=.  --cpp_out=. message.proto

--proto_path 指定待转换文件的目录, --cpp_out指定生成文件类型和路径,最后指定转换的文件,其他语言生成,使用类似 --java_out等。
以c++ 为例,会自动生成 message.pb.cc 和 message.pb.h 两文件,包含到自己的代码里面就可以了。

可以参考 pb 的源码中的example目录下提供的一个例程。

一个简单的 demo

参考 pb 的例子,写一个客户端发送消息给服务器,服务器获取解析的例程。
使用消息定义就是上面提到 message.proto, 比较简单。

以下是 client.cpp定义消息序列化后发送的代码:

// pb 根据.proto 文件自动生成的类
TestMessage message;
// 通过自动生成的接口定义变量
message.set_id(1);
message.set_message(str);
// 获取该消息序列化后的长度
int length = message.ByteSize();
char *ByteBuf = new char[length];
// 序列化消息,用于网络传输
message.SerializeToArray(ByteBuf, length);
printf("SerializeToArray length : %d\n", length);
write(sockfd, ByteBuf, length);
delete [] ByteBuf;

再看看 server.cpp的代码, socket 收到数据后,通过pb提供的接口进行反序列化,读取到消息的内容。

ssize_t count;
char buf[102400];
count = read(events[i].data.fd, buf, sizeof buf);
if (count == -1) {
    if (errno != EAGAIN) {
        perror("read error");
        done = 1;
    }
    // read finish or error
    break;
}
if (count == 0) {
    // disconnection
    done = 1;
    break;
}
// 定义消息类
TestMessage message;
// 通过网络接收的消息反序列化赋值
message.ParseFromArray(buf, count);
printf("ID = %ld, message = \"%s\"\n",
        message.id(), message.message().c_str());

运行结果截图:

result

完整例子代码
pb 安装参考

安装文件后直接执行例子目录下执行make 即可得到可执行文件(client 使用ip port 8000)。

$ make
$ ./client  "msg you snd"
$ ./server 8000

另外例子目录上级另外还有两个简单例子,一个简单消息,一个是嵌套消息。
简单记录如此

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

推荐阅读更多精彩内容

  • 由于工程项目中拟采用一种简便高效的数据交换格式,百度了一下发现除了采用 xml、JSON 还有 ProtoBuf(...
    黄海佳阅读 48,637评论 1 23
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,652评论 18 139
  • 序列化概述 当两个服务在进行通信时,彼此可以发送各种类型的数据。无论是何种类型的数据,都会以字节序列的形式在网络上...
    _张晓龙_阅读 7,931评论 0 11
  • 什么是protocal buffer? protocal buffer 以下简称protobuf是google 的...
    碎念枫子阅读 3,822评论 8 10
  • 如果有一天我看不见了, 请带我去看日出好吗? 我还想看看最美的东西 如果有一天我听不见了, 请带我去海边好吗? 我...
    南有鱼阅读 268评论 4 0