初试 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

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

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏java 成神之路

JSP 热部署 源码解析

3443
来自专栏耕耘实录

一分钟在Linux环境下创建一台SFTP服务器(含账户创建)

FTP是比较常见的一种服务了,很多公司都会有可能使用到FTP服务器,本文将以最简洁的办法使用系统自带的ssh软件在1分钟内搭建一台使用方便的FTP服务器。 ...

1853
来自专栏技术小站

Python 多线程与多进程

原文地址:http://www.cnblogs.com/whatisfantasy/p/6440585.html

1272
来自专栏企鹅号快讯

Python的线程

本文是基于Py2.X 线程 多任务可以由多进程完成,也可以由一个进程内的多线程完成。 我们前面提到了进程是由若干线程组成的,一个进程至少有一个线程。 多线程类似...

2348
来自专栏Dawnzhang的开发者手册

数据结构与算法学习笔记之先进先出的队列 数据结构与算法学习笔记之写链表代码的正确姿势(下)数据结构与算法学习笔记之 提高读取性能的链表(上)数据结构与算法学习笔记之 从0编号的数组数据结构与算法学

  队列是一种非常实用的数据结构,类似于生活中发排队,可应用于生活,开发中各个方面,比如共享打印机(先请求先打印),消息队列。你想知道他们是怎么工作的么。那就来...

1263
来自专栏JetpropelledSnake

SNMP学习笔记之Python的netsnmp和pysnmp的性能对比

用python获取snmp信息有多个现成的库可以使用,其中比较常用的是netsnmp和pysnmp两个库。网上有较多的关于两个库的例子。

3642
来自专栏python学习路

八、线程和进程 什么是线程(thread)?什么是进程(process)? 线程和进程的区别?Python GIL(Global Interpreter Lock)全局解释器锁

什么是线程(thread)? 线程是操作系统能够进行运算调度的最小单位。它被包含在进程之中,是进程中的实际运作单位。一条线程指的是进程中一个单一顺序的控制流,一...

4857
来自专栏python3

python爬虫常用模块

涉及到网络这块,必不可少的模式就是urllib.request了,顾名思义这个模块主要负责打开URL和HTTP协议之类的

1101
来自专栏黑泽君的专栏

Java程序的运行原理及JVM的启动是多线程的吗?

A:Java程序的运行原理     Java通过java命令会启动java虚拟机。启动JVM,等于启动了一个应用程序,也就是启动了一个进程。   ...

3592
来自专栏技术小站

搞定python多线程和多进程

线程是操作系统能够进行运算调度的最小单位。它被包含在进程之中,是进程中的实际运作单位。一条线程指的是进程中一个单一顺序的控制流,一个进程中可以并发多个线程,每条...

1051

扫码关注云+社区

领取腾讯云代金券