android gradle 自定义task app编译重命名

Android Gradle 自定义 Task 进行应用编译重命名

在 Android 项目的构建过程中，有时我们需要对 APK 文件进行一些自定义的操作，例如在构建时对 APK 名称进行重命名。借助 Gradle 的自定义 Task 功能，我们可以很容易地实现这一点。本文将详细介绍如何实现这一功能，并分步带领你完成整个流程。

整体流程

为你创建一个 APK 重命名的流程图，我们可以将整个过程概括为以下几个步骤：

flowchart TD
    A[创建自定义 Task] --> B[获取 APK 文件路径]
    B --> C[修改 APK 名称]
    C --> D[完成构建过程]

下表展示了每一步的具体内容：

步骤详解

1. 创建自定义 Task

在 app/build.gradle 文件中，我们需要定义一个自定义 Task。这将是我们执行重命名操作的地方。

// app/build.gradle
task renameApk(type: Copy) {
    // 本 task 继承自 Copy 类型，用于进行文件复制操作
    doLast {
        // [](1) 表示最后执行的部分
        // 获取应用的输出目录
        def outputDir = getOutputDirectory()
        
        // 获取 APK 文件路径
        def apkFile = file("$outputDir/${project.name}.apk")
        
        // 目标文件名，可以根据需要自定义
        def newApkName = "${project.name}_v${android.defaultConfig.versionName}.apk"
        
        // 重命名文件
        if (apkFile.exists()) {
            // [](2) 检查 APK 文件是否存在
            apkFile.renameTo(file("$outputDir/$newApkName"))
        }
    }
}

代码注释：

• task renameApk(type: Copy): 创建一个名为 renameApk 的任务，并指定其类型为 Copy。
• doLast { ... }: 定义任务完成后要执行的代码块。
• def outputDir = getOutputDirectory(): 获取输出目录，通常为 build/outputs/apk。
• def apkFile = file("$outputDir/${project.name}.apk"): 获取默认生成的 APK 文件路径。
• def newApkName = "${project.name}_v${android.defaultConfig.versionName}.apk": 根据项目名称和版本名称生成新文件名。
• apkFile.renameTo(file("$outputDir/$newApkName")): 将 APK 文件重命名为新的文件名。

2. 获取 APK 文件路径

此步骤已经在上面的代码中完成，我们利用 Gradle API 获取了 APK 的路径。

3. 修改 APK 名称

在步骤 1 中的 doLast 代码块中，我们已经实现了 APK 名称的修改。

4. 完成构建过程

为了确保在构建后执行自定义 Task，我们需要将其与构建过程关联。在同一文件中，我们可以通过以下方式实现：

// app/build.gradle
preBuild.dependsOn renameApk

代码注释：

• preBuild.dependsOn renameApk: 将 renameApk 任务设为 preBuild 任务的依赖项，这样在每次构建时都会执行重命名操作。

结束语

通过以上步骤，我们成功地创建了一个自定义的 Gradle Task 来实现 APK 文件的重命名。这个流程让我们能够根据项目需求自定义构建过程，为后续的 CI/CD 集成或版本发布提供了更大的灵活性。

希望这篇文章能够帮助你更好地理解 Gradle 的自定义 Task，并在日常开发中灵活运用。将来的开发过程中，你可以进一步探索更多 Gradle 的功能，以便更好地满足项目需求。