一 、Google Protobuf 介绍
protobuf是google团队开发的用于高效存储和读取结构化数据的工具,是Google的编解码技术,在业界十分流行,通过代码生成工具可以生成不同语言版本的源代码。protobuf有2.0版本和3.0版本,3.0版本十grpc框架的基础
Protocol buffers目前支持Java, Python, Objective-C, 和C++生成代码。新的proto3语言版本,你可以使用Go, JavaNano, Ruby, 和 C#。
1.为什么使用Protocol buffers
Protocol buffers是灵活,高效,自动化的解决方案。 使用Protocol buffers,您可以编写一个.proto描述您希望存储的数据结构。 Protocol buffers编译器创建一个实现自动编码和解析协议缓冲区数据的类,并使用高效的二进制格式。 生成的类为组成Protocol buffers的字段提供getter和setter。
2.下载Protobuf
访问Google的Protobuf项目页需要×××,但是其也把代码放到了Github上,并且提供了不需要编译即可进行使用的版本,地址如下:
https://github.com/protocolbuffers/protobuf/releases 这里我们下载:protoc-3.7.1-win64.zip
二、使用Protobuf编写一个编码解码的最简单程序
在这里我们分三步完成测试:
- 在 .proto结尾的文件中定义消息格式。
- 使用protocol buffers编译器将 .proto结尾的文件生成对应语言的源代码(本demo使用java编译器)。
- 使用Java protocol buffer API 去读写消息。
1.第一步:定义一个Person.proto文件
syntax = "proto2";
package protobuf;
option java_package = "com.ssy.protobuf";
option java_outer_classname = "PersonProbuf";
message Person {
required int32 id = 1;
required string name = 2;
optional int32 age = 3;
optional string address = 4;
}
第二步:使用protocol buffers编译器将对应的.proto文件编译成对应的类
使用文件protoc.exe,cmd命令行运行:
protoc.exe --java_out=E:\Java PersonMsg.proto
第三步:在idea中新建java项目,将上步生成文件拷贝到项目中
第四步:修改 build.gradle 引入proto库 "com.google.protobuf:protobuf-java:3.8.0-rc-1"
一般来说,序列化和反序列化是分开的。例如网络传输,由一方将数据序列化后发送给另一方来接收并解析,序列化发送和接收反序列化并不在一起。但是下面为了例子简单将二者写在同一程序中。
第五步:编写测试程序:
package com.ssy.netty.proto; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.util.List; public class Test { public static void main(String[] args) throws IOException { // 按照定义的数据结构,创建一个Person PersonProbuf.Person.Builder personBuilder = PersonProbuf.Person.newBuilder(); personBuilder.setId(1); personBuilder.setName("灿灿"); personBuilder.setAge(35); personBuilder.setAddress("河北石家庄"); PersonProbuf.Person xxg = personBuilder.build(); // 将数据写到输出流,如网络输出流,这里就用ByteArrayOutputStream来代替 ByteArrayOutputStream output = new ByteArrayOutputStream(); xxg.writeTo(output); // -------------- 分割线:上面是发送方,将数据序列化后发送 --------------- byte[] byteArray = output.toByteArray(); // -------------- 分割线:下面是接收方,将数据接收后反序列化 --------------- // 接收到流并读取,如网络输入流,这里用ByteArrayInputStream来代替 ByteArrayInputStream input = new ByteArrayInputStream(byteArray); // 反序列化 PersonProbuf.Person xxg2 = PersonProbuf.Person.parseFrom(input); System.out.println("ID:" + xxg2.getId()); System.out.println("name:" + xxg2.getName()); System.out.println("age:" + xxg2.getAge()); System.out.println("address:" + xxg2.getAddress()); } }
运行程序得到结果如图:
到此我们编写了一个简单的基于google Protobuf 协议的测试程序,下节我们会将google Protobuf与netty结合使用,敬请期待!!!