基于 App Variant (BuildType + Flavor) 构建配置

Question

我正在尝试为应用程序变体设置 signingConfig、manifestPlaceholders、buildConfigField。我可以为每个 buildType or! productFlavor 独立设置它们，但我需要的是根据 productFlavor and! buildType.

buildTypes{
  getByName("debug"){}
  getByName("release"){}
  create("staging"){}
}

productFlavors {
  create("global"){}
  create("local"){}
}

在上面的示例中，有 3 种不同的 buildType 和 2 种不同的 productFlavors。这意味着总共有 6 个 APK 变体。例如，对于每个 APK（globalRelease、globalStaging、globalDebug、localRelease、localStaging、localDebug），我想使用不同的 signingConfig。怎么设置？

尝试过：

如果我在 buildType 中设置它，那么将只有 3 个不同的 signingConfigs
如果我将它设置为 flavor，那么将只有 2 个不同的 signingConfigs
如果我尝试在 applicationVariants.all{} 中设置它，则没有 setter 函数，只有 Variant 对象上的吸气剂 (link)
(variant.mergedFlavor as DefaultProductFlavor) 上的设置字段不会将 buildConfigField 值添加到 BuildConfig.java ()

Answer 1

在Gradle之后7.x

而不是 applicationVariants.all{}，we now use androidComponents { onVariants{ .. }} 在 android{} 块之外。此代码应适用于 Gradle 7.0.2 和 AGP 7.0.1:

androidComponents {
    onVariants { variant ->
        variant.buildConfigFields.put("MY_CUSTOM_FIELD", BuildConfigField("String", "MyCustomValue", null))
        variant.manifestPlaceholders.put("MY_MANIFEST_FIELD", "MyManifestValue")
    }
}

在 AGP 7.0.x 上，is no way to set signingConfig mergedFlavor (buildType+flavor)。您可以单独设置 buildType 或 flavor，但不能设置组合。

在 AGP 7.1.x 上，您可以做到。但它需要 AGP 7.1.0-alpha10, Gradle 7.2-rc-3, AndroidStudio BumbleBee 2021.1.1 alpha10:

androidComponents {
    onVariants { variant ->
        variant.signingConfig?.setConfig(android.signingConfigs.getByName("buildTypeXFlavorA"))
    }
}

之前 Gradle 7.x

要对不同的变体 (buildType+productFlavor) 进行更改，我必须使用 android.applicationVariants.all{}。但是不同的路径用来实现多个signingConfig、manifestPlaceholders、buildConfigField

1) 清单占位符

applicationVariants.all{
    val variant = this
}

variant 对象上的 manifestPlaceholders 没有 getter/setter。在之后，我们可以使 variant.mergedFlavor 可变。在 variant.mergedFlavor 上设置 manifestPlaceholders 确实有效。

import com.android.builder.core.DefaultProductFlavor

applicationVariants.all{
    val manifestPlaceholders: Map<String, String>
    val variant = this
    val mutableMergedFlavor = variant.mergedFlavor as DefaultProductFlavor
    mutableMergedFlavor.addManifestPlaceholders(manifestPlaceholders)
}

2) buildConfigField

使用相同的方法，在 mutableMergedFlavor 上调用 addBuildConfigField(ClassFieldImpl(type, name, value)) 无效。但是，可以直接在variant.

上设置

import com.android.builder.internal.ClassFieldImpl

applicationVariants.all{
    val buildConfigFields: List<ClassFieldImpl>
    val variant = this
    buildConfigFields.forEach { 
        variant.buildConfigField(it.type, it.name, it.value) 
    }
}

3) signingConfig signingConfig 可以在上面显示的 mutableMergedFlavor 上设置，debug 变体除外。所有 debug 变体都使用默认签名选项，即使您在 variant.mergedFlavor 上设置它也是如此。但是，如果您将 default 设置为 null，那么您也可以覆盖它。

import com.android.builder.core.DefaultProductFlavor

signingConfigs {
    create("myDebug") {}
}
buildTypes {
    getByName("debug") {
        signingConfig = null // to override
    }
}
applicationVariants.all{
    val variant = this
    val mutableMergedFlavor = variant.mergedFlavor as DefaultProductFlavor
    mutableMergedFlavor.signingConfig = signingConfigs.getByName("myDebug")
}

总和：

import com.android.build.gradle.api.ApplicationVariant
import com.android.builder.internal.ClassFieldImpl
import com.android.builder.model.SigningConfig
import com.android.builder.core.DefaultProductFlavor
import java.util.*

fun configureVariant(variant: ApplicationVariant,
                     signingConfig: SigningConfig,
                     buildConfigFields: List<ClassFieldImpl>,
                     manifestPlaceholders: Map<String, String>) {

    println("configureVariant: ${variant.name}")
    buildConfigFields.forEach {
        variant.buildConfigField(it.type, it.name, it.value)
    }

    val mutableMergedFlavor = variant.mergedFlavor as DefaultProductFlavor
    mutableMergedFlavor.signingConfig = signingConfig
    mutableMergedFlavor.addManifestPlaceholders(manifestPlaceholders)
}

android {
    signingConfigs {
        create("myDebug") {}
        create("myRelease") {}
    }

    flavorDimensions("region")
    productFlavors {
        create("global") {
            setDimension("region")
            setApplicationId("")
        }
        create("local") {
            setDimension("region")
            setApplicationId("")
        }
    }

    buildTypes {
        getByName("debug") {
            signingConfig = null
        }
    }

    applicationVariants.all {
        val variant = this
        when {
            variant.name.equals("localDebug", true) -> {
                configureVariant(
                        variant,
                        signingConfigs.getByName("localDebug"),
                        listOf(ClassFieldImpl("String", "NAME", "\"VALUE\"")),
                        mapOf("KEY" to "VALUE")
                )
            }
            variant.name.equals("globalStaging", true) -> {
                configureVariant(
                        variant,
                        signingConfigs.getByName("globalStaging"),
                        listOf(ClassFieldImpl("String", "NAME", "\"VALUE2\"")),
                        mapOf("KEY" to "VALUE2")
                )
            }
        }
    }
}

基于 App Variant (BuildType + Flavor) 构建配置

Build Configurations based on App Variant (BuildType + Flavor)

android

gradle

kotlin

gradle-kotlin-dsl

在Gradle之后7.x

之前 Gradle 7.x