ProtoBuf使用初体验-Android Studio配置及JSON互转

最近参与一个新项目的开发,才用了ProtoBuf作为前端和后台之间的通信协议。关于ProtoBuf的知识我就不细说了,具体可参考官网https://developers.google.com/protocol-buffers/docs/proto3#json

Android Studio配置

作为google的亲儿子,可以通过配置,直接在Android Studio中根据proto文件生成java代码并使用。在移动端,推荐使用protobuf-lite版本以节省资源。
一、在project的build.gradle中添加如下内容

buildscript {
    repositories {
        jcenter()
        mavenCentral()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.0.1'
        classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.6'
    }
}

二、在project中增加一个proto的module,用于管理proto及生成的java文件。在其build.gradle中增加以下内容

...
apply plugin: 'com.google.protobuf'
...
android{
...
sourceSets {
        main {
            java {
                srcDir 'src/main/java'
            }
            proto {
                srcDir 'src/main/proto'
                include '**/*.proto'
            }
        }
    }
}
protobuf {
    //这里配置protoc编译器
    protoc {
        artifact = 'com.google.protobuf:protoc:3.0.0'
    }
    plugins {
        javalite {
            // The codegen for lite comes as a separate artifact
            artifact = 'com.google.protobuf:protoc-gen-javalite:3.0.0'
        }
    }
    //这里配置生成目录,编译后会在build的目录下生成对应的java文件
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                // In most cases you don't need the full Java output
                // if you use the lite output.
                remove java
            }            
            task.plugins {
                javalite {}
            }
        }
    }
}
dependencies {
    ...
    compile 'com.google.protobuf:protobuf-lite:3.0.0'
    ...
}

三、在proto模块的src/main目录下创建proto目录,用于放置.proto文件。java文件中可放置处理protobuf的一些代码,报名与.proto文件中的package保持一致。


image.png

四、编译,可在proto模块的build/generated/source/proto路径看到生成的java文件。


image.png

ProtoBuf与JSON互转

Android Studio中可使用protobuf-java-format工具实现JSON和ProtoBuf之间的转换。
1、在proto模块的build.gradle文件中增加protobuf-java-format的编译依赖

...
dependencies {
   ...
    api 'com.googlecode.protobuf-java-format:protobuf-java-format:1.2'
}
...

2、ProtoBuf转Json

String jsonFormat = JsonFormat.printToString(protoMsg);

3、Json转ProtoBuf

JsonFormat.merge(jsonFormat, protoMsgBuilder)

注意,在protobuf中另有一个util工具库提供转化,但是测试中发现性能不及上面的JsonFormat库。该util库的编译依赖如下:

 api 'com.google.protobuf:protobuf-java-util:3.6.0'

代码可参考 com.google.protobuf.util.JsonFormat.java,使用方法与上面的有所不同。

参考文档:
Protocol Buffer 3 学习笔记
Mac下protobuf安装,并用maven编译导出jar包
https://stackoverflow.com/questions/15723099/where-to-find-protobuf-jar-for-using-google-protocol-buffers-in-java
https://stackoverflow.com/questions/28545401/java-json-protobuf-back-conversion

https://proandroiddev.com/how-to-setup-your-android-app-to-use-protobuf-96132340de5c

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,413评论 25 707
  • mean to add the formatted="false" attribute?.[ 46% 47325/...
    ProZoom阅读 2,689评论 0 3
  • afinalAfinal是一个android的ioc,orm框架 https://github.com/yangf...
    wgl0419阅读 6,263评论 1 9
  • 昨儿跟高中同学的微聊中,我很自然地随口说出了内心已经酝酿许久的想法――写回忆录,看来那个时间点真的到来了。这个事情...
    行之舞者阅读 254评论 1 1
  • 那天我去平遥,全中国唯二的联合国物质文化遗产基地,才明白金华这个吃火腿长大的城市,灵魂里全是和猪有关的故事!(不屑...
    穆诺阅读 198评论 0 0