iOS ProtocolBuffer

http://www.cnblogs.com/uniy/archive/2011/12/21/2296405.html

http://www.kelvinkaodev.com/blog/2010/08/compiling-the-protocol-buffer-compiler-for-objective-c/

一、ProtocolBuffer 官网

https://code.google.com/p/protobuf/

Protocol Buffers 是一种轻便高效的结构化数据存储格式，可以用于结构化数据串行化，或者说序列化。

二、protobuf的使用

1、编译Protocol Buffers，生成 protoc 执行命令文件

　　A.下载Protocol Buffers源码并解压，进到ProtocolBuffers-2.2.0-Source目录看看会发现有个src目录。用命令切换至ProtocolBuffers-2.2.0-Source目录下。

下载地址: http://code.google.com/p/metasyntactic/downloads/list

　　B.  ./autogen.sh

　　C.  ./configure (如果说没有权限，chmod +x configure)

　　D.  make

2、生成Object-C代码

proto文件是核心，如何创建一个结构化的数据。

https://developers.google.com/protocol-buffers/docs/proto

官方文档有详细的介绍。

proto 文件，定义我们程序中需要处理的结构化数据，在 protobuf 的术语中，结构化数据被称为 Message。proto 文件非常类似 java 或者 C 语言的数据定义。

下面以一个proto文件例子举例

　　A.创建一个Person.proto文件（例子）把该文件存放至刚才提到的src目录下，文件内容如下：

 1 message Person {
 2 required string name = 1;
 3 required int32 id = 2;
 4 optional string email = 3;
 5 
 6 enum PhoneType {
 7 MOBILE = 0;
 8 HOME = 1;
 9 WORK = 2;
10 }
11 
12 message PhoneNumber {
13 required string number = 1;
14 optional PhoneType type = 2 [default = HOME];
15 }
16 
17 repeated PhoneNumber phone = 4;
18 }

　　B. ProtocolBuffers-2.2.0-Source 下创建这样一个子目录 build/objc 以便存放我们生成的classes

现在执行命令:

./protoc --proto_path=../test/ --objc_out=../test/ ../test/Place.proto

成功后会在 ../test/ 下生成Person.pd.h 和 Person.pb.m 两个Object-C文件

../test/ 目录可以随意创建，过程就是 protoc命令 将 ../test/ 下的 person.proto 文件，生成 .pd.h、.pd.m 文件，文件就保存在 ../test/ 里。

3、测试

　　A.新建一个项目ProtobufDemo，将刚才生成的两个文件加入项目。然后将ProtocolBuffers-2.2.0-Source/objectivec 下的文件放到项目的目录下，最好放在一个文件夹下面像这样

创建一个ProtobufLib文件夹，放进去.

　　B.之后把ProtocolBuffers.xcodeproj添加到项目中,我习惯将它放到Frameworks下。

　　C.然后双击Targets下的ProtobufDemo,点击+添加,之后做一些配置,like this

在.pch文件中导入 #import "ProtocolBuffers.h"

配置好这些之后编译你的项目，应该不会报错了吧。

demo核心代码

- (void)loadView {
    [super loadView];
    
    Person *person = [[[[[Person builder] setName:@"uniy"]
                      setId:7] 
                      setEmail:@"abc@163.com"] build];
    NSData *data = [person data];
    
    NSString *docPath = [self applicationDocumentsDirectory];
    NSString *path = [docPath stringByAppendingFormat:@"/person.data"];
    
    if ([data writeToFile:path atomically:YES]) {
        [self readFileWithPath:path];
    } 
    
}

- (NSString *)applicationDocumentsDirectory {
    
    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
    NSString *basePath = ([paths count] > 0) ? [paths objectAtIndex:0] : nil;
    return basePath;
}

- (void)readFileWithPath:(NSString *)path {
    
    NSData *data = [NSData dataWithContentsOfFile:path];
    Person *person = [Person parseFromData:data];
    
    if (person) {
        NSLog(@"\n id %d \n name: %@ \n email: %@ \n",person.id, person.name, person.email);
    }
}

ProtocolBuffers-2.2.0-Source/objectivec 那个工程是比较早的了，在用 LLVM 4.1 编译的时候报错，改成 LLVM GCC 4.2 编译成功
1. 一个错误是 PBExtensionType 在做 switch 的时候没有 default:，编译的时候报错。
2. 另一个错误是 id builder = [messageOrGroupClass builder];
builder之后的 object 不知道 一定支持 PBMessage_Builder 协议