背景:
这几天在写一个服务端的socket的通讯服务器,之前是自己定义的协议因为,因为只是android客户端和服务器通讯,后来iOS也连接到这个socket服务器上,为了跨语言通讯,发现Google的 ProtoBuf(Protocol Buffer)支持跨语言通讯,而且效率非常高。
ProtoBuf是什么?
Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准,后来才开源的,它是一个灵活、高效、结构化的序列化数据结构,它与传统的XML等通讯相比,它的更小、更快、更简单。
protoBuf的优点
1.protoBuf在Google内部长期使用,产品稳定成熟,很多商业的项目都选择使用
2.跨语言,它支持Java、C++、Python、ObJect-c、C#、Go等语言,
3.protoBuf编码后消息更小、有利于存储传输
4.编码和解码的效率非常之高
5.支持不同版本的协议向前兼容
6.支持自定义可选和必选字段
我们先要下载ProtoBuf,,下载地址为 github.com/google/prot… 这里我是使用Windows版
我们要是的是protoc.exe工具,它是根据.proto文件生成对应的代码转换工具,就这么简单ProtoBuf的编译环境我们已经搞定了。
protoBuf的Demo
这里使用Java语言实现,我们首选要定义一个protoBuf格式的通讯协议,Login.proto文件
package test;
option java_package = "sg.com.protobuf";
option java_outer_classname = "LoginProto";
message Login{
required int32 id = 1;
required string name = 2;
required string pws = 3;
optional string email = 4;
}复制代码
package:指定生成Java代码文件的包名
java_package:指定生Java类的包名
java_outer_classname:指定生成Java代码的外部类名称。如果没有指定该选项,Java代码的外部类名称为当前文件的文件名部分,同时还要将文件名转换为驼峰格式,如:my_project.proto
message:protoBuf消息定义的关键字,相当于Java中的class
required:数据类型的前缀,表示该字段为必要字段,既在序列化和反序列化之前该字段必须已经被赋值
repeated:表示这个字段的值可以允许被重复多次,如果转换成JAVA代码,此filed数据结构为list,有序的。可以在“repeated”类型的filed后使用“packed”--压缩,提高数据传输的效率。
optional: 表示这个值是可选的允许为null
ProtoBuf类型和Java类型对应关系
ProtoBuf支持枚举类型,protobuf中enum类型的每个值是一个int32的数字,不像JAVA中那样enum可以定义的非常复杂。如果enum中有些值是相同的,可以将“allow_alias”设定为true
完成消息的定义之后,就可以通过protoc.exe编译了
编译的命令格式
protoc.exe -I=proto的输入目录 --java_out=java类输出目录 proto的输入目录包括包括proto文件.
编译好java类后,我们就可以实例化和序列化了
LoginProto.Login.Builder builder = LoginProto.Login.newBuilder();
builder.setId(1);
builder.setName("sgtest");
builder.setPws("123");
builder.setEmail("test@163.com");
//获取login的实例
LoginProto.Login login = builder.build();
System.out.println(login);
//序列化
System.out.println("---------");
byte[] bytes = login.toByteArray();
System.out.println("leng:"+bytes.length);
login =LoginProto.Login.parseFrom(bytes);
System.out.println(login);复制代码
实例化一个对象是非常方便的,使用Google给我们生成的静态方法就可以,通过toByteArray()方法来实现序列,parseFrom(bytes)方法来实现反序列化,你会看到protoBuf序列化后的字节长度非常小,这个还不算强大的,下面再来看一中序列化的方式:
//第二种序列化
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
login.writeDelimitedTo(byteArrayOutputStream);
//反序列化
ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(byteArrayOutputStream.toByteArray());
login = LoginProto.Login.parseDelimitedFrom(byteArrayInputStream);
System.out.println(login.getEmail());复制代码
做过大量socket数据传输的同学都知道,socket很容易发生粘包、拆包的问题,会导致数据解析错误,protoBuf可以搞定它,login.writeDelimitedTo(byteArrayOutputStream)方法,将一个对象序列化输出到一个字节数组流中,它在序列化的字节数组之前,添加一个varint32的数字表示字节数组的长度,所以实际放在字节数据中内容应该是数据的长度加上数据的内容,下面是该方法的源码
在解码通过先读取varint,再读取此长度的字节;这种方式有效的解决了socket传输时粘包、拆包的问题。
最后给出demo下载地址: download.csdn.net/detail/mtx_…