Google Protobuf简单使用

一、简介

1.什么是ProtoBuf？

Protobuf是google推出的数据交换格式，相比xml、json主要优势在传输数据量更小、解析更快。它自带了一个编译器，可以编译成JAVA、python、C++代码，而Swift语言也由第三方提供支持了。

2.protobuf-swift和swift-protobuf

• protobuf-swift
  一个大牛封装的swift语言版本的Protobuf。地址：https://github.com/alexeyxo/protobuf-swift
• swift-protobuf
  苹果封装的(时间比上面的晚)。地址：https://github.com/apple/swift-protobuf

---

二、使用流程

1. 配置环境：

要想使用Protobuf需要先配置protobuf编译器本地环境(个人感觉protobuf-swift更简单些)。

• 配置protobuf-swift(可参考上面官方地址)。
  他人简书文章参考：https://www.jianshu.com/p/e62e941ab67e

// 终端实测演示
brew install automake
brew install libtool
brew install protobuf
git clone  https://github.com/alexeyxo/protobuf-swift.git
cd protobuf-swift
./scripts/build.sh

• 配置swift-protobuf(可参考上面官方地址)
  他人简书文章参考：https://www.jianshu.com/p/89efeecd5b43

2.编辑proto文件：

• 新建一个空文件，以proto为扩展名。
• 编辑该文件添加需要的数据字段。例如：

// 使用的版本号(常用proto2/proto3)
syntax = "proto2";

// 定义数据模型(message是固定关键字，Person是自定义类名)
message UserInfo {
    // 定义姓名字段(必要)
    required string name = 1;
    // 定义年龄字段(可选)
    optional int64 age = 2;
}
// 标签数字1和2则表示不同的字段在序列化后的二进制数据中的布局位置, 同一message中不能重复
// Protobuf允许数据类型嵌套使用(是不是很强大？)。

3.编译proto文件

在刚才编辑proto文件的目录下使用终端执行
protoc person.proto --swift_out="./"
即可在当前目录下生成person.proto.swift(自动小写)文件。

4.导入项目

• 导入上面生成的person.proto.swift到项目(拖入或菜单添加文件)。
• 导入ProtocolBuffers.xcodeproj(该文件就是配置环境时克隆到本地的)到项目中。
  注：ProtocolBuffers可以使用cocoaPods方式导入也可以手动拖入(推荐手动拖入)。
• 点击Xcode上Set the active scheme选择ProtocolBuffers要编译的平台(支持iOS和MacOS)，最后command+b编译成功即可。

5.使用

如同使用普通的数据模型类一样简单，都是对象操作。

// 创建数据模型对象(UserInfo即是自定义的数据模型类)
let user = UserInfo.Builder()
user.name = "我是\(arc4random_uniform(100))"

// 序列化
let data = (try! user.build()).data()

// 反序列化
let user2 = try! UserInfo.parseFrom(data: data)
print(user2.name)

---

三、其他补充

1. OC Protobuf
   https://www.jianshu.com/p/6009e96866e5

2. Protobuf 的 proto3 与 proto2 的区别
   https://solicomo.com/network-dev/protobuf-proto3-vs-proto2.html