基于Protocol Buffers的文件编解码

1. 序

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

2. 定义proto文件

定义一个学生类,如下所示:

package com.demo.proto

option java_package = "com.demo"
option java_outer_classname = "student"

message student {
  required int32 stuid = 1;
  required string stuname = 2;
  repeated string score = 3;
}

[注]
(1) java_package:该文件生成的java文件的包路径;
(2) java_outer_classname:生成的class的名称;
(3) message是proto文件的基本类型,类似于java的class;
(4) required表名该字段是必须的,repeated表名该字段可重复,类似于java中的List;
(5) 每个声明后的数字表示该字段在序列化后的二进制数据中的布局位置,同级的声明数字不能重复。

3. 转化为java文件

Google提供了一个类似脚本的工具,将所写的proto文件复制到该文件下:

protobuf.png

命令行键入:

protoc.exe --java_out=./student.proto

会生成student.java文件:

student.png

4. 福利操作

由于在第3步中,给出的工具脚本在CSDN上已经有点expensive...现提供一个福利操作。可以下载Google在GitHub中的protobuf工具,根据系统选择不同类型的文件。

protoc.png

解压后得到
protoc-3.5.0-win32.png

为以后运行命令方便,可将bin目录配置到环境变量中。
配置完成后,命令行键入:

protoc --version

可得出protoc的版本信息


libprotoc.png

将原来的proto文件对应改为:

syntax = "proto2";

package com.demo.proto;

option java_package = "com.demo";
option java_outer_classname = "studentinfo";

message student {
  required int32 stuid = 1;
  required string stuname = 2;
  repeated string score = 3;
}

需加入syntax = "proto2";才可以编译成功,由于定义的参数类型中有required类型,不能使用proto3,具体proto2及proto3的区别可见文章。
命令行键入:

protoc --java_out=./ student.proto

可得出相应的java文件:


studentinfo.png

你可能感兴趣的:(基于Protocol Buffers的文件编解码)