protobuf-java的使用

  • 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再使用,感觉不方便

肥肥小浣熊
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,233评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,013评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,030评论 0 241
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,827评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,221评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,542评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,814评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,513评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,225评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,497评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,998评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,342评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,986评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,812评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,560评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,461评论 2 266

推荐阅读更多精彩内容