protobuf 3 的简单使用

超、凢脫俗 2022-07-13 10:25 208阅读 0赞

**啰嗦几句：**

有句话这么说：一条消息数据，用protobuf序列化后的大小是json的10分之一，xml格式的20分之一，是二进制序列化的10分之一，总体看来ProtoBuf的优势还是很明显的。

简单说来 Protobuf 的主要优点就是：简单，快。网上很多与json,xml的对比，可以找来看看，这里不比较了。

Protobuf 有如 XML，不过它更小、更快、也更简单。你可以定义自己的数据结构，然后使用代码生成器生成的代码来读写这个数据结构。你甚至可以在无需重新部署程序的情况下更新数据结构。只需使用 Protobuf 对数据结构进行一次描述，即可利用各种不同语言或从各种不同数据流中对你的结构化数据轻松读写。

它有一个非常棒的特性，即“向后”兼容性好，人们不必破坏已部署的、依靠“老”数据格式的程序就可以对数据结构进行升级。这样您的程序就可以不必担心因为消息结构的改变而造成的大规模的代码重构或者迁移的问题。因为添加新的消息中的 field 并不会引起已经发布的程序的任何改变。

Protobuf 语义更清晰，无需类似 XML 解析器的东西（因为 Protobuf 编译器会将 .proto 文件编译生成对应的数据访问类以对 Protobuf 数据进行序列化、反序列化操作）。

使用 Protobuf 无需学习复杂的文档对象模型，Protobuf 的编程模式比较友好，简单易学，同时它拥有良好的文档和示例，对于喜欢简单事物的人们而言，Protobuf 比其他的技术更加有吸引力。

**使用：**

目前Protobuf 最新的版本是3.1的，使用Protobuf 首先要对Message实体进行预编译（不要嫌麻烦，好东西都是这样的），所以这里需要先下载 Protobuf 3.1 编译器 ，我这里已经上传上去了：http://download.csdn.net/detail/kokjuis/9729750 [点击打开链接][Link 1]

加压以后里面有2个目录 bin 、include。

编译之前要先定义你的proto文件（Protobuf 编译器编译用的格式是proto，到时可以编译出.java文件）。例如：

syntax = "proto3"; //指定版本，必须要写（proto3、proto2）
     
     
    message Header{
     
    //参数类型 参数名称=字段编码值
    string identify=1;// 协议标志
     
     
    string version=2;// 协议版本
     
     
    string appKey=3;// appKey
     
     
    int32 msgType=4;// 消息类型
     
     
    int32 direction=5;// 消息方向
    
    
    int64 msgTime=6;//消息时间
     
     
    string ack=7;//ack
     
    }
    
    \\----------------第二个文件-------------------
    
    syntax = "proto3"; //指定版本，必须要写（proto3、proto2）
     
     
    //message是固定的。UserInfo是类名，可以随意指定，符合规范即可
    message User{
     
    //参数类型 参数名称=字段编码值
    string senderId=1;// 发送人ID
     
     
    string receiverId=2;// 接受人ID
     
     
    string senderName=3;// 发送人姓名
     
     
    string receiverName=4;// 接收人姓名
     
     
    string senderHeadPortrait=5;// 发送人头像URL
     
     
    }
    
    //-------------第三个文件-------------
    syntax = "proto3"; //指定版本，必须要写（proto3、proto2）
     
     
    message Body{
     
    //参数类型 参数名称=字段编码值
    string content=1;// 内容
     
     
    int32 contentLength=2;// 内容长度
     
     
    int32 contentType=3;// 内容类型
     
     
    int32 msgType=4;// 消息类型
    
     
    }

参数后面的数字是字段编码值：

有了该值，通信双方才能互相识别对方的字段。当然相同的编码值，其限定修饰符和数据类型必须相同。

编码值的取值范围为 1~2^32（4294967296）。

其中 1~15的编码时间和空间效率都是最高的，编码值越大，其编码的时间和空间效率就越低（相对于1-15），当然一般情况下相邻的2个值编码效率的是相同的，除非2个值恰好实在4字节，12字节，20字节等的临界区。比如15和16.

1900~2000编码值为Google protobuf 系统内部保留值，建议不要在自己的项目中使用。

protobuf 还建议把经常要传递的值把其字段编码设置为1-15之间的值。

消息中的字段的编码值无需连续，只要是合法的，并且不能在同一个消息中有字段包含相同的编码值。

下面是参考的数据类型：

![Center][]

然后打开CMD，cd到bin目录，输入编译命令编译文件：

protoc --proto\_path=G:\\Tools\\protoc-3.1.0-win32\\bin  --java\_out=G:\\Tools\\protoc-3.1.0-win32\\bin  G:\\Tools\\protoc-3.1.0-win32\\bin\\Header.proto

命令解释：

protoc 是命令，\--proto\_path是输入路径（可以用 \--I 代替），\--java\_out是输出路径，最后面跟着的是要编译的文件路径

执行命令过后，就能得到编译好的.java文件，文件不需要改，直接复制到工程中使用，跟实体类差不多。

在java中使用还需要一个jar包：http://download.csdn.net/detail/kokjuis/9729811 [点击打开链接][Link 2]

如果想要做消息嵌套，可以这样，然后生成这个文件即可：

syntax = "proto3"; //指定版本，必须要写（proto3、proto2）
     
    import "Header.proto";
    import "User.proto";
    import "Body.proto";
     
    message Message{
    Header header=1;
    User user=2;
    Body body=3;
    }

使用的时候：

UserInfoOuterClass.UserInfo.Builder userInfo = UserInfoOuterClass.UserInfo.newBuilder();
     userInfo.setReceiverId(message.getUserInfo().getReceiverId());
     userInfo.build();

从protobuf转json
    Message someProto = SomeProto.getDefaultInstance();
    String jsonFormat = JsonFormat.printToString(someProto);
    
    
    从json转protobuf
    Message.Builder builder = SomeProto.newBuilder();
    String jsonFormat = load json from source;
    JsonFormat.merge(jsonFormat, builder);

[Link 1]: http://download.csdn.net/detail/kokjuis/9729750
[Center]: /images/20220713/e4531caca0354a94a3b239201884e372.png
[Link 2]: http://download.csdn.net/detail/kokjuis/9729811