Android 接入protobuf-java库(非nano和l

作者: 十个雨点 | 来源:发表于2018-09-20 20:12 被阅读81次

    最近给项目接入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
    

    相关文章

      网友评论

        本文标题:Android 接入protobuf-java库(非nano和l

        本文链接:https://www.haomeiwen.com/subject/bfwxixtx.html