Protobuf在iOS中的使用小结

Protobuf是Google公司内部的混合语言数据标准,全称是Google Protocol Buffer,Protobuf是一种更小、更快、更简单的结构化数据存储格式,可用于序列化返回数据,目前已经支持生成Java,Python,Objective-C,C++代码。

1、proto文件

iOS开发过程中需要用到.pbobjc.h和.pbobjc.m文件,这些文件都是使用Protobuf编译工具根据proto文件编译生成的。

1.1 proto文件格式

syntax = "proto3";

message SearchRequest {
  required string query = 1;  
  required int32 page_number = 2;
  optional int32 result_per_page = 3; 
}

1.2 限定修饰符说明

required:必须字段,必须设置该字段的值
optional:可选字段,有选择性的设置或者不设置该字段的值
repeated:表示该字段可以被重复任意多次包含

1.3 数据类型

proto文件有一套自定义基本数据类型,和当前的所有开发语言差不多,包括string,int32,float,double等等,具体数据类型请查看官方文档

2、Protobuf编译工具

2.1 构建Protobuf编译工具

要想在iOS开发中使用Protobuf,我们需要使用编译工具将proto文件生成Objective-C代码。首先检查下本地是否安装Homebrew:

$ brew -v

如果提示:-bash: brew: command not found,说明没有安装过,使用以下命令安装即可:

$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

安装成功后,使用Homebrew安装Protobuf Compiler:

$ brew install automake
$ brew install libtool
$ brew install protobuf

创建Protobuf Compiler符号链接(可选步骤):

$ ln -s /usr/local/Cellar/protobuf/2.6.1/bin/protoc /usr/local/bin

构建编译器,生成src/protoc二进制文件:

$ git clone https://github.com/protocolbuffers/protobuf.git
$ cd protobuf/objectivec/DevTools
$ ./full_mac_build.sh

构建完成。

2.2 生成平台相关代码

运行下边命令,将proto文件生成为平台相关代码(.pbobjc.h.pbobjc.m):

$ protoc ./xxxName.proto --objc_out=./

注意事项:

生成的.pbobjc.h.pbobjc.m文件直接拖入项目是无法使用的,编译会报错:

ARC forbids Objective-C objects in struct

这是因为生成的pbobjc文件是MRC的,采用手动引用计数,直接引入和ARC的项目是不兼容的,分两种情况来解决这个问题。

① 项目直接使用pbobjc文件

在Xcode的Targets --> Build Phases --> Compile Sources里边找到对应的pbobjc文件,将Compiler Flags设置为-fno-objc-arc即可。

② Pods的第三方库中使用pbobjc文件

这种情况第一种解决方案就不起作用了,因为pbobjc文件是打包在第三方库的代码中的,我们需要在这个第三方库的podSpec文件中处理这个问题。

non_arc_files = 'XXXXSDK/Classes/Pbobjc/XXXX.pbobjc.*'
s.exclude_files = non_arc_files
s.subspec 'no-arc' do |sp|
    sp.source_files = non_arc_files
    sp.requires_arc = false
end

2.3 安装protoc指定版本

比如指定tag:3.0.0
https://github.com/protocolbuffers/protobuf/releases/tag/v3.0.0
解压后执行
./autogen.sh
./configure
make
make check
sudo make install
最后执行protoc --version查看版本

3、项目使用

以上边的proto(SearchRequest)文件为例,来看下Protobuf在项目中如何使用。

3.1 序列化

- (NSData *)dataWithModel:(SearchRequest *)request {
    return [request data];
}

3.2 反序列化

- (SearchRequest *) modelWithProtobufData:(NSData *)data {
    return [SearchRequest parseFromData:data];
}

参考

Protobuf官方文档
Protobuf GitHub

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,128评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,316评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,737评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,283评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,384评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,458评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,467评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,251评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,688评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,980评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,155评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,818评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,492评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,142评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,382评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,020评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,044评论 2 352

推荐阅读更多精彩内容