protobuf-实践篇

前面两篇文章介绍了 protobuf 的概念用途以及 protobuf 编译器的安装。本章我来写一个简单的例子实践一下 protobuf 。我们知道 protobuf 支持 Java、c++、Python，本章以 Java 为例，写一个小例子。如果懒得看后面的啰嗦，可以直接下载 demo 源码研究。

• 下载支持 java 支持库，即 jar 文件

 到 protobuf 的 maven仓库 下载 最新的 jar 包。

 

• 创建 java 工程：DemoForProtobuf

如图，将下载的 jar 文件放到你的工程的 lib 中过去。

• 创建 .proto 文件

这里我们创建一个 addressbook.proto 的文件，表明这是一个表示通讯录的数据结构。

syntax = "proto2";
package tutorial;
option java_package = "com.example.tutorial";
option java_outer_classname = "AddressBookProtos";

message Person {
  required string name = 1;
  required int32 id = 2;
  optional string email = 3;

  enum PhoneType {
    MOBILE = 0;
    HOME = 1;
    WORK = 2;
  }

  message PhoneNumber {
    required string number = 1;
    optional PhoneType type = 2 [default = HOME];
  }

  repeated PhoneNumber phone = 4;
}

message AddressBook {
  repeated Person person = 1;
}

把这个文件保存到项目 src 根目录下（其实你可以放大指定的目录，这里我方便直接放到项目根目录了）

• 把 .proto 文件编译成 java 文件

启动终端，输入命令：

protoc -I=$SRC_DIR --java_out=$DST_DIR $SRC_DIR/addressbook.proto
-I= 表示项目源码路径 ；--java_out= 表示生成的 java 包路径 ，源码路径一样； 第三个参数 表示 要编译的.proto 文件路径。例如我 通过 cd 命令已经进入了项目的根路径，然后我的编译命令是：
 
protoc -I=src --java_out=src  src/addressbook.proto
最后再指定目录下生成了 AddressBookProtos.java 文件。

关于生成的 java 文件的内部结构你可以对比 .proto 文件定义的 message 体结构研究下。另外 生成的 java 文件生成的类都继承了 com.google.protobuf.GeneratedMessage 类、实现了 com.google.protobuf.MessageOrBuilder 接口，并实现了 java 对象到proto 序列化的写入和读取方法。

• 对象读和写

写一个 main 静态方法简单演示一下生成的对象的读和写。

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;

import com.example.tutorial.AddressBookProtos.Person;

public class Main {

	public static void main(String args[]){
		//创建一个Person对象
		Person john = Person.newBuilder()
				     .setId(1234)
				     .setName("John Doe")
				     .setEmail("jdoe@example.com")
				     .addPhone(Person.PhoneNumber.newBuilder()
			                   .setNumber("555-4321")
			                   .setType(Person.PhoneType.HOME))
			 	    .build();
		//将这个对象写到流
		writeToOutputStream(john);
		
		Person reJohn = parsFromInputStream();
		System.out.println(reJohn.getEmail());
		System.out.println(reJohn.getPhone(0).getNumber());
	}

	private static void writeToOutputStream(Person john) {
		// 这里写到一个文件流中，实际上多数会写到网络流中
		File f = new File("/Users/liuguangli/test.txt");
		FileInputStream input;
		FileOutputStream output;
		try {
			output = new FileOutputStream(f);
			john.writeTo(output);
			output.close();
			Person tim = null;
			input = new FileInputStream(f);
			tim = Person.parseFrom(input);
			
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
	}
	
	private static Person parsFromInputStream() {
		// 这里写到一个文件流中，实际上多数会写到网络流中
		File f = new File("/Users/liuguangli/test.txt");
		FileInputStream input;
		
		try {
			
			Person tim = null;
			input = new FileInputStream(f);
			tim = Person.parseFrom(input);
			return tim;
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
			return null;
		} 
		
	}
}

重点：demo 源码地址： https://github.com/liuguangli/DemoForProtobuf