原生移动开发 / 系统课时

用 Product Flavors 管理渠道

用 Product Flavors 管理渠道

当不同应用市场不只需要一个渠道字符串,而是还要切换资源、依赖或配置时,继续堆构建参数会很快失控。Product Flavors 可以把“渠道”建模成正式的构建维度,并与 debug、release 等 Build Type 组合成可重复生成的变体。

学习目标

  • 能创建渠道 Flavor,并理解 Flavor 与 Build Type 的组合关系。
  • 能为不同渠道设置常量、资源和专属依赖。
  • 能构建指定渠道的 Release 产物,并避免误改应用身份。

Flavor 与 Build Type 分工

Build Type 通常描述“怎么构建”,例如调试包是否可调试、Release 是否启用签名和优化;Product Flavor 描述“构建哪一种产品配置”,例如 Huawei、Xiaomi 渠道。

假设只有一个 channel 维度,包含 huawei、xiaomi 两个 Flavor,并保留 debug、release 两个 Build Type,Gradle 会组合出四个主要变体:

Product Flavor Build Type Variant
huawei debug huaweiDebug
huawei release huaweiRelease
xiaomi debug xiaomiDebug
xiaomi release xiaomiRelease

因此渠道配置不需要复制一套 Debug 和 Release;Flavor 负责渠道差异,Build Type 继续负责构建模式。

定义渠道 Flavor

以下为 app/build.gradle.kts 片段示例,假设项目已有正常的 Android Application 配置。这里把渠道同时生成到 BuildConfig,便于运行时代码读取。

kotlin
android {
    buildFeatures {
        buildConfig = true
    }

    flavorDimensions += "channel"

    productFlavors {
        create("huawei") {
            dimension = "channel"
            buildConfigField("String", "CHANNEL", "\"huawei\"")
            resValue("string", "channel_name", "Huawei")
        }

        create("xiaomi") {
            dimension = "channel"
            buildConfigField("String", "CHANNEL", "\"xiaomi\"")
            resValue("string", "channel_name", "Xiaomi")
        }
    }
}

应用代码可以统一读取 BuildConfig.CHANNEL,界面资源可以统一引用 @string/channel_name,不需要在业务代码里判断当前正在编译哪个 Flavor。

如果渠道需要替换图标、布局或 XML 配置,可把覆盖资源放在 src/huawei/res/、src/xiaomi/res/;对应 Flavor 构建时会与 src/main/res/ 合并,同名资源由更具体的渠道资源覆盖。

管理渠道专属依赖

Flavor 创建后,也会产生对应的依赖配置。下面是片段示例,前提是项目中真实存在 :channel-huawei 与 :channel-xiaomi 两个本地模块。

kotlin
dependencies {
    add("huaweiImplementation", project(":channel-huawei"))
    add("xiaomiImplementation", project(":channel-xiaomi"))
}

这样 Huawei 变体不会把 Xiaomi 专属模块打进去,反之亦然。通用网络库、数据库库等仍应放在普通 implementation,不要为了“渠道化”而复制所有依赖声明。

构建指定渠道的 Release

Variant 名会映射成对应 Gradle 任务。构建 Huawei Release APK 可以执行:

bash
./gradlew :app:assembleHuaweiRelease

预期输出:

text
BUILD SUCCESSFUL in <TIME>

实际耗时会不同。需要 Xiaomi Release 时,任务名相应变为 assembleXiaomiRelease。如果发布流程产出 AAB,则使用对应 Variant 的 bundle... 任务,例如 bundleHuaweiRelease。

构建后还应在安装或自动化测试中读取一次 BuildConfig.CHANNEL,确认产物与目标市场一致,避免只根据文件名判断渠道。

不要把渠道误做成不同应用

为 Flavor 设置 applicationIdSuffix 会改变最终 Application ID。只有确实要把不同渠道作为彼此独立的应用安装和发布时才应这样做;同一个应用只是分发到不同市场时,通常应保持一致的 Application ID,并用渠道字段区分来源。

当渠道数量继续增加时,优先保证维度语义单一,例如 channel 只描述市场,不要同时混入 dev、staging、prod 环境概念。否则 Flavor 与 Build Type 的组合会迅速膨胀,构建、测试和发布矩阵都会变得难以维护。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 Product Flavors 管理渠道

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通