ProtocolBuffer在iOS中的使用

1、macOS中安装proto

通过Homebrew安装protocol buffers

$ brew install protobuf

2、安装protoc的Swfit和Objective-C插件

  • 2.1、编译Swift支持的插件swift-protobuf
    参考:swift-protobuf

2.1.1 自动安装

$ brew install swift-protobuf

2.1.2 手动编译安装

$ git clone https://github.com/apple/swift-protobuf.git
$ cd swift-protobuf
$ git tag -l
$ git checkout tags/[tag_name]
$ swift build

注:git tag -l列出版本列表 git checkout tags/[tag_name]检出指定版本

  • 拷贝编译完成的可执行文件到bin目录
$ sudo cp .build/debug/protoc-gen-swift /usr/local/bin

  • 生成swift文件
$ protoc --swift_out=./Sources/ ChatMessage.proto

注:./Sources/文件生成的路径 ChatMessage.protoproto源文件

$ tar -xzvf protobuf-objectivec-3.2.0.tar.gz (下载的是tar.gz包)
或
$ unzip protobuf-objectivec-3.2.0.zip (下载的是zip包)

$ cd protobuf-3.2.0
$ ./configure
$ make
$ make check
$ sudo make install

  • 生成Objective-C文件
$ protoc --objc_out=./Sources/ ChatMessage.proto

注:./Sources/文件生成的路径 ChatMessage.protoproto源文件

ChatMessage.proto内容如下可自行测试

syntax = "proto3";

message ChatMessage {
    string title = 1;
    string body = 2;
}

创建快速编译多种语言支持的脚本create.sh

打开终端定位到ChatMessage.proto文件所在目录
$ touch create.sh
$ vim create.sh // 使用vim编辑 
或者
$ open create.sh // 直接打开
将以下命令复制进create.sh文件中,保存退出
$ ./create.sh // 最后执行脚本

下方为脚本内容
--- --- --- --- --- ---
#!/bin/sh
SRC_DIR=./
DST_DIR=./gen

#Objective-C
mkdir -p $DST_DIR/objective-c
protoc -I=$SRC_DIR --objc_out=$DST_DIR/objective-c/ $SRC_DIR/*.proto

#Swfit
mkdir -p $DST_DIR/swift
protoc -I=$SRC_DIR --swift_out=$DST_DIR/swift/ $SRC_DIR/*.proto

以上步骤完成了proto的Swift插件以及Objective-C插件的安装,用于生成proto对应的Swfit和Objective-C代码


3、iOS中使用proto

  • 3.1 Swift中使用proto

  • 编译SwiftProtobuf.framework
    打开 SwiftProtobuf.xcodeproj (第2步安装Swift插件时候git下来的)
    选择SwiftProtobuf_iOS进行编译
    注:Build Settings -- Linking -- Mach-O Type 工程默认的是Dynamic(动态库)
    如果你想设置成Static,则会提示:Swift is not supported for static libraries.

  • 导入SwiftProtobuf.framework
    新建的iOS - Swift工程,并在General -- Embedded Binaries中添加编译出的SwiftProtobuf.framework
    如果,直接拖拽到工程中使用,会提示以下错误:
    dyld: Library not loaded: @rpath/SwiftProtobuf.framework/SwiftProtobuf
    Referenced from: /var/containers/Bundle/Application/********/ProductsName.app/ProductsName
    Reason: image not found

    动态库需在 General -- Embedded Binaries 中添加
    
    
  • 使用SwiftProtobuf
    在项目中导入ChatMessage.pb.swift(前面生成的)

        // 创建对象
        var chatMessage = ChatMessage()
        chatMessage.title = "消息标题"
        chatMessage.body = "消息体"

        do {
            // 序列化为Data
            let data = try chatMessage.serializedData()
            // 发送数据
            _webSocket.write(data: data) // 此处使用websocket来进行网络通信,请自行修改

        } catch {
            print("Failed to Serialize Protobuf Object into Data")
        }

func websocketDidReceiveData(socket: WebSocket, data: Data) {
        print("got some data: \(data.count)")

        do {
            // 反序列化为对象
            let message = try ChatMessage(serializedData: data)
            print("Title: \(message.title), Body: \(message.body)") // 此处使用了反序列化以后的message
        } catch {
            print("Failed to decode Proto from Received Socket Message")
        }

    }

使用 CocoaPods 和 Carthage 请查看github上的说明swift-protobuf

  • 3.2 Objective-C中使用proto

  • 编译libProtocolBuffers.a
    打开ProtocolBuffers_iOS.xcodeproj (第2步安装Objective-C插件时候下载的)
    路径如下:protobuf-3.2.0/objectivec/ProtocolBuffers_iOS.xcodeproj
    选择ProtocolBuffers进行编译
    注:Build Phases -- Headers 未添加要使用的头文件可自行添加( Generated分组下的暂不添加)

  • 导入libProtocolBuffers.a
    新建的iOS - Objective-C工程,并将编译出的libProtocolBuffers.a及相关头文件导入
    头文件导入特别说明:
    1、将ProtocolBuffers_iOS.xcodeproj工程中,即protobuf-3.2.0/objectivec/目录下的所有头文件导入
    2、将protobuf-3.2.0/objectivec/google/protobuf/目录下的所有头文件导入,此目录保持结构不变,即/google/protobuf/
    注:GPBProtocolBuffers.h 和 GPBWellKnownTypes.h 使用#import "google/protobuf/***.pbobjc.h"故保持2中目录结构不变(或者自行调整工程)

  • 使用ProtocolBuffers
    在项目中导入ChatMessage.pbobjc.h(前面生成的)

        // 创建对象
        ChatMessage *chatMessage = [ChatMessage new];
        chatMessage.title = "消息标题";
        chatMessage.body = "消息体";

        // 序列化为Data
        NSData *data = [chatMessage data];
        [_webSocket sendData:data error:NULL]; // 此处使用websocket来进行网络通信,请自行修改

 - (void)webSocket:(SRWebSocket *)webSocket didReceiveMessageWithData:(NSData *)data {
    NSLog(@"Received Proto \"%@\"", data);

    // 反序列化为对象
    ChatMessage *message = [ChatMessage parseFromData:data error:NULL];
    NSLog(@"Title: %@, Body: %@", message.title, message.body); // 此处使用了反序列化以后的message
}

使用 CocoaPods 请参考:Protocol Buffer搭建及示例(ios)


以上完成了ProtocolBuffers在Swift与Objective-C中的使用
PS:要是觉得导入库太麻烦,可以使用WrokSpace来管理项目依赖,请找度娘

测试服务器基于:
Perfect-WebSocketsServer
Perfect-Protobuf-Demo
Swfit的websocket基于:
Starscream
Objective-C的websocket基于:
SocketRocket

附件:第三方版 Protocol Buffers for Swift


看完让你彻底搞懂Websocket原理

作者:y824165978
链接:https://www.jianshu.com/p/751aa2b621d5
來源:简书
简书著作权归作者所有,任何形式的转载都请联系作者获得授权并注明出处。

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

推荐阅读更多精彩内容