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源文件

• 2.2、编译Objective-C支持的插件protobuf-objc
  参考：iOS之ProtocolBuffer搭建和示例demo

• 到Releases·google/protobuf下载最新版压缩包
  protobuf-objectivec-3.2.0.tar.gz或者protobuf-objectivec-3.2.0.zip
  注：下载不下来的话请先安装Lantern

• 执行以下命令安装插件

$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原理