高效数据序列化的工具 FlatBuffers 的初体验

1. 背景

最近在项目中须要使用一种高效数据序列化的工具。碰巧在几篇文章中都提到了FlatBuffers 这个库。特别是 Android 性能优化典范第四季1中两个对比图，让我对它产生浓厚的兴趣。以下：

（注：图片来自1）

可见，FlatBuffers 几乎从空间和时间复杂度上完胜其余技术，我决定详细调研一下此技术。

FlatBuffers 是一个开源的跨平台数据序列化库，能够应用到几乎任何语言（C++, C#, Go, Java, JavaScript, PHP, Python），最开始是 Google 为游戏或者其余对性能要求很高的应用开发的。项目地址在 GitHub 上。官方的文档在 这里。

本文将介绍一下我使用 FlatBuffers 的一些感觉，但愿对想要了解或者使用 FlatBuffers 的同窗有一点帮组。

2. FlatBuffer 的优势

FlatBuffer 相对于其余序列化技术，例如 XML，JSON，Protocol Buffers 等，有哪些优点呢？官方文档的说法以下：

1. 直接读取序列化数据，而不须要解析（Parsing）或者解包（Unpacking）：FlatBuffer 把数据层级结构保存在一个扁平化的二进制缓存（一维数组）中，同时可以保持直接获取里面的结构化数据，而不须要解析，而且还能保证数据结构变化的先后向兼容。
2. 高效的内存使用和速度：FlatBuffer 使用过程当中，不须要额外的内存，几乎接近原始数据在内存中的大小。
3. 灵活：数据可以先后向兼容，而且可以灵活控制你的数据结构。
4. 不多的代码侵入性：使用少许的自动生成的代码便可实现。
5. 强数据类性，易于使用，跨平台，几乎语言无关。

官方提供了一个性能对比表以下：

（注：来自 官方文档）

在作 Android 开发的时候，JSON 是最经常使用的数据序列化技术。咱们知道，JSON 的可读性很强，可是序列化和反序列化性能倒是最差的。解析的时候，JSON 解析器首先，须要在内存中初始化一个对应的数据结构，这个事件常常会消耗 100ms ~ 200ms2；解析过程当中，要产生大量的临时变量，形成 Java 虚拟机的 GC 和内存抖动，解析 20KB 的数据，大概会消耗 100KB 的临时内存2。FlatBuffers 就解决了这些问题。

3. 使用方法

简单来讲，FlatBuffers 的使用方法是，首先按照使用特定的 IDL 定义数据结构 schema，而后使用编译工具 flatc 编译 schema 生成对应的代码，把生成的代码应用到工程中便可。下面详细介绍每一步。

首先，咱们须要获得 flatc，这个须要从源码编辑获得。从 GitHub 上 Clone 代码，

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

在 Mac 上，使用 Xcode 直接打开 build/Xcode/ 里面项目文件，编译运行，便可在项目根目录生成咱们须要的 flatc 工具。也可使用 cmake 编辑，例如在 Linux 上，运行以下命令便可：

$ cmake -G "Unix Makefiles"
$ make

首先要使用 FlatBuffers 的 IDL 定义好数据结构 Schema，编写 Schema 的详细文档在这里。其语法和 C 语言相似，比较容易上手。咱们这里引用一个简单的例子2，假设数据结构以下：

class Person {  
    String name;
    int friendshipStatus;
    Person spouse;
    List<Person>friends;
}

编写成 Schema 以下，文件名为 Person.fbs：

// Person schema

namespace com.race604.fbs;

enum FriendshipStatus: int {Friend = 1, NotFriend}

table Person {  
  name: string;
  friendshipStatus: FriendshipStatus = Friend;
  spouse: Person;
  friends: [Person];
}

root_type Person;

而后，使用 flatc 能够把 Schema 编译成多种编程语言，咱们仅仅讨论 Android 平台，因此把 Schema 编译成 Java，命令以下：

$ ./flatc --java Person.fbs

在当前目录生成以下文件：

.
└── com
    └── race604
        └── fbs
            ├── FriendshipStatus.java
            └── Person.java

Person 类有响应的函数直接获取其内部的属性值，使用很是简单：

Person person = ...;  
// 获取普通成员
String name = person.name();  
int friendshipStatus = person.friendshipStatus();  
// 获取数组
int length = person.friendsLength()  
for (int i = 0; i < length; i++) {  
    Person friends = person.friends(i);
    ...
}

下面咱们来构建一个 Person 对象，名字是 "John"，其配偶（spouse）是 "Mary"，还有两个朋友，分别是 "Dave" 和 "Tom"，实现以下：

private ByteBuffer createPerson() {  
    FlatBufferBuilder builder = new FlatBufferBuilder(0);
    int spouseName = builder.createString("Mary");
    int spouse = Person.createPerson(builder, spouseName, FriendshipStatus.Friend, 0, 0);

    int friendDave = Person.createPerson(builder, builder.createString("Dave"),
            FriendshipStatus.Friend, 0, 0);
    int friendTom = Person.createPerson(builder, builder.createString("Tom"),
            FriendshipStatus.Friend, 0, 0);

    int name = builder.createString("John");
    int[] friendsArr = new int[]{ friendDave, friendTom };
    int friends = Person.createFriendsVector(builder, friendsArr);

    Person.startPerson(builder);
    Person.addName(builder, name);
    Person.addSpouse(builder, spouse);
    Person.addFriends(builder, friends);
    Person.addFriendshipStatus(builder, FriendshipStatus.NotFriend);

    int john = Person.endPerson(builder);
    builder.finish(john);

    return builder.dataBuffer();
}

基本方法就是经过 FlatBufferBuilder 工具，往里面填写数据，详细的写法能够参考官方文档3。可见，其实写法略显繁琐，不太直观。

4. 基本原理

如官方文档的介绍，FlatBuffers 就像它的名字所表示的同样，就是把结构化的对象，用一个扁平化（Flat）的缓冲区保存，简单的来讲就是把内存对象数据，保存在一个一维的数组中。借用 Facebook 文章2的一张图以下：

可见，FlatBuffers 保存在一个 byte 数组中，有一个“支点”指针（pivot point）以此为界，存储的内容分为两个部分：元数据和数据内容。其中元数据部分就是数据在前面，其长度等于对象中的字段数量，每一个 byte 保存对应字段内容在数组中的索引（从支点位置开始计算）。

如图，上面的 Person 对象第一个字段是 name，其值的索引位置是 1，因此从索引位置 1 开始的字符串，就是 name 字段的值 "John"。第二个字段是 friendshipStatus，其索引值是 6，找到值为 2， 表示 NotFriend。第三个字段是 spouse，也一个 Person 对象，索引值是 12，指向的是此对象的支点位置。第四个字段是一个数组，图中表示的数组为空，因此索引值是 0。

经过上面的解析，能够看出，FlatBuffers 经过本身分配和管理对象的存储，使对象在内存中就是线性结构化的，直接能够把内存内容保存或者发送出去，加载“解析”数据只须要把 byte 数组加载到内存中便可，不须要任何解析，也不产生任何中间变量。

它与具体的机器或者运行环境无关，例如在 Java 中，对象内的内存不依赖 Java 虚拟机的堆内存分配策略实现，因此也是跨平台的。

5. 使用建议

经过前面的体验，FlatBuffers 几乎秒杀了 JSON，我也尝试使用到如今的项目中，可是最后仍是放弃了，下面说说 FlatBuffers 的几点缺点：

1. FlatBuffers 须要生成代码，对代码有侵入性；
2. 数据序列化没有可读性，不方便 Debug；
3. 构建 FlatBuffers 对象比较麻烦，不直观，特别是若是对象比较复杂状况下须要写大段的代码；
4. 数据的全部内容须要使用 Schema 严格定义，灵活性不如 JSON。

我最后在项目中放弃是由于上面的第 4 点，由于在个人项目中，数据结构变化很大，不方便使用 Schema 彻底定义。话又说回来，FlatBuffers 这么多好处，仍是很吸引个人，可能会在其余的项目中尝试。

因此，在什么状况下选择使用 FlatBuffers 呢？我的感受须要知足如下几点：

1. 项目中有大量数据传输和解析，使用 JSON 成为了性能瓶颈；
2. 稳定的数据结构定义。

---

参考资料：

1. http://geek.csdn.net/news/detail/50692 ↩

2. https://code.facebook.com/posts/872547912839369/improving-facebook-s-performance-on-android-with-flatbuffers/ ↩

3. http://google.github.io/flatbuffers/flatbuffersguidetutorial.html ↩

4. http://frogermcs.github.io/flatbuffers-in-android-introdution/ ↩