protobuf-c的使用（二）使用

上一篇介紹了protobuf-c的構(gòu)建。接下來介紹一下protobuf-c的使用。protobuf最核心的就是proto文件，其次通過protobuf-c編譯proto文件生成供c語言調(diào)用的庫文件和頭文件。下面逐一說明一下proto文件的定義、protobuf-c編譯以及c語言如何使用protobuf。

一、proto文件結(jié)構(gòu)

protobuf以消息Message為主要結(jié)構(gòu)，消息中包含具體的字段，字段定義主要以required（必填字段）、optional（可選字段）、repeated（可重復字段）為主，包含了各大編程語言的基本數(shù)據(jù)類型、引用類型等。具體定義參考如下：

• .proto文件：包含了Message結(jié)構(gòu)定義的協(xié)議文件，我們需要首先編寫.proto文件，然后再生成編程語言對應的源文件。

• Message結(jié)構(gòu)：包含了字段的，每一條字段都包含定義聲明、數(shù)據(jù)類型以及字段序號。字段序號是唯一不重復的，序號保證了不同語言和平臺的序列化和反序列化字段的字節(jié)順序。

• 定義聲明： 
  

  • required：聲明該字段是必填字段。

  • optional：聲明該字段是可選字段。

  • repeated：聲明該字段是可重復字段，通常用數(shù)組表示，也可以是list。

• 數(shù)據(jù)類型：protobuf支持的數(shù)據(jù)類型很全，可參考如下表：

N 表示打包的字節(jié)并不是固定。而是根據(jù)數(shù)據(jù)的大小或者長度打包。

二、protobuf-c編譯proto文件

編譯命令：

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

舉個栗子： 
定義消息Message Command（命令），其中包含字段：

• 指令代碼：code 64位長整類型，用于區(qū)分指令。

• 指令類型：type 32位整數(shù)類型，說明該指令是查詢（0）、讀寫（1）、調(diào)用執(zhí)行（2）。

• 調(diào)用模塊名：module 字符串，調(diào)用哪個模塊的模塊名稱。

• 調(diào)用函數(shù)名：func 字符串，調(diào)用哪個模塊的函數(shù)名稱。

• 調(diào)用函數(shù)參數(shù)：params 字符串數(shù)組，調(diào)用函數(shù)的參數(shù)。

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

message Command{
        required sint64 code = 1; //指令代碼
        required sint32 type = 2; //指令類型 0 查詢 1 讀寫 2 調(diào)用執(zhí)行
        required string module = 3; //調(diào)用模塊名
        required string func = 4; //調(diào)用函數(shù)名
        repeated string params = 5; //函數(shù)參數(shù)}

message CommandResponse{
        required sint32 code = 1; //返回代碼 0 成功 1 失敗
        optional string msg = 2; //返回消息 失敗消息或成功消息
        required sint32 version = 3; //接口版本
        repeated Command data = 4; //真正的數(shù)據(jù)字段}1234567891011121314

執(zhí)行命令：

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

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

三、c語言中使用protobuf

接下來嘗試調(diào)用上面生成的c文件。protobuf-c使用pack和unpack方法做序列化和反序列化操作。

在使用packed之前需要使用__INIT函數(shù)創(chuàng)建PB對象，然后為對象中字段逐一賦值。

    CommandResponse response=COMMAND_RESPONSE__INIT;

這里需要注意response中包含的Command，也需要使用__INIT函數(shù)進行初始化并賦值。

    Command command=COMMAND__INIT;

在逐一賦值后，我們需要分配一個buffer用于保存序列化字節(jié)，在對buffer分配空間時，可以使用__get_packed_size函數(shù)獲取PB結(jié)構(gòu)體的大小作為分配空間的大小。

    size_t size=command_response__get_packed_size(&response);

接下來使用__pack函數(shù)執(zhí)行序列化操作。

    command_response__pack(&response,buf);

反序列化操作可直接使用__unpack函數(shù)。得到反序列化后的對象指針，通過指針可直接訪問PB中的字段。

    CommandResponse *response=
    command_response__unpack(NULL,size,buf);

在對PB訪問完成后，需要通過__free_unpacked來釋放反序列化的內(nèi)存空間。

  command_response__free_unpacked(response, NULL);

具體例子可參考protobuf-c的github wiki：https://github.com/protobuf-c/protobuf-c/wiki/Examples