如何在gradle.properties中获取当前Build Variant并自动切换依赖模块？

问题背景 #

当前通过手动修改gradle.properties中的flavor变量，在settings.gradle中判断引入host或pos模块，但每次切换Build Variant都需要手动修改变量，希望实现自动化，且在Gradle同步阶段完成判断。

解决方案 #

核心思路是读取Android Studio存储当前选中Build Variant的配置文件，在settings.gradle中自动解析并判断引入对应模块，无需手动修改配置。

1. 完整的settings.gradle配置

替换原有的判断逻辑，添加以下代码：

// 从Android Studio的workspace.xml中读取当前选中的Build Variant
def getSelectedVariantFromAS() {
    def workspaceFile = rootProject.file(".idea/workspace.xml")
    if (!workspaceFile.exists()) {
        return "pos" // 提供默认值，适配命令行或首次打开项目场景
    }

    def xmlSlurper = new XmlSlurper()
    xmlSlurper.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false)
    def workspaceXml = xmlSlurper.parse(workspaceFile)

    // 定位到存储选中Variant的节点
    def selectedVariantNode = workspaceXml.component
        .find { it.@name == "ProjectPreferences" }
        ?.option
        ?.find { it.@name == "SELECTED_VARIANT" }

    return selectedVariantNode ? selectedVariantNode.@value.toString() : "pos"
}

// 优先读取命令行传入的flavor参数，其次读取AS选中的Variant
def currentFlavor = providers.systemProperty("flavor").orElseGet {
    def selectedVariant = getSelectedVariantFromAS()
    // 拆分Variant名称中的flavor部分（假设Variant格式为[flavor][BuildType]，如posDebug、hostRelease）
    selectedVariant.split(/(?=[A-Z])/)[0].toLowerCase()
}

// 根据flavor动态引入模块
if (currentFlavor == "host") {
    include ':host'
} else if (currentFlavor == "pos") {
    include ':pos'
}

2. 关键细节说明

• 读取AS配置文件：Android Studio会将当前选中的Build Variant存储在.idea/workspace.xml的ProjectPreferences节点下，通过XmlSlurper解析该文件获取Variant名称。
• 兼容命令行场景：通过providers.systemProperty("flavor")支持命令行指定flavor（如./gradlew sync -Pflavor=host），避免仅依赖AS配置文件的局限性。
• Variant名称拆分：假设你的Variant命名格式为flavor+BuildType（如posDebug、hostRelease），通过正则拆分出flavor部分；如果你的命名规则不同，可调整拆分逻辑。

3. 替代方案（可选）

如果不想依赖.idea/workspace.xml，可以通过自定义Gradle任务自动同步gradle.properties中的flavor值：

1. 在app模块的build.gradle中添加任务：

task syncFlavorToProperties {
    doLast {
        def selectedVariant = android.defaultConfig.flavorName
        def propertiesFile = rootProject.file("gradle.properties")
        def properties = new Properties()
        properties.load(new FileInputStream(propertiesFile))
        properties.setProperty("flavor", selectedVariant)
        properties.store(new FileOutputStream(propertiesFile), "Automatically synced flavor from Build Variant")
    }
}

// 绑定到同步任务
tasks.named('sync').configure {
    finalizedBy(syncFlavorToProperties)
}

但此方案的局限性在于，任务执行在同步之后，首次同步时可能无法生效，需要额外执行一次任务，因此优先推荐第一种方案。

注意事项 #

• .idea/workspace.xml是AS生成的本地配置文件，通常不会提交到版本控制，所以团队协作时每个开发者的本地文件都会独立维护自己的选中Variant。
• 如果你的项目使用多flavor维度，需要调整getSelectedVariantFromAS中的拆分逻辑，适配你的Variant命名规则。

内容的提问来源于stack exchange，提问作者jane