Protobuf简单示例

原创已于 2025-09-09 12:07:16 修改 · 1.3k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#谷歌 #protobuf #google #序列化 #反序列化

于 2019-06-19 16:31:37 首次发布

Protobuf 专栏收录该内容

1 篇文章

订阅专栏

博客以win64系统、Java语言为例，介绍Protobuf编译器的下载与配置，包括从指定页面下载、解压并配置环境变量。还说明了如何新建proto文件、生成Java类，将其引入Eclipse工程，下载并引入支持jar包，最后编写测试用例验证序列化和反序列化。

本例以win64为操作系统、Java为开发语言展开。

1、下载Protobuf编译器：

访问页面：https://github.com/protocolbuffers/protobuf/releases，在这个页面找到protoc-3.8.0-win64.zip链接，点击该链接下载Protobuf编译器。

解压该zip文件到当前目录，将当前文件夹下的bin目录的绝对路径配置到系统环境变量“Path”中。

2、打开命令行，执行“protoc --version”，如果正确显示Protobuf的版本号，证明设置成功。

3、在当前文件加下新建一个名字叫“msg.proto”的文本文件，在文件里输入如下内容：

syntax = "proto2";

option java_package = "com.protobuf.test"; 
option java_outer_classname = "UserProtobuf";

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

4、在命令行中进入当前目录（注意，要在当前文件夹下先新建一个叫做“out_src”的目录），并执行以下命令：

protoc -I=. --java_out=.\out_src msg.proto

5、进入当前文件夹下的“out_src”目录，可以看到已经生成了一个Java类：

6、用文本编辑器打开该类文件，复制文件内容到Eclipse中（前提是Eclipse中已经建立了一个Java工程）。

7、到Maven repository网站（百度“mvn repo”，第一个链接就是该网站）下载Protobuf的Java支持jar包，并引入到当前工程中。

8、编写测试用例，验证序列化和反序列化，代码如下：

package com.protobuf.test;

import java.io.ByteArrayOutputStream;

/**
 * @author Bright Lee
 */
public class Test {
	
	public static void main(String[] args) throws Exception {
		UserProtobuf.User user = UserProtobuf.User.newBuilder()
			    .setId(1234)
			    .setName("Bright Lee")
			    .setEmail("你好@你好.com")
			    .build();

		ByteArrayOutputStream out = new ByteArrayOutputStream(9999);
		user.writeTo(out);
		byte[] bin = out.toByteArray();
		
		user = UserProtobuf.User.parseFrom(bin);
		
		System.out.println(user.getEmail());
	}

}

9、工程目录结构如下：