在项目中使用Protobuf协议实现数据传输(二)

上篇已经简单的分析了什么是ProtoBuf协议的优缺点、简单的环境配置、项目中的简单使用和一些编写.Proto文件的注意点,下面我们更加深入一下ProtoBuf的语法及高级使用(非常感谢Carson_Ho大神的博文指导)

从Google官方例子进行语法深入

Google官方例子:

syntax = "proto2";//声明proto版本,2.0与3.0以后语法差异很大

package tutorial;//// 关注1:包名

option java_package = "com.example.tutorial";
option java_outer_classname = "AddressBookProtos";//// 关注2:option选项

message Person {//// 关注3:消息模型
  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 phones = 4;
}

message AddressBook {
  repeated Person people = 1;
}

针对上述官方例子的注释,下面一一分析

关注点1:包名

作用:防止不同 .proto 项目间命名 发生冲突

ProtoBuf包的解析过程如下

  • Protocol buffer 的类型名称解析与 C++ 一致:从 最内部 开始查找,依次 向外 进行
    每个包会被看作是其父类包的内部类
  • Protocol buffer 编译器会解析 .proto文件中定义的所有类型名
    生成器会根据 不同语言 生成 对应语言 的代码文件
  • 即对 不同语言 使用了 不同的规则 进行处理
  • Protoco Buffer提供 C++、Java、Python 三种语言的 API

关注点2:option选项

作用:影响 特定环境下 的处理方式,但不改变整个文件声明的含义

常用Option选项:(因为使用有限,简单列举常见的)

option java_package = "com.crf.jason.myapplication";
// 定义:Java包名
// 作用:指定生成的类应该放在什么Java包名下
// 注:如不显式指定,默认包名为:按照应用名称倒序方式进行排序
option java_outer_classname="Demo";
// 定义:类名
// 作用:生成对应.java 文件的类名(不能跟下面message的类名相同)
// 注:如不显式指定,则默认为把.proto文件名转换为首字母大写来生成
// 如.proto文件名="book.proto",默认情况下,将使用 "BookOuterClass" 做为类名

option optimize_for = ***;
// 作用:影响 C++  & java 代码的生成
// ***参数如下:
// 1. SPEED (默认)::protocol buffer编译器将通过在消息类型上执行序列化、语法分析及其他通用的操作。(最优方式)
// 2. CODE_SIZE::编译器将会产生最少量的类,通过共享或基于反射的代码来实现序列化、语法分析及各种其它操作。
  // 特点:采用该方式产生的代码将比SPEED要少很多, 但是效率较低;
  // 使用场景:常用在 包含大量.proto文件 但 不追求效率 的应用中。
//3.  LITE_RUNTIME::编译器依赖于运行时 核心类库 来生成代码(即采用libprotobuf-lite 替代libprotobuf)。
  // 特点:这种核心类库要比全类库小得多(忽略了 一些描述符及反射 );编译器采用该模式产生的方法实现与SPEED模式不相上下,产生的类通过实现 MessageLite接口,但它仅仅是Messager接口的一个子集。
  // 应用场景:移动手机平台应用
  • Google官方还提供了在ProtoBuf中允许 自定义选项并且使用,具体请参考:传送门

关注点3:消息模型

作用:真正用于描述 数据结构

在.proto消息模型中主要有 消息对象&字段

Protobuf中的消息对象

  • 一个消息对象(Message) = 一个 结构化数据
  • 消息对象用 修饰符 message 修饰
  • 消息对象 含有 字段:消息对象(Message)里的 字段 = 结构化数据 里的成员变量

注意:

  • 在一个.proto文件可以定义多个消息对象

      message Person{//level 0
          string name=1;
          int32 age=2;
           string email=3;
      ...
      }
      message Car{
       string carName=1;
      int32 price=2;
      }
    
  • 在一个消息对象里面可以定义另外一个消息对象(嵌套)

      message Person{//level 0
          string name=1;
          int32 age=2;
           string email=3;
      enum Phonetype{
           MOBILE=0;
          HOME=1;
      }
      message PhoneNumber{//level 1
       string number=1;
      }
      }
    

Protobuf中消息对象的字段

字段

组成:字段 = 字段修饰符 + 字段类型 +字段名 +标识号(主要针对proto2以前版本)

// required int32 id = 1;

字段 = 字段类型 +字段名 +标识号(主要针对proto3及以后版本)

int32 id = 1;
字段类型

一个消息对象 可以将 其他消息对象类型 用作字段类型

  • 使用同一个 .proto 文件里的消息类型

  • 使用 内部消息类型

     先在 消息类型 中定义 其他消息类型 ,然后再使用(嵌套)
    
         message Person{//level 0
             string name=1;
             int32 age=2;
             string email=3;
            enum Phonetype{
                MOBILE=0;
                HOME=1;
            }
             message PhoneNumber{//level 1
              string number=1;
              Person person=2;
             }
             PhoneNumber phoneNumber=4;//这里就是直接使用刚才定义的PhoneNumber消息类型
         }
         message Car{
             string carName=1;
             int32 price=2;
             Person.PhoneNumber phoneNumber=3;
         }
    
  • 使用 外部消息类型

     即外部重用,需要 用作字段类型的消息类型 定义在 该消息类型外部
    
         message Person{//level 0
             string name=1;
             int32 age=2;
             string email=3;
            enum Phonetype{
                MOBILE=0;
                HOME=1;
            }
             message PhoneNumber{//level 1
              string number=1;
              Person person=2;//这里就是使用外部消息类型 person
             }
             PhoneNumber phoneNumber=4;
         }
         message Car{
             string carName=1;
             int32 price=2;
             Person.PhoneNumber phoneNumber=3;
         }
    
  • 使用 外部消息的内部消息类型

         message Person{//level 0
             string name=1;
             int32 age=2;
             string email=3;
            enum Phonetype{
                MOBILE=0;
                HOME=1;
            }
             message PhoneNumber{//level 1
              string number=1;
              Person person=2;
             }
             PhoneNumber phoneNumber=4;
         }
         message Car{
             string carName=1;
             int32 price=2;
             Person.PhoneNumber phoneNumber=3;//这里使用外部消息类型Person的PhoneNumber内部消息类型
         }
    
  • 使用不同 .proto 文件里的消息类型

    作用:需要在 A.proto文件 使用 B.proto文件里的消息类型

    在 A.proto文件 通过导入( import) B.proto文件中来使用 B.proto文件 里的消息类型

  • 将 消息对象类型 用在 RPC(远程方法调用)系统

    具体实现请移步:大神博客

关于ProtoBuf在项目中的实践的高级用法请关注:下一篇博客:在项目中使用Protobuf协议实现数据传输(三)

推荐阅读更多精彩内容