protobuf-c的使用（二）使用

2024-12-09 技术教程

上一篇介绍了protobuf-c的构建。接下来介绍一下protobuf-c的使用。protobuf最核心的就是proto文件，其次通过protobuf-c编译proto文件生成供c语言调用的库文件和头文件。下面逐一说明一下proto文件的定义、protobuf-c编译以及c语言如何使用protobuf。

一、proto文件结构

protobuf以消息Message为主要结构，消息中包含具体的字段，字段定义主要以required（必填字段）、optional（可选字段）、repeated（可重复字段）为主，包含了各大编程语言的基本数据类型、引用类型等。具体定义参考如下：

.proto文件：包含了Message结构定义的协议文件，我们需要首先编写.proto文件，然后再生成编程语言对应的源文件。

Message结构：包含了字段的，每一条字段都包含定义声明、数据类型以及字段序号。字段序号是唯一不重复的，序号保证了不同语言和平台的序列化和反序列化字段的字节顺序。

定义声明：

required：声明该字段是必填字段。

optional：声明该字段是可选字段。

repeated：声明该字段是可重复字段，通常用数组表示，也可以是list。

数据类型：protobuf支持的数据类型很全，可参考如下表：

.proto类型描述packc/c++类型bool布尔类型pack(1)booldouble64位浮点类型pack(N)doublefloat32位浮点类型pack(N)floatint3232位整数类型pack(N)intint6464位整数类型pack(N)__int64uint32无符号32位整数类型pack(N)unsigned intuint64无符号64位整数类型pack(N)unsigned __int64sint3232位整数类型，使用可变长编码方式。有符号的整型值。编码时比通常的int32高效。pack(N)intsint6464位整数类型，使用可变长编码方式。有符号的整型值。编码时比通常的int64高效。pack(1)__int64fixed3232位无符号整数类型，总是4个字节。如果数值总是比总是比228大的话，这个类型会比uint32高效。pack(4)boolfixed6464位无符号整数类型，总是8个字节。如果数值总是比总是比256大的话，这个类型会比uint64高效。pack(8)boolsfixed3232位整数类型，总是4个字节。pack(4)boolsfixed6464位整数类型，总是8个字节。pack(8)boolstring字符串类型pack(N)char*/char[]/std:stringbytes一个字符串必须是UTF-8编码或者7-bit ASCII编码的文本。pack(N)char*/char[]/std:stringenum用户自定义枚举类型pack(N)与 uint32相同boolmessage用户自定义的消息类型pack(N)struct/class

N 表示打包的字节并不是固定。而是根据数据的大小或者长度打包。

二、protobuf-c编译proto文件

编译命令：

protoc-c--c_cout=..proto文件-lprotobuf-c

举个栗子：
定义消息Message Command（命令），其中包含字段：

指令代码：code 64位长整类型，用于区分指令。

指令类型：type 32位整数类型，说明该指令是查询（0）、读写（1）、调用执行（2）。

调用模块名：module 字符串，调用哪个模块的模块名称。

调用函数名：func 字符串，调用哪个模块的函数名称。

调用函数参数：params 字符串数组，调用函数的参数。

.proto文件如下（Command.proto）：

messageCommand{requiredsint64code=1;//指令代码requiredsint32type=2;//指令类型0查询1读写2调用执行requiredstringmodule=3;//调用模块名requiredstringfunc=4;//调用函数名repeatedstringparams=5;//函数参数}messageCommandResponse{requiredsint32code=1;//返回代码0成功1失败optionalstringmsg=2;//返回消息失败消息或成功消息requiredsint32version=3;//接口版本repeatedCommanddata=4;//真正的数据字段}1234567891011121314

执行命令：

protoc-c--c_out=.Command.proto-lprotobuf-c

可以看到生成了Command.pb-c.c和Command.pb-c.h的c语言源文件和头文件。

三、c语言中使用protobuf

接下来尝试调用上面生成的c文件。protobuf-c使用pack和unpack方法做序列化和反序列化操作。

在使用packed之前需要使用__INIT函数创建PB对象，然后为对象中字段逐一赋值。

CommandResponseresponse=COMMAND_RESPONSE__INIT;

这里需要注意response中包含的Command，也需要使用__INIT函数进行初始化并赋值。

Commandcommand=COMMAND__INIT;

在逐一赋值后，我们需要分配一个buffer用于保存序列化字节，在对buffer分配空间时，可以使用__get_packed_size函数获取PB结构体的大小作为分配空间的大小。

size_tsize=command_response__get_packed_size(&response);

接下来使用__pack函数执行序列化操作。