iOS 的 Protocol Buffer 简单使用

简介

Protocol buffers are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data – think XML, but smaller, faster, and simpler. You define how you want your data to be structured once, then you can use special generated source code to easily write and read your structured data to and from a variety of data streams and using a variety of languages.

简单来说,Protocol Buffers 是一种和语言平台都没关的数据交换格式。

安装

Mac 安装

  1. 安装 protobuf 编译所需工具

    $ brew install automake
    $ brew install libtool
    
  2. 从 git 上拉取 protobuf 源码,并生成配置脚本

    $ git clone https://github.com/protocolbuffers/protobuf.git
    $ cd protobuf
    $ git submodule update --init --recursive
    $ ./autogen.sh
    
  3. 构建安装 protobuf 编译器

    $ ./configure
    $ make
    $ make check
    $ sudo make install
    

通过源码安装 protobuf 比较繁琐,也可以通过 brew 安装:

brew install protobuf

// Swift 版本需额外再安装swift-protoc
brew install swift-protobuf

Tips: 通过源码编译安装的路径一定不要有空格

iOS 安装

直接使用 pod 导入就行了:

pod 'Protobuf'

使用

1.创建.proto文件

proto3 语法可参考官方文档

创建一个 SimpleMessage.proto 文件,输入以下内容

syntax = "proto3";
package com.protobuf;
option objc_class_prefix = "Foo";

message SimpleMessage {
    int32 msgId = 1;
    string msgContent = 2;
}

在 Objective-C 中,是没有命名空间的概念,因此 package 是没什么效果的,但在 Swift 中则是有命名空间的概念。因此在 Objective-C 语言中,可通过 objc_class_prefix 来设置类名的前缀,而在 Swift 中,则是通过 package 来设置类名前缀

2.生成对应的iOS文件

在命令行终端中,使用我们刚刚安装的 protoc 命令编译我们编写的 proto 文件

// Objective-C
protoc SimpleMessage.proto --objc_out="./"

// Swift
protoc SimpleMessage.proto --swift_out="./"

网上的都说 protobuf 为了性能考虑,采用的是 MRC 模式,因此项目是使用 ARC 的话,则需要在 Compile Sources 中添加 -fno-objc-arc,但笔者不添加 -fno-objc-arc 也能正常运行。

3.使用

导入第二步生成的 SimpleMessage.pbobjc.hSimpleMessage.pbobjc.m 文件,FooSimpleMessage 继承 GPBMessage 类,我们可以像正常的 OC 对象一样使用它:

FooSimpleMessage *msg = [[FooSimpleMessage alloc] init];
msg.msgId = 1;
msg.msgContent = @"A protobuf message content";
NSLog(@"%@", msg);
NSData *data = msg.data;
NSError *error;
FooSimpleMessage *decodeMsg = [FooSimpleMessage parseFromData:data error:&error];
if (!error) {
    NSLog(@"%@", decodeMsg);
}

打印结果为:


打印结果.png

4.与服务器通信

与服务器的通信直接传递 Protobuf 序列化后的Data即可,客户端收到服务器返回的 Protobuf 序列后的Data,直接使用 parseFromData:error: 方法转换成对应的对象即可。

注意:服务端和客户端最好使用同一个版本的 .proto 文件生成的文件来进行序列化和反序列化

5.其他

在使用 Protobuf 序列化对象的时候,有两个方式序列化成数据流:msg.datamsg.delimitedData,通过 delimitedData 序列化后的数据流前面添加整体数据流的长度(不包括自己),因此👆的反序列方法是会出错的,应该用👇的方法反序列化:

NSData *delimitedData = msg.delimitedData;
GPBCodedInputStream *inputStream = [GPBCodedInputStream streamWithData:delimitedData];
FooSimpleMessage *decodeMsg = [FooSimpleMessage parseDelimitedFromCodedInputStream:inputStream extensionRegistry:nil error:&error];

客户端要和服务端协商统一是用 data 还是 delimitedData


以上就是关于 Protobuf 的简单使用了,GitHub Demo

跳下一篇 Protobuf 数据格式

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