iOS ProtocolBuffer环境配置与使用

Protocol Buffer是Google出品的一种轻量高效的结构化数据存储格式

🍎 AppStore:记录Box

Swift

一、环境配置

可以直接使用brew install swift-protobuf安装

也可以按如下步骤配置:

1.Clone Protobuf

https://github.com/apple/swift-protobuf

$ git clone https://github.com/apple/swift-protobuf.git
$ cd swift-protobuf

2.选择tag并构建protoc插件

// 列出所有tag
$ git tag -l
// 选择某个tag,我是选择最新的
$ git checkout tags/[tag_name]
// 构建
$ swift build -c release

构建完成后会在swift-protobuf/.build/release路径下生成protoc-gen-swift

然后复制protoc-gen-swift到环境变量路径中

二、创建.proto文件,定义结构

Protobuf3 语法指南

// 使用PB3的语法
syntax = "proto3";

// message代表一个模型
message Test {
  string title = 1;
  int32 tag = 2;
  Request request = 3;
  repeated string values = 4; // 数组
}

message Request {
  string url = 1;
}

三、把.proto文件转为Swift模型

  1. 创建两个文件夹origin_pathtarget_path,并放在同一路径Test
    (注:文件夹名自定义)

  2. 把上一步创建好的.proto放到origin_path路径下

image

cd到Test,终端执行:(注意对应路径和文件名)

protoc --proto_path=origin_path --swift_out=target_path origin_path/Test.proto
  1. target_path中查看转好的文件
image

四、在iOS工程中使用

  1. pod添加
pod 'SwiftProtobuf'
  1. 把之前转好的模型文件加入工程

  2. Code

        /*
         {
             "title": "test",
             "tag": 1,
             "request": {
                 "url": "www.fivehow.com"
             },
             "values": ["value1", "value2"]
         }
         */
        
        let request = Request.with { $0.url = "www.fivehow.com" }
        
        let test = Test.with {
            $0.title = "test"
            $0.tag = 1
            $0.request = request
            $0.values = ["value1", "value2"]
        }
        
        let binaryData = try? test.serializedData()
        guard let binaryData = binaryData else { return }
        _ = try? Test(serializedData: binaryData)
        
        let jsonStr = "{\"title\":\"test\", \"tag\":1, \"request\":{\"url\":\"www.fivehow.com\"},\"values\":[\"value1\", \"value2\"]}"
        let jsonStrData = jsonStr.data(using: .utf8)
        
        print("binaryData: \(binaryData.count)")            // 43
        guard let jsonStrData = jsonStrData else { return }
        print("jsonStrData: \(jsonStrData.count)")          // 92

Objective-C

一、环境配置

1.下载Protobuf并解压

https://github.com/protocolbuffers/protobuf/releases

cd到解压好的路径下

2.终端按顺序执行

brew install autoconf automake libtool curl

./autogen.sh

./configure

make

make check

make install

3.检查是否安装成功

protoc --version

二、创建.proto文件,定义结构

Protobuf3 语法指南

// 使用PB3的语法
syntax = "proto3";

// 模型文件前缀
option objc_class_prefix = "WH";

// message代表一个模型
message Test {
  string title = 1;
  int32 tag = 2;
  Request request = 3;
  repeated string values = 4; // 数组
}

message Request {
  string url = 1;
}

三、把.proto文件转为OC模型

  1. 创建两个文件夹origin_pathtarget_path,并放在同一路径Test
    (注:文件夹名自定义)

  2. 把上一步创建好的.proto放到origin_path路径下

image

cd到Test,终端执行:(注意对应路径和文件名)

protoc --proto_path=origin_path --objc_out=target_path origin_path/Test.proto
  1. target_path中查看转好的文件
image

四、在iOS工程中使用

  1. pod添加
pod 'Protobuf'
  1. 把之前转好的模型文件加入工程

  2. 导入模型头文件

#import "Test.pbobjc.h"
  1. Code
    /*
     {
         "title": "test",
         "tag": 1,
         "request": {
             "url": "www.fivehow.com"
         },
         "values": ["value1", "value2"]
     }
     */
    
    // ProtoBuf data
    
    WHTest *test = [[WHTest alloc] init];
    test.title = @"test";
    test.tag = 1;
    test.valuesArray = [NSMutableArray
                        arrayWithObjects:@"value1", @"value2", nil];
    WHRequest *request = [[WHRequest alloc] init];
    request.URL = @"www.fivehow.com";
    test.request = request;
    NSData *protoBufData = [test data];
    
    // Json Data
    
    NSString* jsonStr = @"{\"title\":\"test\", \"tag\":1, \"request\":{\"url\":\"www.fivehow.com\"},\"values\":[\"value1\", \"value2\"]}";
    NSData* jsonData = [jsonStr dataUsingEncoding:(NSUTF8StringEncoding)];
    
    // 对比 data length
    
    NSLog(@"protoBufData: %ld", protoBufData.length);   // 43
    NSLog(@"jsonData: %ld", jsonData.length);           // 92
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,504评论 4 365
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,898评论 1 300
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,218评论 0 248
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,322评论 0 214
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,693评论 3 290
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,812评论 1 223
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,010评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,747评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,476评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,700评论 2 251
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,190评论 1 262
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,541评论 3 258
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,206评论 3 240
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,129评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,903评论 0 199
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,894评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,748评论 2 274

推荐阅读更多精彩内容