原生移动开发 / 系统课时

按渠道切换 SDK 配置

按渠道切换 SDK 配置

同一应用投放到不同市场时,推送、统计、登录 SDK 往往需要不同的应用标识或渠道值。最稳妥的做法不是发包前手改文件,而是让 Gradle 根据 Product Flavor 自动注入配置,使每个 Release 变体都能重复构建和验证。

学习目标

  • 用 Product Flavor 把市场差异收敛到构建配置中
  • 通过 Manifest Placeholder 和资源值向应用传入渠道参数
  • 区分可随包分发的标识与不应进入客户端的敏感凭据

把渠道差异留在构建层

假设应用要发布到 Google 与 Huawei 两个市场。业务代码应尽量保持一份,渠道只决定“构建时选哪组参数”。Gradle 创建 googleRelease、huaweiRelease 等变体后,再把对应值写入合并后的 Manifest 或生成资源,运行时 SDK 只消费当前变体已经确定的配置。

按渠道注入 SDK 配置的构建关系

这种方式的关键是一处声明、按变体选择。新增市场时增加一个 Flavor,而不是复制一套工程;切换渠道也由任务名决定,而不是由开发者记住“发包前该改哪几个文件”。

用 Product Flavor 注入参数

下面是 app/build.gradle.kts 的片段示例,依赖已有 Android Application 模块。示例把推送应用标识写入 Manifest Placeholder,把统计渠道和登录客户端 ID 写成字符串资源;这些名称都是应用自己的配置入口,不冒充任何厂商 SDK 的参数名。

kotlin
android {
    flavorDimensions += "market"

    productFlavors {
        create("google") {
            dimension = "market"
            manifestPlaceholders["pushAppId"] =
                providers.gradleProperty("pushAppIdGoogle").orNull ?: ""
            resValue("string", "analytics_channel", "google")
            resValue(
                "string",
                "login_client_id",
                providers.gradleProperty("loginClientIdGoogle").orNull ?: ""
            )
        }

        create("huawei") {
            dimension = "market"
            manifestPlaceholders["pushAppId"] =
                providers.gradleProperty("pushAppIdHuawei").orNull ?: ""
            resValue("string", "analytics_channel", "huawei")
            resValue(
                "string",
                "login_client_id",
                providers.gradleProperty("loginClientIdHuawei").orNull ?: ""
            )
        }
    }
}

pushAppIdGoogle、pushAppIdHuawei 等值不必写死在仓库脚本里。开发机可以放在用户级 ~/.gradle/gradle.properties,CI 则通过受保护变量注入同名 Gradle Property。这样构建逻辑保持稳定,换渠道时不需要修改源码。

Manifest 也只保留一个模板。下面是片段示例,依赖已有 <application>;com.example.app.PUSH_APP_ID 是应用自定义的元数据键,真正调用某个 SDK 时再由适配层读取并传给厂商初始化 API。

xml
<application>
    <meta-data
        android:name="com.example.app.PUSH_APP_ID"
        android:value="${pushAppId}" />
</application>

统计渠道可以从 R.string.analytics_channel 读取,登录客户端 ID 可以从 R.string.login_client_id 读取。这样推送、统计、登录等 SDK 的“选择哪组配置”由构建变体控制,业务层只面对稳定的应用内配置接口。

管理敏感值的边界

不是所有“SDK 参数”都适合进入 APK。应用 ID、客户端 ID、渠道名通常本来就会随客户端分发;客户端密钥、服务端签名私钥、OAuth client secret 不应因为用了 Flavor 就写进资源、Manifest 或 BuildConfig,因为打包后仍可被提取。

如果某个 SDK 需要 JSON 或 XML 配置文件,优先确认它的官方 Gradle 插件是否支持按变体读取文件;只有文档明确支持时,才把文件放到对应 Source Set。不要假设任意 SDK 都会自动识别 src/<flavor>/ 下的配置文件。

构建并验证两个渠道

在 Release 签名和所需 Gradle Property 已经配置好的前提下,可以直接构建两个变体:

bash
./gradlew :app:assembleGoogleRelease :app:assembleHuaweiRelease

预期输出:

text
BUILD SUCCESSFUL in <TIME>

实际任务明细和耗时会不同。生产项目不应长期使用空字符串作为必填参数的回退值,可以在构建脚本中对关键配置执行非空检查,让缺少渠道参数直接造成构建失败,而不是生成一个“能够安装但 SDK 无法正常工作”的包。

最终应做到:选择 googleRelease 就只能得到 Google 渠道参数,选择 huaweiRelease 就只能得到 Huawei 渠道参数;整个过程不依赖人工改文件,也不会让一次临时修改污染下一个渠道包。

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

目录与阅读设置

阅读设置

17

记录一个想法

按渠道切换 SDK 配置

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

登录哪都通