FlatBuffer在C++中的使用

FlatBuffers是為Google發(fā)布的一個跨平臺,提供多種語言接口,注重性能和資源使用的序列化類庫。目前該類庫提供C++、C#、C、GO、Java、JavaScript、PHP、Python語言接口。該序列化庫多用于移動端手游數(shù)據(jù)傳輸以及特定的對性能要求較高的應(yīng)用。

本文只介紹在C++中的使用步驟,原理部分不闡述。

一、安裝flatc

flatc是從來將schema文件轉(zhuǎn)化為C++頭文件的工具,需要使用CMake來編譯FlatBuffers。因此第一步先安裝CMake工具(如沒有)。

下載FlatBuffers源碼

git clone https://github.com/google/flatbuffers.git

進入flatbuffers根目錄,執(zhí)行

cmake -G "Unix Makefiles"
make
make install

查看flatc是否安裝成功

./flatc --version

二、編寫schema文件

官方介紹

用schema文件來描述我們要序列化的類,語法和c/c++很相似。比如我們用C++定義類是這樣寫:

class Point
{
    float x;
    float y;
};

class Node
{

   std::string name;
   Point position;
};

class Layer: public Node
{
   Node* friend;
   std::vector<Node*> children;
   std::vector<Point *> transform;
};

那么用schema可以這樣編寫:

namespace Layer;  
  
table Point_Fb 
{  
   x:float;
  y:float;
 }  
  
table Node_Fb  
{  
    name:string;
  position:Point_Fb;
}  
  
table Layer_Fb
{
  super:Node_Fb;
  friend:Node_Fb;
  children:[Node_Fb];
  transform:[Point_Fb];
}
root_type Layer_Fb;

然后把這個文件保存為.fbs后綴的文件,如Layer_Fb.fbs

三、生成_generated.h文件

這里我把Layer_Fb.fbs文件放在了flatc同級目錄下,并且制定在這個目錄生成結(jié)果

flatc -c -o ./ ./Layer_Fb.fbs

執(zhí)行成功后,可以看到目錄下會多一個Layer_Fb_generated.h文件

四、配置工程依賴

首先將flatbuffers目錄下的libflatbuffers.a和include目錄,然后將生成的Layer_Fb_generated.h頭文件加到工程中。

注意:XCode中還需配置Build Setting -> Header Search Paths為flatbuffers的上級目錄,也就是include,否則引用的頭文件會找不到


build setting

五、序列化

void serialize() {
    
    flatbuffers::FlatBufferBuilder build_data;
    
    // super
    auto position_fb = Layer::CreatePoint_Fb(build_data, 1, 1);
    auto super_fb = Layer::CreateNode_Fb(build_data, build_data.CreateString("father"), position_fb);
    
    // friend
    auto friend_fb = Layer::CreateNode_Fb(build_data, build_data.CreateString("tom"), Layer::CreatePoint_Fb(build_data, 2, 2));
    
    // children
    std::vector<flatbuffers::Offset<Layer::Node_Fb>> nodeVector;
    auto child1 = Layer::CreateNode_Fb(build_data, build_data.CreateString("son"), Layer::CreatePoint_Fb(build_data, 3, 3));
    auto child2 = Layer::CreateNode_Fb(build_data, build_data.CreateString("daughter"), Layer::CreatePoint_Fb(build_data, 4, 4));
    nodeVector.push_back(child1);
    nodeVector.push_back(child2);
    
    auto children_fb = build_data.CreateVector(nodeVector);
    
    // layer
    auto layer_fb = Layer::CreateLayer_Fb(build_data, super_fb, friend_fb, children_fb);
    build_data.Finish(layer_fb);
}

六、保存序列化文件

buffer可以保存到本地或直接通過網(wǎng)絡(luò)發(fā)送。以下保存到本地的二進制文件中,GetBufferPointer()用來獲取buffer的內(nèi)存指針,GetSize()獲取內(nèi)存大小,最后一個參數(shù)用來指定是否生成二進制文件。

flatbuffers::SaveFile("layer.bin", reinterpret_cast<char*>(build_data.GetBufferPointer()), build_data.GetSize(), true);

七、反序列化

void deserialize() {
    
    // load binary file
    std::string binaryfile;
    bool ok = flatbuffers::LoadFile("layer.bin", false, &binaryfile);
    if (!ok) {
        return;
    }
    
    
    flatbuffers::FlatBufferBuilder builder_out;
    builder_out.PushBytes(reinterpret_cast<unsigned char*>(const_cast<char*>(binaryfile.c_str())), binaryfile.size());
    cout<<"deserialize size:"<<build_data.GetSize()<<endl;
    
    // verify
    flatbuffers::Verifier layer_verify(builder_out.GetCurrentBufferPointer(), build_data.GetSize());
    bool verify_flag = Layer::VerifyLayer_FbBuffer(layer_verify);
    if (!verify_flag) {
        return;
    }
    
    // read
    auto layer_fb = Layer::GetLayer_Fb(builder_out.GetCurrentBufferPointer());
    
    cout<<"father name:"+layer_fb->super()->name()->str()<<endl;
    cout<<"friend name:"+layer_fb->friend_()->name()->str()<<endl;
    
    for (int i=0; i<layer_fb->children()->Length(); i++) {
        string name = layer_fb->children()->Get(i)->name()->str();
        cout<<"child "<<i<<":"+name<<endl;
    }
    
}

完整代碼下載

參考文章:
https://google.github.io/flatbuffers/flatbuffers_guide_writing_schema.html
https://www.cnblogs.com/relvin/p/5540063.html
http://www.itdecent.cn/p/6eb04a149cd8

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容