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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容