protobuf 使用(mac上安装protobuf生成代码脚本

什么是protobuf

protobuf(Google Protocol Buffers)
Google提供一个具有高效的协议数据交换格式工具库(类似Json)。
但相比于Json，Protobuf有更高的转化效率，时间效率和空间效率都是JSON的3-5倍。

protobuf 的优缺点

https://www.jianshu.com/p/293c1e7c0a99

protobuf的使用

通过proto 文件，脚本生成 OC h/m 文件的脚本。

1）mac 上安装proto，以便通过脚本生成生成 OC h/m 文件。

$ brew install protobuf

检查proto 版本

$ protoc --version

执行结果：

libprotoc 3.5.1

卸载本地所有的protobuf

brew uninstall --force protobuf

升级

brew upgrade protobuf

链接

brew link protobuf

强制删除

  rm '/usr/local/bin/protoc'

重新链接

brew link --overwrite protobuf

2）编辑proto文件（proto2版本的语法）

文件后缀名为 XXXXX.proto
文件内容如下：

syntax = "proto2"; 

message VersionMessage {
  optional int64 timestamp = 1;
  optional int32 minimum = 2;
  optional string messageId = 3;
  optional string replyId = 4;
  optional int32 version = 5;
  optional int64 services = 6;
  optional string subVer = 7;
  optional string id = 8;
}

对象嵌套

message DiscoverReplyMessage {
  optional int64 timestamp = 1;
  optional int32 minimum = 2;
  optional string messageId = 3;
  optional string replyId = 4;
  repeated group PeerAddress = 5{
    optional string ip = 1;
    optional int32 port = 2;
    optional int64 services = 3;
    optional string id = 4;
  }
}

对象嵌套的另一种方式

 message PeerAddress{
    optional string ip = 1;
    optional int32 port = 2;
    optional int64 services = 3;
    optional string id = 4;
  }

message DiscoverReplyMessage {
  optional int64 timestamp = 1;
  optional int32 minimum = 2;
  optional string messageId = 3;
  optional string replyId = 4;
  repeated group  PeerAddress = 5;
}

• required 不可以增加或删除的字段，必须初始化
• optional 是可选择的
• repeated group 是数组
• 其他类型是各开发语言的通用类型

proto3版本的语法

• required 可以去掉
• optional 可以去掉
• repeated group —> repeated
• 其他类型是各开发语言的通用类型

syntax = "proto3"; 

message VersionMessage {
  int64 timestamp = 1;
  int32 minimum = 2;
  string messageId = 3;
  string replyId = 4;
  int32 version = 5;
  int64 services = 6;
  string subVer = 7;
  string id = 8;
}

对象嵌套

message DiscoverReplyMessage {
  int64 timestamp = 1;
  int32 minimum = 2;
  string messageId = 3;
  string replyId = 4;
  repeated  PeerAddress = 5{
     string ip = 1;
     int32 port = 2;
     int64 services = 3;
     string id = 4;
  }
}

3）根据.proto 文件，通过proto脚本，生成相应的代码

版本3.5.1 脚本

先 cd 进入ProtoBufMessage.proto 的文件目录

 protoc --plugin=/usr/local/bin/protoc-gen-objc ProtoBufMessage.proto --objc_out=.

版本2.6 脚本

/Users/caobo/Desktop/probuffer/protobuf-ios/compiler/src/protoc --objc_out=. person.proto

生成代码文件如下：

屏幕快照 2018-04-11 上午11.26.03.png

4）在项目中导入Protobuf

通过pod 或者直接导入代码

    pod 'Protobuf'

Protobuf只有3.0 以上的版本，在pod 上搜索会有protobuf-ios ，这个库是2.3的版本

屏幕快照 2018-04-11 上午11.31.32.png

然后就可以直接使用Protobuf序列化反序列化对象了。

5）序列化与反序列化：

Protobuf3 的示例：
序列化：

    DiscoverReplyMessage_PeerAddress * peer = [[DiscoverReplyMessage_PeerAddress alloc]init];
    [peer setId_p:@"1q2w3e4r5t"];
    [peer setIp:@"10.10.10.2"];
    [peer setPort:1234];
    [peer setServices:1];

    DiscoverReplyMessage * msg = [[DiscoverReplyMessage alloc]init];

    [msg setMessageId:@"1q2w3e4r5t"];
    [msg setReplyId:@"1q2w3e4r5t"];
    [msg setMinimum:2];
    [msg setPeerAddressArray:[NSMutableArray arrayWithObjects:peer, nil]];

    NSLog(@"msg = ~%@~",msg.data);

反序列化：

    NSData * data = [self convertHexStrToData:@"089cf9c1fbaa2c10011a01312201312b0a096c6f63616c686f7374108c4b180122066e6f646549442c"];
    NSError * error;
    DiscoverReplyMessage * msg = [DiscoverReplyMessage parseFromData:data error:&error];
    NSLog(@"%@",msg);

Protobuf2 的示例：

序列化：

Person* person = [[[[[Person builder] setId:123]
                                    setName:@"Bob"]
                                   setEmail:@"bob@example.com"] build];
NSData* data = [person data];

反序列化：

NSData* raw_data = ...;
Person* person = [Person parseFromData:raw_data];