- Protobuf 是什么
Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准,目前已经正在使用的有超过 48,162 种报文格式定义和超过 12,183 个 .proto 文件。他们用于 RPC 系统和持续数据存储系统。
Protocol Buffers 是一种轻便高效的结构化数据存储格式,可以用于结构化数据串行化,或者说序列化。它很适合做数据存储或 RPC 数据交换格式。可用于通讯协议、数据存储等领域的语言无关、平台无关、可扩展的序列化结构数据格式。目前提供了 C++、Java、Python 三种语言的 API。 protoBuf的优缺点
第一:protobuf 的优点
1,性能好,效率高
2,代码生成机制,数据解析类自动生成
3,支持向后兼容和向前兼容
4,支持多种编程语言(java,c++,python)protoBuf的Java 入门流程图
- protoBuf的Java 入门详细步骤
第一步:定义数据结构
PersonMsg.proto(注意文件名和里面的message名不要一样)。
[plain] view plain copy
1. message Person {
2.
3. // ID(必需)
4. required int32 id = 1;
5.
6. // 姓名(必需)
7. required string name = 2;
8.
9. // email(可选)
10. optional string email = 3;
11.
12. // 朋友(集合)
13. repeated string friends = 4;
14. }
第二步:protoc.exe生成Java代码PersonMsg.proto
使用文件protoc.exe,cmd命令行运行:
protoc.exe –java_out=E:\java PersonMsg.proto
第三步:序列化
第四步:反序列化
1. import java.io.ByteArrayInputStream;
2. import java.io.ByteArrayOutputStream;
3. import java.io.IOException;
4. import java.util.List;
5.
6. public class Main {
7.
8. public static void main(String[] args) throws IOException {
9.
10. // 按照定义的数据结构,创建一个Person
11. PersonMsg.Person.Builder personBuilder = PersonMsg.Person.newBuilder();
12. personBuilder.setId(1);
13. personBuilder.setName("叉叉哥");
14. personBuilder.setEmail("xxg@163.com");
15. personBuilder.addFriends("Friend A");
16. personBuilder.addFriends("Friend B");
17. PersonMsg.Person xxg = personBuilder.build();
18.
19. // 将数据写到输出流,如网络输出流,这里就用ByteArrayOutputStream来代替
20. ByteArrayOutputStream output = new ByteArrayOutputStream();
21. xxg.writeTo(output);
22.
23. // -------------- 分割线:上面是发送方,将数据序列化后发送 ---------------
24.
25. byte[] byteArray = output.toByteArray();
26.
27. // -------------- 分割线:下面是接收方,将数据接收后反序列化 ---------------
28.
29. // 接收到流并读取,如网络输入流,这里用ByteArrayInputStream来代替
30. ByteArrayInputStream input = new ByteArrayInputStream(byteArray);
31.
32. // 反序列化
33. PersonMsg.Person xxg2 = PersonMsg.Person.parseFrom(input);
34. System.out.println("ID:" + xxg2.getId());
35. System.out.println("name:" + xxg2.getName());
36. System.out.println("email:" + xxg2.getEmail());
37. System.out.println("friend:");
38. List<String> friends = xxg2.getFriendsList();
39. for(String friend : friends) {
40. System.out.println(friend);
41. }
42. }
43.
44. }
- 核心概念
5.1 .proto文件
.proto文件相当于确定数据协议,数据结构中存在哪些数据,数据类型是怎么样
5.2 .proto文件中的修饰符modifiers
required 不可以增加或删除的字段,必须初始化
optional 可选字段,可以为0个或1个但不能大于1个可删除,可以不初始化
repeated 可重复字段, 对应到java文件里,生成的是List
5.3. proto文件中Message
在proto文件里,message是消息定义的关键字,数据的协议时以Message的形式表现的。
5.4. proto文件中Build
生成具体的java类时,例如Person.java,同时会存在build方法。文档的意思是对于转化后的数据,具有唯一性,build提供了便利的方法来初始化这些数据。
现的。
5.5. proto文件中序号
最后的1,2,3则是代表每个字段的一个唯一的编号标签,在同一个消息里不可以重复。这些编号标签用与在消息二进制格式中标识你的字段,并且消息一旦定义就不能更改。需要说明的是标签在1到15范围的采用一个字节进行编码。所以通常将标签1到15用于频繁发生的消息字段。编号标签大小的范围是1到229 – 1。此外不能使用protobuf系统预留的编号标签(19000 -19999)。
- protoBuf的数据类型对应关系
一个标量消息字段可以含有一个如下的类型——该表格展示了定义于.proto文件中的类型,以及与之对应的、在自动生成的访问类中定义的类型: