Protobuf及在Android Studio中的配置

最近有项目需要使用到Protobuf，之前没有接触过它，经过一天的时间认识了它，现在来总结一下。

ProtoBuf

Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data.

Protobuf,Protocol buffers的简称。它是一种轻便高效的结构化数据存储格式，可以用于结构化数据串行化，或者说序列化。它很适合做数据存储或 RPC 数据交换格式。可用于通讯协议、数据存储等领域的语言无关、平台无关、可扩展的序列化结构数据格式。

它是二进制格式，支持多种不同的编程语言，如Java，Objective-C,PHP，Python等；

同时，支持向后兼容和向前兼容；

它在性能上比XML的要好；

具有代码生成机制。

ProtoBuf的语法

①．限定修饰符包含 required\optional\repeated

Required: 表示是一个必须字段，必须相对于发送方，在发送消息之前必须设置该字段的值，对于接收方，必须能够识别该字段的意思。发送之前没有设置required字段或者无法识别required字段都会引发编解码异常，导致消息被丢弃。

Optional：表示是一个可选字段，可选对于发送方，在发送消息时，可以有选择性的设置或者不设置该字段的值。对于接收方，如果能够识别可选字段就进行相应的处理，如果无法识别，则忽略该字段，消息中的其它字段正常处理。---因为optional字段的特性，很多接口在升级版本中都把后来添加的字段都统一的设置为optional字段，这样老的版本无需升级程序也可以正常的与新的软件进行通信，只不过新的字段无法识别而已，因为并不是每个节点都需要新的功能，因此可以做到按需升级和平滑过渡。

Repeated：表示该字段可以包含0~N个元素。其特性和optional一样，但是每一次可以包含多个值。可以看作是在传递一个数组的值。

    ②．数据类型
    protobuf 数据类型       描述       打包       C++语言映射

    bool           布尔类型       1字节       bool

    double           64位浮点数   N       double

    float           32为浮点数   N       float

    int32           32位整数、   N       int

    uin32           无符号32位整数   N       unsigned int

    int64           64位整数       N       __int64

    uint64           64为无符号整   N       unsigned __int64

    sint32       32位整数，处理负数效率更高   N       int32

    sing64       64位整数处理负数效率更高   N       __int64

    fixed32           32位无符号整数   4       unsigned int32

    fixed64           64位无符号整数   8       unsigned __int64

    sfixed32   32位整数、能以更高的效率处理负数   4   unsigned int32

    sfixed64       64为整数       8       unsigned __int64

    string           只能处理 ASCII字符   N       std::string

    bytes   用于处理多字节的语言字符、如中文   N       std::string

    enum   可以包含一个用户自定义的枚举类型uint32   N(uint32)   enum

    message   可以包含一个用户自定义的消息类型   N       object of class

    N 表示打包的字节并不是固定。而是根据数据的大小或者长度。

    ③．字段名称
    protobuf建议字段的命名采用以下划线分割的驼峰式。

   ④．字段编码值
    有了该值，通信双方才能互相识别对方的字段。当然相同的编码值，其限定修饰符和数据类型必须相同。
建议：项目投入运营以后涉及到版本升级时的新增消息字段全部使用optional或者repeated，尽量不实用required。如果使用了required，需要全网统一升级，如果使用optional或者repeated可以平滑升级。

   ⑤．默认值
   当在传递数据时，对于required数据类型，如果用户没有设置值，则使用默认值传递到对端。当接受数据是，对于optional字段，如果没有接收到optional字段，则设置为默认值。

其他：

1.关于import
protobuf 接口文件可以像C语言的h文件一个，分离为多个，在需要的时候通过 import导入需要对文件。其行为和C语言的#include或者java的import的行为大致相同。

2.关于package
避免名称冲突，可以给每个文件指定一个package名称，对于java解析为java中的包。对于C++则解析为名称空间。

3.关于message
支持嵌套消息，消息可以包含另一个消息作为其字段。也可以在消息内定义一个新的消息。

4.关于enum
枚举的定义和C++相同，但是有一些限制。
枚举值必须大于等于0的整数。
使用分号(;)分隔枚举变量而不是C++语言中的逗号(,)

Android Example

message Person {
    required string name=1;
    required int32 id=2;
    optional string email=3;

    enum PhoneType {
        MOBILE=0;
        HOME=1;
        WORK=2;
    }

    message PhoneNumber {
        required string number=1;
        optional PhoneType type=2 [default=HOME];
    }

    repeated PhoneNumber phone=4;
    optional string surname = 5;
}

这是一个.proto文件，在 Android中假如设置存放在：/src/main/proto文件夹下面，那如何将.proto文件编译成java文件的呢，请往下继续看。。

Android Studio Protobuf Plugin

官网地址：https://github.com/google/protobuf-gradle-plugin

第一步，在project的build.gradle中添加依赖(dependency)

剩下的，在module的build.gradle中进行配置：
1.首先需要添加 protobuf plugin：
注：protobuf plugin前必须应用Android plugin，顺序不能颠倒

2.设置.proto文件路径：

3.需要add一个protobuf块：
首先，下载protoc编译器，把proto文件编译成protoc可执行文件。
（因为默认情况下，该plugin会在系统搜索路径中搜索protoc可执行文件。）
然后，使用codegen plugin来运行 protoc,它是需要add一个plugins块来定义在plugin块中所使用的所有代码plugin。不过，它不能应用这些plugin。
最后，需要add一个generateProtoTasks块来配置任务来应用plugins块中的所有代码plugin。

其中，是需要

到此为止，配置完成。
proto文件编译成功后在项目的module的build／proto/debug/javalite/xx下面了。

接下来的调用在下篇博客更新，敬请期待！

Protobuf及在Android Studio中的配置

猜你喜欢