iOS序列化的进阶方案——Protocol Buffer

前言

最近项目需要，引入Protocol Buffer来做对象序列化。

正文

Protocol Buffer是Google出的序列化数据格式，下面简称pb。
我们更常用的序列化数据格式应该是json，json和pb本质上都是对象的序列化和反序列化，在项目中json也是前后端通信的主要数据格式。
在本地存储时，我们可以使用YYModel将对象转成json对应的NSData，也可以使用NSKeyedArchiver结合实现NSCoding协议把对象转成NSData，进而将二进制数据存储在沙盒中或者数据库。
那么为什么不使用json，而要用pb？
因为项目中序列化数据到沙盒是一个高频场景，尝试过数据库、NSCoding+NSKeyedArchiver、YYModel等方法都有各自瓶颈：数据内容比较大数据库会造成体积膨胀过快不便管理，NSCoding+NSKeyedArchiver在序列化数据量较大的情况下性能不佳，YYModel在变动的时候不太友好。

相对而言，pb有以下特点：
1、pb是一种可扩展的序列化数据数据格式，新老版本的数据可以相互读取；
2、pb是使用字节流方式进行序列化，体积小速度快；（相对而言json是用字符串表示的，光表示字符串的""符号就有很多）
3、pb的代码是由描述文件proto生成，proto是文本文件便于做版本管理；

pb的使用

使用pb首先要定义proto的数据结构，语法非常简单，可以直接上手写：

syntax = "proto3";
message LYItemData {
    uint32 itemId = 1;
    string itemContentStr = 2;
}

这里定义一个最简单的message，第一行是声明proto的版本，然后添加两个属性itemId和itemContentStr；
使用的时候，用[LYItemData parseFromData:data error:nil];可以将NSData转换成对象，访问LYItemData类的data属性，可以拿到其序列化之后的二进制数据；
代码很简单， 序列化和反序列化都只有一行，使用样例：

    NSString *path = [NSHomeDirectory() stringByAppendingPathComponent:@"test_data"];
    NSData *data = [[NSData alloc] initWithContentsOfFile:path];
    LYItemData *itemData;
    if (data) {
        itemData = [LYItemData parseFromData:data error:nil]; // 反序列化
    }
    else {
        itemData = [LYItemData new];
        itemData.itemId = (int)time(NULL);
        itemData.itemContentStr = [self timeStampConversionNSString:itemData.itemId];
        [[NSFileManager defaultManager] createFileAtPath:path contents:itemData.data attributes:nil]; // 访问itemData.data属性时会做一次序列化
    }

message可以定义容器类型，包括数组、map等；
定义数组使用repeated，表示该元素是重复的，数量从0到若干个不等；
定义字典使用map，map里面带两个参数，分别表示key和value的type；

message LYArrayData {
    repeated LYItemData items = 1;
    map idToContentStrMap = 2;
}

也可以在message中声明另外一个message 的属性

message LYProtobufLocalData {
    uint64 dataId = 1;
    string dataContentStr = 2;
    uint32 updateTime = 3;
    LYArrayData arrData = 4;
}

了解这些常见的message定义方式，就可以满足大多数开发，其他用到再学也不迟。
其他使用方式例如any、oneof、reserved、enum、import、package可以自行探究，我们项目中没有使用到。
不管哪种定义方式，在定义成员属性的时候，都需要指定一个数字，这个数字是tag，需要保证在类中是唯一的。
tag是属性的唯一标识符，pb会在存储和读取的时候用到这个属性。

注意事项：
属性定义之后，tag不能改变；如果有弃用的属性，最好用reserved声明其属性名字和tag；
新老版本都能读取对应的二进制数据，对于不认识的属性会保留默认值。

代码生成

代码生成可以和Xcode结合，在每次编译之后自动生成。
在 Build Phases 里面添加一段脚本（下图中的Run Proto）：先cd到proto所在的目录，然后运行脚本即可。

cd ${SOURCE_ROOT}/LearnProtoBuf/PB/
./protoc ProtobufData.proto --objc_out=./

记得在对应目录下添加protoc文件，也可以添加到git仓库同步其他人使用，这样别人即使没安装proto也可以生成代码。

如果项目中有多个proto，此处可以使用sh脚本，把路径名作为参数传入，在sh脚本里面分别对每个proto文件做代码生成。

如果不想使用这种方式，也可以按照传统方法先安装protobuf，网上教程比较多，这里不再赘述。

总结

在Restful架构逐渐被RPC架构淘汰的现在，pb取代json作为前后端的通信数据格式也是时代的潮流。
json最大的优势或许是后端已有的很多服务都是用json通信，一时间无法完全替换。
pb简单易用，对持续变更更加友好。
一次定义，多端使用；
版本更迭，格式兼容。

附录

官方参考文档--OC代码生成
PB-Github
二进制encode原理