本文来自网易云社区。

总览

 

先来看一下 FlatBuffers 项目已经为我们提供了什么，而我们在将 FlatBuffers 用到我们的项目中时又需要做什么的整体流程。如下图：

 

 

 

在使用 FlatBuffers 时，我们需要以特殊的格式定义我们的结构化数据，保存为 .fbs 文件。FlatBuffers 项目为我们提供了编译器，可用于将 .fbs 文件编译为Java文件，C++文件等，以用于我们的项目。FlatBuffers 编译器在我们的开发机，比如Ubuntu，Mac上运行。这些源代码文件是基于 FlatBuffers 提供的Java库生成的，同时我们也需要利用这个Java库的一些接口来序列化或解析数据。

 

我们将 FlatBuffers 编译器生成的Java文件及 FlatBuffers 的Java库导入我们的项目，就可以用 FlatBuffers 来对我们的结构化数据执行序列化和反序列化了。尽管每次手动执行 FlatBuffers 编译器生成Java文件非常麻烦，但不像 Protocol Buffers 那样，当前还没有Google官方提供的gradle插件可用。不过，我们这边开发了一个简单的 FlatBuffers gradle插件，后面会简单介绍一下，欢迎大家使用。

 

接下来我们更详细地看一下上面流程中的各个部分。

 

下载、编译 FlatBuffers 编译器

 

我们可以在如下位置：

 

获取官方发布的打包好的版本。针对Windows平台有编译好的可执行安装文件，对其它平台还是打包的源文件。我们也可以指向clone repo的代码，进行手动编译。这里我们从GitHub上clone代码并手动编译编译器：

 

下载代码之后，我们需要用cmake工具来为flatbuffers生成Makefile文件并编译：

 

安装之后执行如下命令以确认已经装好：

flatc没有为我们提供 –help 选项，不过加了错误的参数时这个工具会为我们展示详细的用法：

 

创建 .fbs 文件

 

flatc支持将为 Protocol Buffers 编写的 .proto 文件转换为 .fbs 文件，如：

 

Protocol Buffers 消息文件中的一些写法，FlatBuffers 编译器还不能很好的支持，如option java_package，option java_outer_classname，和嵌套类。这里我们基于 FlatBuffers 编译器转换的 .proto 文件来获得我们的 .fbs 文件：

 

可以参考 官方的文档 来了解 .fbs 文件的详细的写法。

编译 .fbs 文件

 

可以通过如下命令编译 .fbs 文件：

 

–java用于指定编译的目标编程语言。-o 参数则用于指定输出文件的路径，如过没有提供则将当前目录用作输出目录。FlatBuffers 编译器按照为不同的数据结构声明的namespace生成目录结构。对于上面的例子，会生成如下的这些文件：

 

在Android项目中使用 FlatBuffers

 

我们将前面由 .fbs 文件生成的Java文件拷贝到我们的项目中。我们前面提到的，FlatBuffers 的Java库比较薄，当前官方并没有发布到jcenter这样的maven仓库中，因而我们需要将这部分代码也拷贝到我们的额项目中。FlatBuffers 的Java库在其repo仓库的 java 目录下。我们有将这部分代码打包，放在公司的maven仓库中，引用的方法为，修改应用程序的 build.gradle：

 

添加访问 FlatBuffers 的类：

 

使用 flatbuf-gradle-plugin

 

我们有开发一个 FlatBuffers 的gradle插件，以方便开发，项目位置。这个插件的设计有参考Google的protobuf-gradle-plugin，功能及用法也与protobuf-gradle-plugin类似。

 

应用flatbuf-gradle-plugin

修改应用程序的 build.gradle 以应用flatbuf-gradle-plugin。

为buildscript添加对flatbuf-gradle-plugin的依赖：
buildscript {
repositories {
maven {
url "http://mvn.hz.netease.com/artifactory/libs-releases/"
}
maven {
url "http://mvn.hz.netease.com/artifactory/libs-snapshots/"
}
}
dependencies {
classpath "com.netease.hearttouch:ht-flatbuf-gradle-plugin:0.0.1-SNAPSHOT"
}
}

在apply plugin: "com.android.application"后面应用flatbuf的plugin：
apply plugin: "com.android.application"
apply plugin: "com.netease.flatbuf"

添加flatbuf块，对flatbuf-gradle-plugin的执行做配置：
flatbuf {
flatc {
path = “/usr/local/bin/flatc”
}
generateFlatTasks {
all().each { task ->
task.builtins {
remove java
}
task.builtins {
java { }
}
}
}
}
flatc块用于配置 FlatBuffers 编译器，这里我们指定用我们之前手动编译的编译器。 task.builtins的块必不可少，这个块用于指定我们要为那些编程语言生成代码，这里我们为Java生成代码。

添加flatbuf块，对flatbuf-gradle-plugin的执行做配置：

flatc块用于配置 FlatBuffers 编译器，这里我们指定用我们之前手动编译的编译器。 task.builtins的块必不可少，这个块用于指定我们要为那些编程语言生成代码，这里我们为Java生成代码。

指定 .fbs 文件的路径
sourceSets {
main {
flat {
srcDir “src/main/flat”
}
}
}
我们将 FlatBuffers 的IDL文件放在src/main/flat目录下。

这样我们就不用再那么麻烦每次手动执行flatc了。

相关阅读：

在Android中使用FlatBuffers（上篇）

在Android中使用FlatBuffers（中篇）

在Android中使用FlatBuffers（下篇）

网易云新用户大礼包：https://www.163yun.com/gift

本文来自网易云社区，经作者韩鹏飞授权发布。