android studio build.gradle.kts setProperty productFlavors 定制打包的文件名

<think>我们已经在之前的回答中提供了使用Kotlin DSL（build.gradle.kts）为productFlavors自定义APK文件名的解决方案。现在，根据用户的问题，他们希望定制打包文件名，并且引用了站内的一些信息（主要是关于Groovy和Kotlin DSL的配置以及signingConfigs的配置）。但是，用户的核心问题仍然是关于如何设置输出文件名。 在之前的回答中，我们使用了`configure<ApplicationAndroidComponentsExtension>`和`onVariants`回调（适用于AGP 7.0及以上）来设置输出文件名。然而，根据引用[2]的内容，用户似乎还涉及到了多个productFlavors以及签名配置（signingConfigs），但用户当前的问题并没有直接要求签名配置，而是专注于文件名。 因此，我们将重点放在如何设置自定义文件名上，并考虑到可能有多个flavor的情况。 ### 解决方案（更新和补充说明） 在`build.gradle.kts`中，我们可以通过以下步骤设置自定义APK文件名： 1. **定义productFlavors**：在`android`块中定义flavor维度和具体的flavor。 2. **使用新的变体API（AGP 7.0+）**：通过`androidComponents`配置块，在变体被创建后，修改输出文件名。 #### 代码示例 ```kotlin import com.android.build.api.variant.ApplicationAndroidComponentsExtension import java.text.SimpleDateFormat import java.util.* plugins { id("com.android.application") } android { compileSdk = 34 buildToolsVersion = "34.0.0" defaultConfig { applicationId = "com.example.myapp" versionCode = 1 versionName = "1.0.0" } // 定义维度 flavorDimensions += listOf("environment", "tier") // 配置productFlavors productFlavors { create("dev") { dimension = "environment" applicationIdSuffix = ".dev" versionNameSuffix = "-dev" } create("prod") { dimension = "environment" } create("free") { dimension = "tier" versionNameSuffix = "-free" } create("paid") { dimension = "tier" versionNameSuffix = "-paid" } } buildTypes { getByName("debug") { isMinifyEnabled = false } getByName("release") { isMinifyEnabled = true proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro") } } // 配置文件名 configure<ApplicationAndroidComponentsExtension> { onVariants { variant -> // 获取版本名称（合并了flavor和buildType的配置） val versionName = variant.versionName.orNull ?: "unknown" // 获取当前时间戳 val timestamp = SimpleDateFormat("yyyyMMdd_HHmm", Locale.getDefault()).format(Date()) // 获取变体名称（例如：devFreeDebug） val variantName = variant.name // 为每个输出设置文件名（考虑可能有多个输出，例如APK和AAB，但这里我们只处理APK） variant.outputs.forEach { output -> // 只处理APK类型的输出 if (output.outputType.name == "APK") { output.outputFileName.set("app_${variantName}_v${versionName}_${timestamp}.apk") } } } } } ``` ### 关键点说明 1. **文件名格式**：我们使用了以下元素构建文件名： - `app`：固定的前缀。 - `variantName`：变体名称，由flavor和buildType组合而成（例如：devFreeDebug）。 - `versionName`：版本名称，可能包含flavor中配置的后缀（例如：1.0.0-dev-free）。 - `timestamp`：构建时间戳（例如：20240530_1430）。 2. **时间戳格式**：使用`SimpleDateFormat`生成时间戳，格式为`yyyyMMdd_HHmm`，避免使用冒号等特殊字符。 3. **输出类型判断**：我们通过`output.outputType.name`判断输出类型，确保只修改APK文件的文件名（避免影响AAB等输出）。 4. **多flavor维度**：示例中定义了两个维度（environment和tier），并创建了四个flavor。这样会产生多个变体（例如：devFreeDebug、devPaidDebug、prodFreeDebug等）。 5. **签名配置**：虽然用户引用的内容提到了`signingConfigs`，但本问题不涉及签名配置，因此未包含。如果需要，可以在`buildTypes`或`productFlavors`中配置签名，例如： ```kotlin buildTypes { getByName("release") { signingConfig = signingConfigs.getByName("myReleaseConfig") } } ``` ### 注意事项 - **AGP版本兼容性**：上述代码适用于AGP 7.0及以上版本。对于旧版本（AGP 4.x-6.x），需要使用`applicationVariants`API： ```kotlin android { applicationVariants.all { val variant = this val variantName = variant.name val versionName = variant.versionName val timestamp = ... variant.outputs.forEach { output -> output.outputFileName = "app_${variantName}_v${versionName}_${timestamp}.apk" } } } ``` - **文件名唯一性**：使用时间戳可以确保每次构建生成不同的文件名，避免覆盖。但这也意味着每次构建都会产生新文件，可能导致存储空间增加。如果不需要每次构建都生成唯一文件名，可以移除时间戳。 - **特殊字符处理**：如果版本号中包含空格或其他特殊字符，建议替换为安全字符（如下划线）： ```kotlin val safeVersionName = versionName.replace(" ", "_") ``` - **构建缓存**：带时间戳的文件名不会影响构建缓存，但每次构建都会生成新文件。如果希望保留构建缓存同时使用时间戳，可以考虑仅对发布版本（release）添加时间戳。 ### 输出示例 | 变体名称 | 输出文件名示例 | |---------------|-----------------------------------------------| | devFreeDebug | `app_devFreeDebug_v1.0.0-dev-free_202405301430.apk` | | prodPaidRelease | `app_prodPaidRelease_v1.0.0-paid_202405301430.apk` | ### 相关问题 1. 如何在文件名中包含Git提交ID而不是时间戳？ 2. 如何为不同的flavor设置完全不同的文件名规则？ 3. 如何避免时间戳导致每次构建都生成新文件？ 4. 如何配置签名信息（signingConfigs）以使用不同的密钥文件？ 以上问题可以作为用户进一步探索的方向。</think>在 Android Studio 中使用 Kotlin DSL (`build.gradle.kts`) 为 `productFlavors` 自定义 APK 文件名，可通过以下步骤实现： ### 完整解决方案 (`build.gradle.kts`) ```kotlin import com.android.build.api.variant.ApplicationAndroidComponentsExtension import java.text.SimpleDateFormat import java.util.* plugins { id("com.android.application") } android { compileSdk = 34 buildToolsVersion = "34.0.0" defaultConfig { versionName = "1.0.0" versionCode = 1 } // 1. 定义维度 flavorDimensions += "env" // 2. 配置 productFlavors productFlavors { create("dev") { dimension = "env" applicationIdSuffix = ".dev" versionNameSuffix = "-dev" } create("prod") { dimension = "env" applicationIdSuffix = ".prod" versionNameSuffix = "-prod" } create("coexist") { // 引用[2]中的特殊 flavor dimension = "env" applicationIdSuffix = ".coexist" } } // 3. 签名配置 (引用[2]示例) signingConfigs { create("basic") { storeFile = file("./test.keystore") storePassword = "test" keyAlias = "test.keystore" keyPassword = "test" } create("coexist") { storeFile = file("./test_coexist.keystore") storePassword = "test" keyAlias = "test_coexist.keystore" keyPassword = "test" } } // 4. 自定义文件名配置 configure<ApplicationAndroidComponentsExtension> { onVariants { variant -> val timestamp = SimpleDateFormat("yyyyMMdd_HHmm", Locale.getDefault()).format(Date()) val flavorName = variant.flavorName ?: "unknown" val version = variant.versionName ?: "unknown" variant.outputs.forEach { output -> // 5. 根据 flavor 使用不同命名规则 when (flavorName) { "coexist" -> output.outputFileName.set( "app_coexist_${variant.buildType}_v${version}.apk" ) else -> output.outputFileName.set( "app_${flavorName}_${variant.buildType}_v${version}_${timestamp}.apk" ) } } } } } ``` ### 关键配置说明 1. **Flavor 维度配置** 使用 `flavorDimensions` 定义维度，确保不同 flavor 能正确组合： ```kotlin flavorDimensions += "env" // 定义维度名 ``` 2. **特殊 flavor 处理** 针对引用[2]中的 `coexist` flavor，单独配置命名规则（不带时间戳）： ```kotlin when (flavorName) { "coexist" -> output.outputFileName.set("app_coexist_${variant.buildType}_v${version}.apk") else -> ... // 其他 flavor 规则 } ``` 3. **文件名动态元素**： - `flavorName`：获取当前 flavor 名称（如 `dev`, `prod`, `coexist`） - `buildType`：构建类型（`debug`/`release`） - `versionName`：合并后的版本号（含 flavor 后缀） - `timestamp`：构建时间戳（格式 `yyyyMMdd_HHmm`） 4. **签名配置集成** 引用[2]的签名配置直接集成到 `signingConfigs` 块，可在 `buildTypes` 中关联使用： ```kotlin buildTypes { getByName("release") { signingConfig = signingConfigs.getByName("basic") } } ``` ### 输出文件名示例 | Flavor | Build Type | 输出文件名示例 | |-----------|------------|----------------------------------------| | dev | debug | `app_dev_debug_v1.0.0-dev_202405301430.apk` | | prod | release | `app_prod_release_v1.0.0-prod_202405301430.apk` | | coexist | release | `app_coexist_release_v1.0.0.apk` | ### 注意事项 1. **Flavor 命名顺序** 如引用[2]所述，Android Studio 默认选择**字母序首位**的 flavor 作为默认变体。若需修改默认行为： ```kotlin // 在 android 块添加 variantFilter { if (name == "devDebug" && !project.gradle.startParameter.taskNames.any { it.contains("dev") }) { ignore = true } } ``` 2. **时间戳优化** 为避免每次构建都生成新文件，可限制时间戳仅用于 release 版本： ```kotlin val timestamp = if (variant.buildType == "release") SimpleDateFormat(...).format(Date()) else "" ``` 3. **特殊字符处理** 若版本号包含无效字符（如空格），需进行清理： ```kotlin val cleanVersion = version.replace(Regex("[^a-zA-Z0-9.-]"), "_") ``` 4. **AGP 版本兼容** 此配置要求 Android Gradle Plugin ≥ 7.0。旧版本需改用： ```kotlin applicationVariants.all { outputs.forEach { output -> output.outputFileName = ... // 直接赋值 } } ``` --- ### 相关问题 1. 如何为不同 flavor 配置完全独立的签名密钥？[^2] 2. 如何在文件名中包含 Git 提交哈希值而非时间戳？ 3. 如何自动清理超过 30 天的旧 APK 文件？ 4. 如何将自定义命名的 APK 自动上传到 Firebase？ 5. 多模块项目中如何统一所有模块的命名规则？ [^1]: Android 官方构建配置文档 [^2]: Android Studio 多 flavor 打包实践