Protocol Buffer介绍
以下翻译自维基百科:
Protocol Buffer是一套序列化数据结构的方案,通常用于编写需要数据交换或者需要存储数据的程序。这套方案包含一种用于描述数据结构的接口描述语言(Interface Description Language)和一个生成器,用于生成描述该数据结构的不同编程语言的源代码。
其中有一个特定的用于Android移动设备的Nano版本,相比原来的版本,去掉了一些复杂的特性,所生成的代码更加小巧、简单,更加适用于移动设备。
Protocol Buffer的源代码可以在https://github.com/android/platform_external_protobuf 中下载
编译protoc和所需的库文件
- 编译需要用到GCC,maven等工具,根据说明先将依赖工具安装好
- 下载好代码后,在Linux中根据说明编译出protoc,该命令用于生成不同编程语言的代码。
- 要在android平台上使用Protocol Buffer Nano,需要生成一个库文件,进入/protobuf/java目录,执行以下命令:
mvn test //执行测试,如果测试失败的话,则有可能不能正常工作
mvn install //生成所需要的库文件
- 执行完上述命令后,会在/protobuf/java/target里生成3个库文件,我们只需要Nano版本的,即protobuf-java-2.3.0-nano.jar,将它拷贝到android项目中
将.proto文件编译生成Java文件
使用protoc Nano生成器生成具体的代码,以下是一些可能用到的编译选项,选项之间用逗号隔开(大括号中的为可选值):
-
optional_field_style={default,accessors,reftypes},定义每个字段所生成的代码的格式:
- default:proto中每个字段生成一个public的可变的值;
- accessors:proto中每个optional字段会封装成一个private的值和4个用于操作该值的方法,分别是get<fieldname>(), set<fieldname>(), has<fieldname>()和clear<fieldname>(),在accessors选项中,required字段依旧是生成public的可变的值,repeated字段依旧是生成一个array;
要注意的是,当启用accessors选项时,使用Proguard混淆时,一定禁用-dontoptimize选项和启用-allowaccessmodification选项,这能够在项目编译时去掉那些没被调用的方法,减少最终的代码量; - reftypes:proto中每个字段都会生成一个public的可变的值,与default不同的是,对于每个基本数据类型,如int,float等,都会使用Java对应的内建类型,并初始化为null(比如int会使用Java.lang.Integer类来替代),这样会带来额外的开销,好处是你可以避免歧义,比如optional int的字段,收到为0的值时,会分不清到底传来的值是0,还是这个字段为空
enum_style={c,java} (default: c),定义枚举的格式,使用java style。
ignore_services={true,false} (default: false),Protobuf Nano不支持services,如果在proto文件中定义了services,会导致编译错误,将该选项置为true,在编译时会忽略services相关的内容。
parcelable_messages={true,false} (default: false),这个选项很重要,在android中,Parcelable是序列化对象的接口,很多数据交换都要应用到这个接口,比如Intent,和进程间通信。开启该选项,Protobuf Nano所生成的Java对象都会自动实现Parcelable接口,Intent和进程间通信就能直接使用这些对象。
具体到我们的项目,用到的编译命令如下:protoc --javanano_out=enum_style=java,optional_field_style=accessors,parcelable_messages=true:. JoyProtocol.proto