protobuf编译及使用
一、前言
关于protobuf的介绍网上非常多,看起来非常简单,但在实际操作过程中还是有一些小问题存在,因此,写下此文也是用作 protobuf 的学习记录。
需要注意的是,本文中提供了一个demo,基于 CMake 工程进行构建的,因此需要开发者对 CMake 有一定的了解,能够看懂工程配置。
二、protobuf简介
protobuf 的全称是 Google Protocol Buffer,是 Google 公司内部的混合语言数据标准,目前已经正在使用的有超过 48,162 种报文格式定义和超过 12,183 个 .proto 文件。他们用于 RPC 系统和持续数据存储系统。
Protocol Buffers 是一种轻便高效的结构化数据存储格式,可以用于结构化数据串行化,或者说序列化。它很适合做数据存储或 RPC 数据交换格式。可用于通讯协议、数据存储等领域,Protocol Buffers 和语言无关、平台无关,它是可扩展的序列化结构数据格式。目前提供了 C++、Java、Python 三种语言的 API。
换句话说,protobuf 用于即时通讯,常用于 IM 类APP之间的消息传递,在我们的座舱系统中,也是使用 protobuf 进行压缩各个模块之间的数据,然后利用fdbus进行通信。(关于fdbus的使用,后续会单独写一篇文章进行讲解,同时结合protobuf进行使用)
其它相关的介绍这里就不再过多的一一赘述了,感兴趣的可以自行百度或者参考本文的参考链接。
三、编译
关于编译protobuf的教程非常多,建议参考本文的第五章参考链接的protobuf编译。
需要注意的是,在编译配置的时候,建议使用如下配置指令,最后被安装的目录将在当前源码目录下的 edit_build 文件夹内。
./configure --prefix=edit_build |
编译安装完成后,如下图所示:
四、使用
使用 protobuf 之前,相信你已经阅读了一些关于 protobuf 的知识了,接下来,我们将一步一步的构建我们自己的 protobuf 测试 demo。
4.1 protobuf 消息定义
protobuf 的消息定义非常简单,我们首先定义一个自己的消息协议包,参考格式如下所示:
BaseCarInfo.Motive.proto |
syntax = "proto3"; // 指明当前使用的语法版本,类比python 的版本 package BaseCarInfo;// 定义当前消息的包名,同C++的命名空间 message Motive // 定义当前的消息,同C++的class { int32 speed = 1; int32 rpm = 2; } |
一般情况下,对于一个 protobuf 的协议,文件命名以 .proto 结尾用于区分其它文件,文件名字一般情况下都是以 packageName.messageName.proto格式进行命名的。
需要注意的是,int32 speed = 1; 这里的 speed = 1 并不是给 speed 赋默认值为1,这里的1代表的是当前speed这个变量在Motive这个消息包中的编号,这个编号是不可重复的,有关 protobuf编号相关的了解,可以自行百度。
4.2 protobuf 文件生成
现在,我们有了 protobuf 的协议包,那么接下来,我们将利用 protobuf 将我们的协议包转换成对应的C++类。(其它语言只需要换不同参数即可)
还记得在编译的时候我们指定 ./configure --prefix=edit_build 这条配置指令吗?这条命令实际上就是指定 protobuf 的编译安装目录,打开 edit_build 目录,里面有三个文件夹,三个文件夹的作用如下表所示:
文件夹 |
作用 |
bin |
存放protobuf的可执行程序protoc |