Android项目中gradle文件里面的productFlavors一些常用配置

1,182 阅读4分钟

productFlavors的用处

##1.增加包环境种类 项目里面常常会用到很多环境,拿打包来说,一个项目,从开发到正式上线,可能要经过很多阶段.那么,在这些不同的阶段内,要验证Android应用,不可避免的需要打出很多不同环境的包,例如开发环境(dev),测试环境(tes),正式环境(pro). 在这么多的环境中,假如需要配合测试API接口,那么不同环境项目中的API地址会一样吗,肯定不会吧,如果在需要有其他的一些配置信息,每个环境不一样,那每次打包要去手动修改会很麻烦.这时候可以用到productFlavors来试试: 废话不多说,先看看项目建成后,在打包时,你会有多少的选择: 新建项目.png

都是这样的,应该没有异议吧.... 那么开始慢慢的增加: 1.在app下的build.gradle里面增加这些代码:


flavorDimensions "mode"//这里起什么名字都可以,姑且叫 mode吧
productFlavors{
    dev{
        dimension "mode"
    }
    tes{
        dimension "mode"
    }
    pro{
        dimension "mode"
    }
}
看看发生了什么:

配置选择.png

当然,相应的打包时的项目选择也多了起来:

打包选择.png

##2.添加一些项目常用配置 现在有那么多环境的包,有啥用?在每个不同环境的包里面配置自己需要的东西啊,比如咱们刚才说的,每个环境的API地址不一样,怎么;再比如说,我开发环境需要支持自动升级,可我正式环境不想支持了,需要一个常量做一个标示,怎么办?盘他就得了!

flavorDimensions "mode"
productFlavors{
    dev{
        dimension "mode"
        buildConfigField("String", "HTTP_BASE", '"https://www.xxx.com/dev/"')
        buildConfigField("boolean", "UPDATE", "true")//那里需要用了,直接BuildConfig.UPDATE就取出来了,就这么简单
    }
    tes{
        dimension "mode"
        buildConfigField("String", "HTTP_BASE", '"https://www.xxx.com/tes/"')
        buildConfigField("boolean", "UPDATE", "false")


    }
    pro{
        dimension "mode"
        buildConfigField("String", "HTTP_BASE", '"https://www.xxx.com/pro/"')
        buildConfigField("boolean", "UPDATE", "false")

    }
}
把格式说一下    buildConfigField("常量类型","常量名称","常量值")

这样会在项目构建的是后,在项目的Build.config中生成项目的配置文件,类似这样: image.png 你选择的是开发环境,那么这里面的配置就是dev环境下的地址,同理tes,pro环境一样.

3.可以用来配置清单文件里面的值

这个最常用的就是在清单文件里面需要配置app_key,app_id的时候了,很多的三方SDK是需要配置这个东西的,比如某盟,某语音等等一大堆,这个时候,开发是用的key和id肯定不能正是环境也用,或者给不同的客户打不同的包,用的也不能一样,这是后,需要进行一些配置: 在清单文件(AndroidManifest)里面,application节点下这样配置:

<meta-data
            android:name="app_id"
            android:value="${app_id_value}" />//占位符
        <meta-data
            android:name="app_key"
            android:value="${app_key_value}" />

在刚刚的productFlavors下面这样配置:

productFlavors{
    dev{
        dimension "mode"
        buildConfigField("String", "HTTP_BASE", '"https://www.xxx.com/dev/"')
        manifestPlaceholders = [app_id_value        : "123456"
                                ,app_key_value      : "654321"]
    }
    tes{
        dimension "mode"
        buildConfigField("String", "HTTP_BASE", '"https://www.xxx.com/tes/"')
        manifestPlaceholders = [app_id_value        : "111111"
                                ,app_key_value      : "222222"]  //替换两个以上的用逗号隔开
    }
    pro{
        dimension "mode"
        buildConfigField("String", "HTTP_BASE", '"https://www.xxx.com/pro/"')
        manifestPlaceholders = [app_id_value        : "223344"
                                ,app_key_value      : "556677"]
    }
}

除了设置这些之外,还可以给不同环境配置不同的包名,版本号,版本名称,并且在选择不同环境运行或者打包的时候,显示的包名是不一样的,这个我验证过了,上个全的:

flavorDimensions "mode"
productFlavors{
    dev{
        dimension "mode"
        applicationId "com.liucl.dev.app"
        versionName "1.0.0"
        versionCode 10
        buildConfigField("String", "HTTP_BASE", '"https://www.xxx.com/dev/"')
        buildConfigField("boolean", "UPDATE", "true")
        manifestPlaceholders = [app_id_value        : "123456"
                                ,app_key_value      : "654321"]
    }
    tes{
        dimension "mode"
        applicationId "com.liucl.tes.app"
        versionName "2.0.0"
        versionCode 20
        buildConfigField("String", "HTTP_BASE", '"https://www.xxx.com/tes/"')
        buildConfigField("boolean", "UPDATE", "true")
        manifestPlaceholders = [app_id_value        : "111111"
                                ,app_key_value      : "222222"]
    }
    pro{
        dimension "mode"
        versionName "3.0.0"
        versionCode 30
        applicationId "com.liucl.pro.app"
        buildConfigField("String", "HTTP_BASE", '"https://www.xxx.com/pro/"')
        buildConfigField("boolean", "UPDATE", "false")
        manifestPlaceholders = [app_id_value        : "223344"
                                ,app_key_value      : "556677"]
    }
}

4.根据不同的productFlavors,引入不同的依赖包:

举个例子:我dev环境想用刘氏财团的 发财_aar 包 ; tes环境用 长寿_aar 包 ; 正式环境用 喜庆_aar包,改咋办? 1.新加节点configurations, 2.在dependencies中添加以下配置

configurations {
    dev
    tes
    pro
}

def date = "20201222"//aar的日期
def ver = "v1.0.2_"  //aar的版本
dependencies {
    .....

    devImplementation(name: '发财_'  + ver + date, ext: 'aar')
    tesImplementation(name: '长寿_' + ver + date, ext: 'aar')
    proImplementation(name: '喜庆_' + ver + date, ext: 'aar')
    .......
}

5.再说说打包吧

在build.gradle里面增加一些配置,可以使打出来的包有自己的命名规则,比如什么名称,版本是多少,打包时间是什么时候,这样的配置可以避免很多时候,打包多了,不知道那个包是什么时候打的,这很让人头大,上代码配置:

buildTypes {//在android节点下
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            android.applicationVariants.all {
                variant ->
                    if (variant.buildType.name == 'release') {
                        variant.outputs.all {
                            outputFileName = "LCL_v${defaultConfig.versionName}_${variant.productFlavors[0].name}_${variant.buildType.name}_${releaseTime()}.apk"
                        }
                    }
            }
            signingConfig signingConfigs.release
        }
    }

另外需要配置这些:

signingConfigs {  //在Android节点下
        release {
            keyAlias 'liucl'
            keyPassword 'liucl3889@.'
            storeFile file('./liucl.jks')
            storePassword 'liucl3889@.'
        }
    }

再加这个:

static def releaseTime() {  //获取时间的方法,在Android节点外,另外的节点
    return new Date().format("yyyyMMddHHmm", TimeZone.getDefault())
}
  ok就这些了,如有错误,欢迎指出,反正我也不会改,你能拿我怎么样.....

皮.png