protobuf-java的使用

2017-12-10 本文已影响443人江江的大猪

protobuf是谷歌定义的一种语言无关、平台无关的数据交换格式，可以将对象序列化为字节数组、将字节数组反序列化为对象。

protobuf支持多种编程语言，这里使用的是java的protobuf2.5.0版本

PS:现在在protobuf的github里，最老的版本是2.7，但是因为平时工作的工程里用的2.5版本，电脑里的环境也是2.5的，低版本protobuf可以百度搜到资源

使用方法

编译得到protoc工具，下载protobuf的源码，进入源码目录后

 ./configure --prefix=/usr/local/protobuf2.5    要安装到的目录
make
make install
# PS：之前还用过2.3版本protobuf，make时会报错，解决方法：
# 在src/google/protobuf/message.cc中，添加`#include<istream>`

安装完成后会在/usr/local/protobuf2.5下生成bin、include、lib三个文件夹，我们要用的是bin下的protoc工具:
/usr/local/protobuf2.5/bin/protoc --proto_path=. --java_out=/Users/laifuzhi/IdeaProjects/template/src/main/java/ MyProto.proto
该命令会将当前文件夹下的MyProto.proto文件转换为一个java源文件，放到/Users/laifuzhi/IdeaProjects/template/src/main/java/目录下

工程中引入protobuf的jar包，和protoc的版本保持一致，可以通过protoc的--version参数查看protoc的版本

<dependency>
    <groupId>com.google.protobuf</groupId>
    <artifactId>protobuf-java</artifactId>
    <version>2.5.0</version>
</dependency>

编辑protobuf文件：

option java_package = "com.lfz.proto"; //转换后的java源文件包名
option java_outer_classname = "FirstModule"; //转换后的java源文件文件名、类名
//demo
message CommonBean {
    required int32 id [default = 0] = 1; //编号
    required string name = 2; //姓名
    optional string address = 3; //地址
    repeated string messages = 4; //消息的list
}

使用习惯：将一个模块中需要使用的bean定义到一个proto文件中统一管理
简单用法：required为必填项，序列化反序列化必须有值；optional为可选项；repeated为list集合；每个属性必须有一个key，一般是从1一直递增，可以给属性设置默认值。protobuf的更多格式可以看这里

代码中的基本使用

FirstModule.CommonBean.Builder builder = FirstModule.CommonBean.newBuilder();
builder.setId(1).setName("lfz"); //id和name是required的，所以必填
FirstModule.CommonBean bean1 = builder.build();
byte[] bytes = bean1.toByteArray(); //序列化
FirstModule.CommonBean bean2 = FirstModule.CommonBean.parseFrom(bytes); //反序列化

tips

之前工作中需要将protobuf对象转换为json，使用jackson等工具不能直接转换，需要使用第三方工具:

<dependency>
    <groupId>com.googlecode.protobuf-java-format</groupId>
    <artifactId>protobuf-java-format</artifactId>
    <version>1.2</version>
</dependency>

现在最高1.4版本，和1.2版本用起来不一样

将上面的protobuf转为json并打印：

FirstModule.CommonBean.Builder builder = FirstModule.CommonBean.newBuilder();
builder.setId(1).setName("lfz");
FirstModule.CommonBean bean1 = builder.build();
System.out.println(JsonFormat.printToString(bean1));
byte[] bytes = bean1.toByteArray(); //比java的序列化短了很多
FirstModule.CommonBean bean2 = FirstModule.CommonBean.parseFrom(bytes);
System.out.println(JsonFormat.printToString(bean2));

1.4版本的JsonFormat没有静态工具方法了，需要先new出来JsonFormat再使用，感觉不方便

肥肥小浣熊

protobuf-java的使用

使用方法

猜你喜欢

热点阅读