第七章 创建任务和插件：插件相关

第七章 创建任务和插件：插件相关

一、Hook 到 Android 插件

在开发 Android 时，我们希望大部分 tasks 都能设计到 Android 创建。通过 hook 到构建进程来增加任务的行为是可行的。 hook：链接

Hook 到 Android 插件的方式之一是 操控构建 variant ，下面代码可以遍历应用的所有构建variant：

//applicationVariants 对象得到的就是 构建variant 的集合
// all 来遍历
// libraryVariants 对象得到的就是 Android依赖库的集合
android.applicationVarians.all { variant ->
    //do what u want 
}

注： each() 会在构建variant 被 Android插件 创建之前的评测阶段被触发，all() 方法会在每次添加新项目到集合时被触发。

1. 自动重命名 APK

一个常用案例是操纵构建过程来重命名 APKs，在它们被打包之后，添加版本号。原理是通过遍历应用的 构建variant 来改变它们的输出属性 outputFileName：

buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }

        debug {

        }
    }

    productFlavors {
        flavorDimensions 'area'

        inland {

        }

        overseas {

        }

    }

    android.applicationVariants.all { variant ->
        variant.outputs.all {
            outputFileName = "app-${variant.buildType.name}-${variant.productFlavors[0].name}-${variant.versionName}.apk"
        }
    }

执行：gradlew assemble 后

image

每个 构建variant 都有输出集合，Android应用的唯一输出就是 APK。

结合 Android 插件创建钩子的威力，以及 Gradle 任务的简易性，使得我们可以做很多自定义的事情。

2. 动态创建新的任务

注：这个实例我没有运行通过，卡在了执行adb命令上

由于 Gradle 的工作方式和任务的构造方式，我们可以基于 Android构建variant 在配置阶段创建自定义任务。
install 是 Android 创建的一部分，但如果通过命令行界面执行 installDebug 任务来安装 APP，那么在安装完成时，我们仍然需要手动点击 图标开启应用，下面我们创建一个新的，可以在任何构建variant上运行的任务，来省去最后一步：

 android.applicationVariants.all { variant ->
        //检查是否是一个有效的 install 任务
        if (variant.install) {
            // 存在 install task
            //创建一个新的任务，该任务依赖 install()
            tasks.create(name: "run${variant.name.capitalize()}", dependsOn: variant.install) {
                //description 在命令行中输出信息（类似log）
                description "Installs the ${variant.description} and runs the main launcher activity"
            }
        }
    }

任务创建好了，还需要添加实际的动作，此处我们希望启动应用，使用 ADB 在一个已连接的设备上启动一个应用：$ adb shell am start -n com.package.name/com.package.name.Activity
Gradle 有一个 exec() 方法，此方法可以执行一个命令行过程：

//在 description 下面添加即可

                doFirst {
                    def classpath = variant.applicationId
                    if (variant.buildType.applicationIdSuffix) {
                        classpath -= "${variant.buildType.applicationIdSuffix}"
                    }

                    def launchClass = "${classpath}.MainActivity"
                    exec {
                        //提供一个可执行的命令
                        executable = 'adb'
                        //使用 args 传递所有的参数
                        //variant.applicationId: 获得完整的包名（存在的问题：包名可能含有在buildTypes中设置的后缀，所以需要去掉后缀）
                        args = ['shell', 'am', 'start', '-n', launchClass]
                    }
                }

连接设备后，运行：runInlandDebug

所以到底什么是 hook 呢？

二、创建自己的插件

如果你想在多个项目中复用一系列 Gradle Task ，那么提取这些 tasks 到一个自定义插件中将便于复用。
插件既可以使用 Groovy 编写，也可以使用其他 JVM 语言编写。

1. 创建一个简单的插件

新建项目，在 app/build.gradle 文件内创建一个插件，来提取已存储在构建配置文件中的构建逻辑。

class RunPlugin implements Plugin {

    /**
     * Gradle 在插件被构建文件使用时会调用此方法
     * 构建文件正在构建的 project 会被传入到 apply 方法中
     * 这样就可以在 apply 中配置project或使用它的方法或属性了
     * @param target The target object 正在构建的 project
     */
    @Override
    void apply(Project target) {
        //target是当前正在构建的项目
        //target.android是被注入到当前项目的android插件
        //所以此处要使用这个android插件，就要保证在 RunPlugin 被注入前注入 android插件
        //所以在 app/build.gradle 中加入插件时需要在 android 插件后添加
        target.android.applicationVariants.all { variant ->

            if(variant.install){
                target.tasks.create(name:"run${variant.name.capitalize()}",dependsOn: variant.install){
                    //动作
                    println("自定义插件类RunPlugin的任务run${variant.name.capitalize()}执行了")
                }
            }

        }
    }
}

image

image

注： 此处发现问题，输出是在 配置阶段完成的，而不是在 install 后才执行，这是因为没有加 doFirst() 或 << 导致动作在配置阶段执行，如下修改即可：

    doFirst {
        //动作
        println("自定义插件类RunPlugin的任务run${variant.name.capitalize()}执行了")
    }

image

2. 分发插件

• 为了分发插件，需要把它移到一个独立的模块（或项目中）。
• 一个独立的插件有其自己的构建文件来配置依赖关系和分发方式。
• 这个模块会产生一个包含插件类和属性的 JAR 文件，这样就可以在多个模块或项目中使用此 JAR 文件了。