Android 接入protobuf-java库(非nano和lite库)

最近给项目接入protobuf库,做了一番调研。Android和protobuf不愧都是谷歌的亲儿子,protobuf提供了nano、lite、java三个版本供Android选用,真是挑花了眼。

其实三者是按照库大小依次增大的,理所当然他们支持的protobuf特性也是依次增加的。

其实官方推荐Android使用的是lite库,因为其支持大部分特性,包体积又比较小,而且因为没有用到反射,所以不需要处理混淆问题。

而我这次需要用到Any的类型,这可以看成是protobuf中的泛型,可以方便的进行动态解析,可是nano库和lite库都不支持,所以只好接入protobuf-java库。

lite库的接入方法网上有很多,比如这篇:ProtoBuf在Android中的简单使用,或者直接阅读官方的文档都可以很快接入:
Github-progobuf
Github-protobuf-gradle-plugin

但是protobuf-java的接入方法有点不一样,我摸索了很久才终于成功了,这里记录一下,供有需要的人使用。

0.我这里使用的是最新版:protobuf-java:3.6.1,protoc:3.1.0,protobuf-gradle-plugin:0.8.6,读者如果需要更新版本,参照github更新到最新应该就可以了。

1.在项目根目录的build.gradle中添加依赖:

    dependencies {
        classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.6'
    }

2.在用到protobuf的module的build.gradle中添加protobuf的plugin:

apply plugin: 'com.google.protobuf'

3.添加protobuf的配置


protobuf {
    protoc {
        // You still need protoc like in the non-Android case
        artifact = 'com.google.protobuf:protoc:3.6.1'
    }
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                java {}
            }
        }
    }
}

4.添加proto文件的路径

android {
    sourceSets {
        main {
            proto {
                srcDir 'src/main/proto'  //proto文件所在路径
                include '**/*.proto'
            }
            java {
                srcDir 'src/main/java'
            }
        }
    }
}

5.添加protobuf-java和protoc的依赖,其中protoc的依赖很重要,lite版使用方法中不需要添加,所以很容易漏掉

dependencies {
    compile 'com.google.protobuf:protobuf-java:3.6.1'
    compile 'com.google.protobuf:protoc:3.1.0'
}

其中第3,4,5步跟lite版的配置不太一样,要注意哦。

最终的build.gradle文件如下:

apply plugin: 'com.android.library'
apply plugin: 'com.google.protobuf'

protobuf {
    protoc {
        // You still need protoc like in the non-Android case
        artifact = 'com.google.protobuf:protoc:3.6.1'
    }
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                java {}
            }
        }
    }

}

android {
    android {
        compileSdkVersion 24
        buildToolsVersion "24.0.3"

        defaultConfig {
            minSdkVersion 15
            targetSdkVersion 22
        }
    }
    sourceSets {
        main {
            proto {
                srcDir 'src/main/proto'  //proto文件所在路径
                include '**/*.proto'
            }
            java {
                srcDir 'src/main/java'
            }
        }
    }

}

dependencies {
    compile fileTree(include: ['*.jar'], dir: 'libs')
    compile 'com.google.protobuf:protobuf-java:3.6.1'
    compile 'com.google.protobuf:protoc:3.1.0'
}

最后是混淆规则:

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

推荐阅读更多精彩内容