Protocol Buffers(简称protobuf)是谷歌的一项技术,用于将结构化的数据序列化、反序列化,经常用于网络传输。

这货实际上类似于XML生成和解析,但protobuf的效率高于XML,不过protobuf生成的是字节码,可读性比XML差。类似的还有json、Java的Serializable等。

protobuf支持各种语言。本文以Java为例,简单介绍protobuf如何使用。其他语言使用方法类似。

首先需要下载:

解压后有两个文件:protobuf-java-2.5.0.jar和protoc.exe。

protobuf-java-2.5.0.jar即protobuf所需要的jar包,如果用maven的话可以无视这个文件;

protoc.exe是protobuf代码生成工具。

第一步:定义数据结构

首先要定义protobuf的数据结构,这里要写一个.proto文件。这个文件有点类似于定义一个类。例如定义一个Person,保存文件PersonMsg.proto(注意文件名和里面的message名不要一样)。

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. }

上面的1、2、3、4是unique numbered tag,是一个唯一标识。

上面的例子中定义了一个非常简单的数据结构,当然还可以定义更复杂的结构,这里不再讨论,具体可以看官方文档。

第二步:protoc.exe生成Java代码

使用文件protoc.exe,cmd命令行运行:

protoc.exe --java_out=E:\java PersonMsg.proto

输入文件是PersonMsg.proto,也就是定义数据结构的文件;输出文件夹是E:\java,将java文件生成在E:\java中。运行命令成功后会生成PersonMsg.java:


java proto 生成 java protostuff_序列化

在Eclipse中创建一个项目,将java文件拷贝到项目中。项目中需要引入protobuf-java-2.5.0.jar包。如果是maven项目则加入:

1. <dependency>  
2. <groupId>com.google.protobuf</groupId>  
3. <artifactId>protobuf-java</artifactId>  
4. <version>2.5.0</version>  
5. </dependency>

第三步:序列化

第四步:反序列化

一般来说,序列化和反序列化是分开的。例如网络传输,由一方将数据序列化后发送给另一方来接收并解析,序列化发送和接收反序列化并不在一起。但是下面为了例子简单将二者写在同一程序中。

    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. 1);  
    13. "叉叉哥");  
    14. "xxg@");  
    15. "Friend A");  
    16. "Friend B");  
    17.         PersonMsg.Person xxg = personBuilder.build();  
    18.           
    19. // 将数据写到输出流,如网络输出流,这里就用ByteArrayOutputStream来代替  
    20. new ByteArrayOutputStream();  
    21.         xxg.writeTo(output);  
    22.           
    23. // -------------- 分割线:上面是发送方,将数据序列化后发送 ---------------  
    24.           
    25. byte[] byteArray = output.toByteArray();  
    26.           
    27. // -------------- 分割线:下面是接收方,将数据接收后反序列化 ---------------  
    28.           
    29. // 接收到流并读取,如网络输入流,这里用ByteArrayInputStream来代替  
    30. new ByteArrayInputStream(byteArray);  
    31.           
    32. // 反序列化  
    33.         PersonMsg.Person xxg2 = PersonMsg.Person.parseFrom(input);  
    34. "ID:" + xxg2.getId());  
    35. "name:" + xxg2.getName());  
    36. "email:" + xxg2.getEmail());  
    37. "friend:");  
    38.         List<String> friends = xxg2.getFriendsList();  
    39. for(String friend : friends) {  
    40.             System.out.println(friend);  
    41.         }  
    42.     }  
    43.   
    44. }  
    45.