一、Protocol buffers简述
特点
Protocol buffers are a language-neutral, platform-neutral extensible mechanism for serializing structured data.
- 语言中立，平台中立
- 序列化结构化数据
protocol核心学习点
- protocol buffer 语法https://developers.google.com/protocol-buffers/docs/proto
- proto3语法https://developers.google.com/protocol-buffers/docs/proto3
- buffer如何进行序列化以及反序列化https://developers.google.com/protocol-buffers/docs/encoding
优势
- simpler（简单）
- smaller（文件小）
- faster（序列化与反序列化速度快）
- 支持多种语言，相对于xml更易于程序处理
主要是由于采用protocol方式生成的binary format文件相比于xml格式的更小，序列化，反序列化，网络传输过程中有更大优势。
历史演变主要解决的问题
- 协议不同版本的字段变换时带来的兼容性问题
- 协议能够带来了更好的自描述，能够被不同语言处理
演变历程
- 自动产生序列化与反序列化代码-》如何使用？
- 利用protocol buffer自描述能力，用于大数据存储-》如何存储，效率问题如何？
- 能够使用编译器能够自动生成服务端stub程序-》如何生成？
二、Proto3 buffer语法格式
暂时跳过proto2的语法格式
2.1 Defining A Message Type
如何在proto文件中定义一个消息类型？
syntax = "proto3"
message request {
string name = 1；
string age=2；
int32 page_numer = 3；
int32 result_per_page = 4;
}
proto messge主要有field types, field name以及field number构成。
其中field number 【1-15】区间占用One Byte，【16-2047】占用两个bytes，所以在message中fields个数不多的情况，尽量使用1-15之内的数值。
field number允许的值范围为【1-2的29次方-1（536870911）】，其中【19000-19999】为保留数值。
Adding Comments
proto use c/c++ style comments, //for line comments, /.../for block comment
Reserved Fields
message ReservedTest{
reserved 2, 6, 10 to max;
reserved "name", "age";
}
Note:不能在同一行混用field name与number，必须分开保留。
2.2 编译proto文件
对于一个初学者来说，刚开始肯定会拿到一个proto文件，拿到此文件后如何下手？大致步骤如下：
-
安装编译环境，protocol buffer compiler能够根据不同的客户端语言，生成对应的代码,规则如下
For C++, the compiler generates a .h and .cc file from each .proto, with a class for each message type described in your file.
For Java, the compiler generates a .java file with a class for each message type, as well as a special Builder classes for creating message class instances.
Python is a little different – the Python compiler generates a module with a static descriptor of each message type in your .proto, which is then used with a metaclass to create the necessary Python data access class at runtime.
For Go, the compiler generates a .pb.go file with a type for each message type in your file.
For Ruby, the compiler generates a .rb file with a Ruby module containing your message types.
For Objective-C, the compiler generates a pbobjc.h and pbobjc.m file from each .proto, with a class for each message type described in your file.
For C#, the compiler generates a .cs file from each .proto, with a class for each message type described in your file.
For Dart, the compiler generates a .pb.dart file with a class for each message type in your file 运行编译指令
2.3 Scalar Value Types
描述protocol文件的field types如何与其他不同语言的数据类型进行一一映射。
具体映射关系参考protocol数据类型映射表
protocol中定义的数据类型:
double，float，int32，int64，uint32, uint64, sint32, sint64, fixed32, fixed64, sfixed32, sfixed64, bool, string, bytes
对于不同数据类型，不同操作数据类型，在数据序列化与反序列化的时候，会对不同数据类型进行一定的优化。
2.4 Default values
在message被反序列化的时候，如果缺少特定field的描述，反序列化时就会设置对应的默认值，规则如下：
- For strings, the default value is the empty string.—空字符串
- For bytes, the default value is empty bytes.—空字节
- For bools, the default value is false.-错
- For numeric types, the default value is zero.-0
- For enums, the default value is the first defined enum value, which must be 0.-联合第一个值必须为0
- For message fields, the field is not set. Its exact value is language-dependent. See the generated code guide for details.
2.5 Enumerations
联合是protocol中相对复杂的type，例如
message request {
string name = 1;
int age = 2;
enum Sex {
MALE = 0;
FEMALE = 1;
OTHER = 2
}
Sex gender = 3;
}
在protocol中对enum的第一个元素作了特别的规定，必须为值为0，主要是为了解决enum的默认值问题以及兼容proto2协议。
联合字段别名
示例：
message request {
string name = 1;
int age = 2;
enum Sex {
option allow_alias = true;
MALE = 0;
FEMALE = 1;
MAN = 1；
OTHER = 2
}
Sex gender = 3;
}
允许联合字段别名在Java或者C语言中比较少见，protocol默认也不允许开启联合别名，如果要开启必须通过手动打开配置选项
2.6 Using Other Message Types
protocol文件之间如何相互引用已经定义好的Message？如何通过Message嵌套引用形成消息结构层次？
示例：
message Response {
int http_code = 1;
string ret_msg = 2;
repeated Device data = 3;
}
message Result {
string device_uuid = 1;
string device_name = 2;
float longitude = 3;
float latitude = 4;
}
一般来说，在实际的代码开发过程中，尽量将Message颗粒度进行拆分，便于在项目中相互调用。
importing definitions
protocol也支持导入其他proto文件，通过proto文件导入方式，能够通过合并导入proto文件形成新的proto文件，可以对不通版本，用户暴露不一样的proto文件。
2.7 Unknown Fields
对于解析端，如果解析的数据流中包含一些未知字段，通常来说解析时候把未知字段给忽略了，但是在protocol3.5及以后的版本中，未知字段在解析时候会被保留而不是丢弃。
2.8 Any
protocol中提供了一种特殊的消息类型Any。 Any的意思为：字段可以为任何类型，在序列化时候就将此字段序列化为bytes。
示例：
import "google/protobuf/any.proto";
message ErrorStatus {
string message = 1;
repeated google.protobuf.Any details = 2;
}
在使用Any消息类型的时候，必须引入google的any这个proto文件。对于Any的使用场景需要收集总结？
2.9 Oneof
Oneof用于标记消息中某些字段同时最多只有一个能够同时存在，经常用于标记互斥的字段。
示例：
message Person {
oneof contact {
string mobile = 4;
string email = 9;
}
}
Oneof Features
注意在实际消息对象赋值的过程中，oneof特性带来值覆盖问题，最终值是最后一个oneof字段，oneof字段不允许使用repeated。
oneof使用案例
2.10 Maps
Maps也是最常见的数据类型。
示例
map<string, Person> class = 2;
protocol对map做了以下限定
- key必须为inegral以及string，value可以为除了map后的任何类型
- map不能用repeated来进行修饰
- 不允许有重复的key
- 对于只有key没有value情况，不同语言处理方式不一样
2.11 Packages
protocol为了防止定义的消息类型冲突，也引入了package概念，类似于java，c++等语言，protocol的包在转换为不同语言实现时，会有相关转换关系。
定义一个包的消息：
package com.dwx;
message Person {
}
引入一个包对象
message Class {
com.dwx.Person stu = 1;
}
在proto文件转换为java文件时，默认用定义的package名来作为java的包名，如果想改变该规律，可以使用配置项
option java_package = "com.xx.xx"
2.12 Defining Services
proto文件中除了定义消息类型，另一个重要任务就是服务接口。编译器会根据选择的语言生成相应的接口代码以及存根代码。
常见的service示例
service SearchPerson {
rpc Search(Person) returns(Class);
}
不同的编译插件可以快速生成对应的interface以及stub代码，需要深入研究maven或者gradle方式下如何集成相关插件，运行指令等。
2.13 Options
proto buffer提供可选项参数，用于改变编译的一些默认行为，目前主要有针对java或者移动端的一些优化配置，汇总如下:
-
java_package: 改变java的默认package名
option java_package = "xx.xx.xx"
-
java_ multiple_files:是否将messages，enums以及services作为内部类
option java_ multiple_files = true
-
java_outer _classname：指定outerclass名字，默认为proto文件名
option java_outer _classname = "PersonStu"
optimize_ for：可以被设置为SPEED，CODE_SIZE，LITE_RUNTIME。通过设置优化属性，代码产生器会针对不同的语言进行各种优化。
Custom Options：可以自己定义优化特性。
3 如何生成class
3.1 环境准备
安装编译环境，windows平台下可以选择windows protoc 3.6.1安装文件
配置系统环境变量，在path中添加bin路径，例如 D:\IDE\protoc-3.6.0-win32\bin
在cmd命令行下，输入protoc --version,回显libprotoc XXX， XXX为安装的版本号
3.2 编写.proto文件
syntax = "proto3"
message PersonRequest{
string name = 1; //姓名
uint32 age = 2; //年龄
string birth_day = 3; //出生日期
string mobile = 4; //手机号
enum Sex {
Female = 0;
Male = 1;
Other = 2;
}
Sex gender = 5; //define sex
}
3.3 命令行编译
指令格式如下：
protoc --proto_path=IMPORT_PATH --cpp_out=DST_DIR --java_out=DST_DIR --python_out=DST_DIR --go_out=DST_DIR --ruby_out=DST_DIR --objc_out=DST_DIR --csharp_out=DST_DIR path/to/file.proto
其中各个参数的含义如下：
- --proto_path:简写-I, 为import文件的路径，缺省为当前文件路径。
- --**_output，主要为编译器根据不同语言产生的代码文件，如果DST——DIR是.zip或者.jar，编译器会根据要求生成相应的文件
- 提供一个或者多个文件作为输入文件，文件默认也是参考当前的路径。
3.4 案例演示
- 编写Person.proto文件
- 运行protoc --java_out ./rpc/out/person.jar --go_out .\rpc\out\go\ .\rpc\Person.proto，报"--go_out:protoc-gen-go:系统找不到指定的文件",主要是编译器中不包含golang的代码生成器，删除掉go的out文件即可。
- 重新运行protoc --java_ out ./rpc/out/person.jar .\rpc\Person.proto，即可生成对应的jar文件，主要out_dst文件夹必须为已存在，未存在的目录代码生成器不会自动创建。
- 可以通过修改配置项来调整生成的jar的内容
4 code style
代码约定：
- Message名：用驼峰，第一个字母为大写，如PersonRequest
- 字段名字用小写，名字用下划线之间分割，例如：birth_date
- 联合全部用大写
- service名字用大写，service中的方法名也用大写首字母+驼峰命名
有疑问加站长微信联系（非本文作者）
