【ios】Protobuf的使用(分步骤详细解析)

(1)Protobuf是什么?


Protobuf 即 google protocol buffer 是一种数据封装格式协议,是google推出

的一种语言无关、平台无关、扩展性好的用于通信协议、数据存储的结构化数据串行化方法。支持

C++、Python、Java三种语言。


(2)为什么要使用Protobuf?


在不同平台通信的时候,首先需要将对象进行序列化。iOS平台上我们常用NSKeyedArchiver进行

归档,当然也可以将数据处理为JSON或者XML格式。NSKeyedArchiver只能在iOS/Mac平台使用,

因此它归档的二进制数据不适合于在不同平台之间使用。JSON和XML虽然由于容易维护,易读而应用

比较广泛,但是对数据的利用效率都不是高。这时候该使用Protobuf了,因为Protobuf的优势是

效率高,同样的一份数据使用protobuf存储的时候更小,更加方便


(3)安装步骤如下:


一.安装环境

        Pre:做这些事情的时候例行翻墙

    1.打开终端

    2.查看你的mac上是否安装了brew

      $ brew -v

      Homebrew 1.6.8

      Homebrew/homebrew-core (git revision d822; last commit 2018-06-12)

     这是表明已经安装,如果没有安装,使用下面的命令安装下

   3.安装brew (使用ruby安装)

      $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/

   Homebrew/install/master/install)"

   4.下载依赖库(工具)

       $ brew install automake

       $ brew install libtool

   5.下载Protobuf,这些执行之后后边pod才能成功

       $ brew install protobuf

   6.克隆protobuf-objc,也就是说把代码下载到本地

            方法一:

      $ cd desktop 我是clone到桌面,你们可以随便放那

      $ git clone https://github.com/alexeyxo/protobuf-objc.git

            方法二:我用的这种方法

            上边的方法如果没有成功,可以到官方网址下载https://github.com/google/protobuf/releases

            我下的版本是3.6.0,放在了桌面上

            

    7.运行脚本

        $  cd  Desktop     

        $  cd protobuf-3.6.0 切换到protobuf-3.6.0目录下

        方法一:

        $  ./scripts/build.sh

        方法二:我用的这种方法

        $ ./autogen.sh

        $ ./configure

        $ make

        # 如果希望安装protoc,执行下面的命令

        $ make install

        如果例行翻墙好像没有出现错误,如果出现这样的错误,不要慌,这是google自己版本的问题,我们不用管他,而且也不会像其他文章说的那

     样,生成protoc-gen-objc这个插件,根本就不会生成,除非版本是2.6.0,这个问题采用下面的方式一样能生成proto文件

      编译后报错:In file included from objc_helpers.cc:27:./google/protobuf/

     objectivec-descriptor.pb.h:17:2: error: This file was generated by

      an older version of protoc which is

      #error This file was generated by an older version of protoc which is

      ^

      ./google/protobuf/objectivec-descriptor.pb.h:18:2: error: incompatible with your

      Protocol Buffer headers. Please

    #error incompatible with your Protocol Buffer headers. Please

      ^

     ./google/protobuf/objectivec-descriptor.pb.h:19:2: error: regenerate this file

     with a newer version of protoc.

   #error regenerate this file with a newer version of proton.

    ......


二.生成后缀proto的文件

说明: 创建 proto 文件指定数据格式,可以选择proto2和proto3格式,它们有些细微的区别,在生成代码的时候会提示的,具体情况查看文档Language Guide proto3。下面使用proto3格式,并且保存为person.proto。


  1.  创建文件person.proto

      $  cd desktop  我还是切换到桌面

      $  touch person.proto

  2. 编辑person.proto文件

      2.1 使用终端编辑

           $ vi person.proto

              syntax = "proto3";

              message Person{

              string name = 1;

               int32 age = 20;

             enum DeviceType{

                      iOS = 0;

                     Android = 1;

                  }

              }

        2.2 放到xcode中直接写(推荐)


三.转化成objc文件


由于我们生成不了protoc-gen-objc,因此使用

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

使用绝对路径是不行的

我们使用 protoc 工具生成Objective-C代码:

终端输入: $ protoc --proto_path=A --objc_out=B person.proto

其中--proto_path=后跟A是需要处理的proto文件所在的文件夹,--objc_out=指明生成的是Objective-C代码以及目标文件存放路径,B是目标文件存放路径,person.proto是需要处理的文件。


So:

我的做法是在桌面上建立两个文件夹,一个叫protofile,一个叫objcfile

然后将创建好的person.proto放进protofile文件夹,然后

cd Desktop

在终端输入:

protoc --proto_path=protofile --objc_out=objecfile person.proto 

然后成功在objcfile里得到我们要的 文件

导入工程中,这两个文件是采用的手动引用计数,因此在加入项目后需要设置它们的编译参数。

在工程target->Build Phrases->Compile Sources->给Person.pbobjc.m设置-fno-objc-arc.

设置

四.项目使用 (下载Protocol Buffers的源码(下载地址),也可以到官网上下载)


1.使用cocoapods方式导入:我使用的是这种方法

    使用 pod  'Protobuf  

    不能使用 pod 'ProtocolBuffers,    

    使用 pod ProtocolBuffers’的话:

    下载成功之后,编译一看,结果报错 

    #import "GPBProtocolBuffers_RuntimeSupport.h"无法找到

  原因是pods下来的是不带GPB的,所以网上说的不对,应该是用

    pod 'Protobuf' ,这样就没有问题

2.静态库引入方式

     1.下载Protocol Buffers的源代码

     2.工程里引入ProtocolBuffers_iOS.xcodeproj,或者编译成静态库.a方式,然后公开头文件(如图2)

     3.设置依赖和连接库。(如图3)

     4.引入头文件(如图4)


图2

图3

图4

五、具体使用和对比

设置依赖和连接库。

引入头文件开始使用。

#import "Person.pbobjc.h"

- (void)viewDidLoad {

    [super viewDidLoad];

    Person *person = [[Person alloc] init];

    person.name = @“qiao”;

    person.age = 18;

    NSData *data = [person data];

    NSLog(@"\nname:%@,age:%d", p.name, p.age);

}

打印结果如下:

2015-12-02 13:09:46.890 ProtobufDemo[34761:150533]

name:qiao,age:18

Protocol Buffer效率测试 我们这里说的效率是指空间占用率。简单和JSON格式比较一下,同样是存储下面的信息: 

name: qiao

age:16

采用Protocol Buffers的数据大小为20个字节。而实用JSON存储时,尽管我们将Key变成一个字节,如下:

NSDictionary *dict = @{@"n":@“qiao",

                       @“a":@“18",

                       };

NSData *jd = [NSJSONSerialization dataWithJSONObject:dict options:0 error:nil];

NSLog(@"jd: %lu", jd.length);

JSON数据还是占了36个字节,并且随着可读性提高,效率更低。XML就更不用说了。

总结

如果希望获得更好的的可读性,可以选用JSON和XML这类文本格式。但如果从数据效率上将,Protocol Buffer是一个不错的选择。存储效率高,并且proto文件的可读性和可维护性都比较强。

POST:

https://blog.csdn.net/diveinedu/article/details/50203033

https://www.jianshu.com/p/189368a9d744

https://blog.csdn.net/u014337888/article/details/78907625

猜你喜欢

转载自blog.csdn.net/dangbai01_/article/details/81099001