浅谈protocolbuffer

介绍

在不同平台通信的时候，首先需要将对象进行序列化。iOS平台上我们常用NSKeyedArchiver进行归档，当然也可以将数据处理为JSON或者XML格式。NSKeyedArchiver只能在iOS/Mac平台使用，因此它归档的二进制数据不适合于在不同平台之间使用。JSON和XML虽然由于容易维护，易读而应用比较广泛，但是对数据的利用效率都不是高。Google提出了 Protocol Buffers 作为一种跨平台、语言无关的序列化数据格式。Protocol Buffers提供代码生成工具，能够根据定义好的数据格式生成不同语言的代码，然后集成到项目中使用。Protocol Buffers目前有两种格式：proto2和proto3。Protocol Buffers支持Java、Python、C++、Objective-C等代码的生成。

准备工作

1. 下载Protocol Buffers的源码(下载地址)，也可以到官网上下载。

2. 编译Protocol Buffers。虽然我们是可以直接将它的代码或者项目引入Xcode中，但是还是需要编译重要的代码生成工具（protoc）。由于Protocol Buffers编译时使用了autoconf/automake/libtool等UNIX工具，Mac可能没有自带，需要手动安装。我们可以使用HomeBrew或者MacPort进行安装(二选一就行)。

   • 使用 HomeBrew 安装:

   $ brew install autoconf
   $ brew install automake
   $ brew install libtool
   

   • 使用 MacPort 安装:

   $ sudo port install autoconf automake libtool
   

README.md中说可以直接用./configure进行配置并编译运行了，但实际还差一步，就是运行./autogen.sh脚本，否则会发生错误。然而遗憾的是，autogen.sh中会下载https://googlemock.googlecode.com/files/gmock-1.7.0.zip。gmock处于 墙外 ，只能用梯子出去取（没梯子的可以找 戴维营教育 交流群免费索取，会不会被请喝茶啊）。

没有运行autogen.sh的场景：

$ ./configure --with-protoc=protoc
$ ./configure: line 2215: syntax error near unexpected token 'enable'
$ ./configure: line 2215: 'AM_MAINTAINER_MODE(enable)'

一旦打开VPN了，运行下面的脚本：

$ ./autogen.sh
$ ./configure
$ make
# 如果希望安装protoc，执行下面的命令
$ make install

实现原理

使用之前安装的三个库，用来生成Objective-C 代码

根据定义的 protoc 模板文件，生成Objective-C 模型类，这个类实现了data方法

这个方法会生成 二进制文件流，然后网络传输的时候 正是传的这个二进制流，相比JSON要小一些

节省流量 解析速度也快，重要还是跨平台（比较麻烦的是生成这个实体类，如果要添加字段啥的还要再 重新编译一下）

iOS中使用Protocol Buffers

1. 创建 proto 文件指定数据格式，可以选择proto2和proto3格式，它们有些细微的区别，在生成代码的时候会提示的，具体情况查看文档Language Guide proto3。下面使用proto3格式，并且保存为Person.proto。

syntax = "proto3";

message Person {
  string name = 1;
  int32 uid = 2;
  string email = 3;

  enum PhoneType {
    MOBILE = 0;
    HOME = 1;
    WORK = 2;
  }

  message PhoneNumber {
    string number = 1;
    PhoneType type = 2;
  }

  repeated PhoneNumber phone = 4;
}

1. 使用 protoc 工具生成Objective-C代码。其中--proto_path=后跟需要处理的proto文件所在的文件夹，--objc_out=指明生成的是Objective-C代码以及目标文件存放路径，最后是需要处理的文件。

$ protoc --proto_path=. --objc_out=. Person.proto
$ ls
Person.pbobjc.h    Person.pbobjc.m    Person.proto

处理完成后，生成两个文件，分别是 Person.pbobjc.h 和 Person.pbobjc.m 。这两个文件是采用的手动引用计数，因此在加入项目后需要设置它们的编译参数。

1. 为了方便管理，我们直接将Protocol Buffers中的iOS静态库项目引入进来。当然，如果喜欢用C++的话，可以直接将C++代码导入项目，记得设置 Header Search Paths 或者 User Header Search Paths 。

设置依赖和连接库。

1. 引入头文件开始使用。

实例使用:

#import "GPBProtocolBuffers.h"
#import "Person.pbobjc.h"

- (void)viewDidLoad {
    [super viewDidLoad];

    Person *person = [[Person alloc] init];
    person.name = @"Zhangsan";
    person.email = @"diveinedu@qq.com";
    person.uid = 23;
    NSData *data = [person data];

    NSString *path = @"/Users/apple/Desktop/test.data";
    [data writeToFile:path atomically:YES];

    NSData *ldata = [NSData dataWithContentsOfFile:path];
    Person *p = [Person parseFromData:ldata error:nil];
    NSLog(@"\nname:%@\nemail:%@\nuid:%d", p.name, p.email, p.uid);
}