flatBuffer安裝及使用教程

1、什么是flatBuffer:

FlatBuffers為Google發布的一個跨平臺，提供多種語言接口，注重性能和資源使用的序列化類庫。目前該類庫提供C++, C#, C, Go, Java, JavaScript, PHP, and Python語言接口。該序列化類庫多用于移動端手游數據傳輸以及特定的對性能有較高要求的應用。
接下來我們將學習FlatBuffers環境搭建并且使用PHP語言完成一次簡單的序列化例子。

• 編譯flatc工具
• 編寫一個FlatBuffers的scheme文件
• 使用flatc工具編譯scheme文件，生成對應語言的數據對象頭文件／類
• 使用FlatBufferBuilder序列化對象

• 反序列化數據對象

  2、安裝:

  編譯工具flatc工具，首先要先裝Cmake(推薦apt-get install cmake)
  (1)下載FlatBuffers源碼,從gitHub上下載項目源代碼：

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

  (2)進入flatbuffers項目根目錄，輸入如下命令

  cmake -G "Unix Makefiles" //生成MakeFile
  make //生成flatc
  make install //安裝flatc

  (3)查看flatc，如下圖

  flatc --version

3、編寫FlatBuffers的scheme文件:

     // Example IDL file for our monster's schema.
        namespace com.zeyuan.learning;
        enum Color:byte { Red = 0, Green, Blue = 2 }
        union Equipment { Weapon } // Optionally add more tables.
        struct Vec3 {
            x:float;
            y:float;
            z:float;
        }
        table Monster {![](https://s1.51cto.com/images/blog/201805/30/176b5bec853b087070ba6afba8905488.jpg?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_100,g_se,x_10,y_10,shadow_90,type_ZmFuZ3poZW5naGVpdGk=)
            pos:Vec3; // Struct.
            mana:short = 150;
            hp:short = 100;
            name:string;
            friendly:bool = false (deprecated);
            inventory:[ubyte];  // Vector of scalars.
            color:Color = Blue; // Enum.
            weapons:[Weapon];   // Vector of tables.
            equipped:Equipment; // Union.
        }
        table Weapon {
            name:string;
            damage:short;
        }
        root_type Monster;

4、編譯Schema文件:

• 將上節編寫的scheme文件保存為test.fbs文件，到該文件所在文件夾下，執行

  flatc [ GENERATOR OPTIONS ] [ -o PATH ] [ -I PATH ] [ -S ] FILES… [ – FILES…]

定義文件按照順序被讀取和編譯,還可以包含其他定義文件和數據(詳情 見下面).
任意個定義文件可能生成一個或者多個定義文件,這取決于附加的命令選項

• --cpp,-c :按照定義生成C++頭文件
• --java,-j :按照定義生成Java代碼
• --csharp,-n :按照定義生成C#代碼
• --go,-g :按照定義生成Go代碼
• --python,-p :按照定義生成python打底嗎
• --javascript,-s :按照定義生成JavaScript
• --php :按照定義生成php
  數據序列化格式選項
• --binary,-b :序列化成.bin 后綴的二進制格式,
• --json,-t :序列化成.json 后綴的json格式,
  其他選項
• -o PATH :輸出搜有生成的文件到Path(絕對路徑,或者相對于當前目錄)路徑,如果省略,Path就是當前目錄.路徑末尾因該是你的系統分隔符\或者/.
• -I PATH :當遇見include聲明,試圖讀取文件的時候將從此路徑按照順序查找,如果失敗,就按照相對路徑查找
• -M :打印Make規則到生成文件
• --strict-json :要求生成嚴格的json文件(名字等字段包含在引號中,table和Vector末尾沒有逗號),默認 在required/generated時沒有引號,末尾逗號是允許的
• ---defaults-json :當輸出json文件本的時候輸出字段等于默認值
• ---no-prefix :當生成C++頭文件時 枚舉值不包含枚舉類型的前綴
• ---scoped-enums :使用C++11風格作用域和強類型枚舉生成C++,也就意味著 --no-prefix
• ---no-includes :不生成包含include模式的代碼,(依賴C++)
• ---gen-mutable :為可變的FlatBuffers生成額外的non-const訪問器
• ---gen-onefile :生成一個定義文件(用于C#)

執行以下代碼：

flatc --php test.fbs

將會生成php語言的類文件定義，如果你想為別的語言生成相應的類文件可查看以上選項，如圖。

參考：
1.如何寫Scheme：https://google.github.io/flatbuffers/flatbuffers_guide_writing_schema.html
2.flatc編譯說明：https://blog.csdn.net/u010893023/article/details/50470835
3.flat安裝教程：https://www.jianshu.com/p/8df23cd182ec