Android 开发过程中,总是会遇到这样的场景: 1,app需要交付给不同的客户,每个客户都有自己相关的定制,这时候应该如何构建? 2, app上线连接生成环境,开发使用开发环境,测试使用测试环境,我想同时安装这3个环境的apk应该怎么办?
这篇文章就是介绍如何解决上述中提出的问题。
APK Flavor定制开发
要想进行APK的定制开发,必须要了解flavorDimensions
,flavorDimensions
定义了app中的维度数量。
单个纬度
大部分场景中我们只需要定义一个维度就OK了。
例如,app需要提供给不同地方的客户,那我们定义一个名称为city
的纬度,里面包含(sz
,gz
,dl
)
flavorDimensions "city"
productFlavors {
sz {
// 定义的flavor 可以设置自己的包名等差异话信息
applicationId 'com.demo.sz'
dimension "city"
versionCode 1002000
versionName "1.2.0"
// 一些自定义的参数
buildConfigField "String", "CUSTOM_DATA", (""demo_debug"")
}
gz {
applicationId 'com.demo.gz'
dimension "city"
}
dl {
applicationId 'com.demo.dl'
dimension "city"
}
}
这样我们构建apk Active Build Variant
就有6中选择。 flavor * 2 (Debug/Release)= 6
多个纬度
一些特殊场景需要需要分类多个纬度,应该如何定义呢
例如,app需要提供给不同地方的客户,那我们定义一个名称为city
的纬度,里面包含(sz
,gz
,dl
)
同时还定义另外一个颜色的纬度color
的纬度,里面包含(blue
,red
)
flavorDimensions "city"
productFlavors {
sz {
// 定义的flavor 可以设置自己的包名等差异话信息
applicationId 'com.demo.sz'
dimension "city"
versionCode 1002000
versionName "1.2.0"
// 一些自定义的参数
buildConfigField "String", "CUSTOM_DATA", (""demo_debug"")
}
gz {
applicationId 'com.demo.gz'
dimension "city"
}
dl {
applicationId 'com.demo.dl'
dimension "city"
}
blue {
applicationId 'com.color.blue'
dimension "color"
}
red {
applicationId 'com.color.red'
dimension "color"
}
}
这样我们构建apk Active Build Variant
就有12中选择。 city的数量 * color的数量 * 2 (Debug/Release) = 12
APK多环境开发
Studio工程中,默认有Debug/Release 两种环境,在部分场景中,可能两种环境并不能满足我们的开发需求。 向app上线连接生成环境,开发使用开发环境,测试使用测试环境,我们想同时在手机种安装这3个环境的app应该如何扩展呢?
代码语言:javascript复制buildTypes {
// debug 开发环境
debug {
signingConfig signingConfigs.debug
// application的后缀,用来区分包名
applicationIdSuffix = ".debug"
}
// 正式环境
release {
//支持混淆
minifyEnabled true
//zipalign优化
zipAlignEnabled true
//资源压缩,删除无用资源
shrinkResources true
signingConfig signingConfigs.release
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
// 给测试的测试环境
test {
initWith buildTypes.release
applicationIdSuffix = ".test"
// 自定义参数,这里的参数对所有Flavor生效
manifestPlaceholders = [TencentMapSDk: "P7QBZ-323KV-DPNPQ-U6NXW-KFSQE-RDFIL"]
}
}
过滤APK
在定制不同的Flavor 和 BuildTypes 时, 总是会组合出很多其实我们不需要的APK类型,通过下面的方式可以过滤调那些我们不需要的APK,这样看起来也会清爽很多。
代码语言:javascript复制android {
compileSdkVersion parent.ext.compileSdkVersion
variantFilter { variant ->
def flavorName = variant.flavors*.name
def buildType = variant.buildType.name
if (flavorName.contains("blue") && (buildType == "test")) {
setIgnore(true)
println "ignore variant: ${variant.name}"
}
}
}
APK构建自定义操作
- 工程目录下新建一个
customization.gradle
文件
//自定义构建的劫持操作(project.afterEvaluate 模块配置结束回调)
project.afterEvaluate {
android.applicationVariants.all { variant ->
// 在这里可以进行一些自定义操作
replaceSrcFile(variant)
replaceBuildConfigField(variant)
}
}
// 这里根据包名自动替换 WXEntryActivity 的文件
//替换src文件,并修改AndroidManifest 对应的activity描述
def replaceSrcFile(variant) {
def name = variant.name.capitalize()
def replaceSrcTaskName = "replace${name}SrcFile"
tasks["pre${name}Build"].dependsOn replaceSrcTaskName
task(replaceSrcTaskName) {
group "customization"
doLast {
println "[replaceSrcFile]start"
def favorName = "${variant.productFlavors[0].name}"
def currentApplicationId = [variant.mergedFlavor.applicationId, variant.buildType.applicationIdSuffix].findAll().join()
println "[replaceSrcFile]applicationId: ${currentApplicationId}"
def currentFavorApplicationDir = currentApplicationId.replace(".", "/")
println 'currentApplicationId:' currentApplicationId ', currentFavorApplicationDir:' currentFavorApplicationDir
def favorDirName = favorName
if (favorDirName == "app") {
favorDirName = "main"
}
File rootDir = new File(rootDir.getAbsolutePath()) // 工程根目录
File src = new File(rootDir.getAbsolutePath() "/app/src/main/java/com/****/wxapi/WXEntryActivity.kt")
def toFilePath = rootDir.getAbsolutePath() "/app/src/$favorDirName/java/$currentFavorApplicationDir/wxapi/"
File dst = new File(toFilePath)
// 替换 package 包名
def replaceKey = "package"
def newPackage = "package ${currentApplicationId}.wxapi"
copy {
from src
into dst
// 使用闭合来修改文件内容
filter { String line ->
line.startsWith(replaceKey) ? newPackage : line
}
}
// 修改AndroidManifest 对应的activity描述
def manifestFile = rootDir.getAbsolutePath() "/app/src/main/AndroidManifest.xml" //AndroidManifest.xml的位置
def regex = "android.\S*?.wxapi.WXEntryActivity"
def updatedContent = new File(manifestFile).getText('UTF-8').replaceAll(regex, "android:name="${variant.applicationId}.wxapi.WXEntryActivity")
new File(manifestFile).write(updatedContent, 'UTF-8')
}
}
}
// 设置不同apk中的参数
def replaceBuildConfigField(variant) {
def name = variant.name.capitalize()
def replaceBuildConfigFieldTaskName = "replace${name}BuildConfigField"
tasks["pre${name}Build"].dependsOn replaceBuildConfigFieldTaskName
task(replaceBuildConfigFieldTaskName) {
group "customization"
doFirst {
println "[replaceBuildConfigFieldTaskName] start"
def favorName = "${variant.productFlavors[0].name}"
if (favorName == "sz") {
// 这里不需要修改,使用默认值就可以
println "favorName is sz, use default."
return
}
println "[replaceBuildConfigFieldTaskName] ariantName: ${name}"
if (name == "GzRelease" || name == "DlPreRelease"){
variant.buildConfigField "String", "SERVER_ADDRESS", ""****:443""
variant.buildConfigField "String", "SERVER_PROXY", ""******:8443""
}
}
}
}
- app目录中
build.gradle
文件中添加customization.gradle
文件的引用
apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply from: "${rootDir}/customization.gradle"
这样两步就可以完成。