通过在 Build 脚本中创建一个简单的任务，学习编写 Gradle 任务的基础知识。

在本节中，您将

  • 理解任务

  • 为插件创建自定义任务

步骤 0. 开始之前

  1. 您在第 1 部分中初始化了 Java 应用程序。

  2. 您从第 2 部分理解了 Gradle 构建生命周期。

  3. 您在第 3 部分中添加了一个子项目和一个单独的 Build。

  4. 您在第 4 部分中查看了一个 Settings 文件。

  5. 您在第 5 部分中编写了一个 Build 脚本。

步骤 1. 理解任务

任务是包含一系列操作的可执行代码片段。

操作通过 doFirst{} 和 doLast{} 闭包添加到任务中。

一个任务可以依赖于其他任务。

步骤 2. 注册和配置任务

在本教程的早期，我们在 app 构建脚本中注册并配置了 task1

app/build.gradle.kts
tasks.register("task1"){  (1)
    println("REGISTER TASK1: This is executed during the configuration phase")
}

tasks.named("task1"){  (2)
    println("NAMED TASK1: This is executed during the configuration phase")
    doFirst {
        println("NAMED TASK1 - doFirst: This is executed during the execution phase")
    }
    doLast {
        println("NAMED TASK1 - doLast: This is executed during the execution phase")
    }
}
1 您可以使用 register() 方法创建新任务。
2 您可以使用 named() 方法配置现有任务。
app/build.gradle
tasks.register("task1") {  (1)
    println("REGISTER TASK1: This is executed during the configuration phase")
}

tasks.named("task1") {  (2)
    println("NAMED TASK1: This is executed during the configuration phase")
    doFirst {
        println("NAMED TASK1 - doFirst: This is executed during the execution phase")
    }
    doLast {
        println("NAMED TASK1 - doLast: This is executed during the execution phase")
    }
}
1 您可以使用 register() 方法创建新任务。
2 您可以使用 named() 方法配置现有任务。

步骤 3. 创建自定义任务

要创建自定义任务，您必须在 Groovy DSL 中继承 DefaultTask 或在 Kotlin DSL 中继承 DefaultTask。

创建一个名为 LicenseTask 的自定义类，并将以下代码添加到 gradle/license-plugin/plugin/src/main/kotlin/license/LicensePlugin.kt 或 gradle/license-plugin/plugin/src/main/groovy/license/LicensePlugin.groovy 文件的底部

gradle/license-plugin/plugin/src/main/kotlin/license/LicensePlugin.kt
import org.gradle.api.Project
import org.gradle.api.Plugin
import org.gradle.api.DefaultTask
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.TaskAction
import java.io.File
import java.io.InputStream
import java.nio.charset.Charset

class LicensePlugin: Plugin<Project> {
    // Don't change anything here
}

abstract class LicenseTask : DefaultTask() {
    @Input
    val licenseFilePath = project.layout.settingsDirectory.file("license.txt").asFile.path

    @TaskAction
    fun action() {
        // Read the license text
        val licenseText = File(licenseFilePath).readText()
        // Walk the directories looking for java files
        project.layout.settingsDirectory.asFile.walk().forEach {
            if (it.extension == "java") {
                // Read the source code
                var ins: InputStream = it.inputStream()
                var content = ins.readBytes().toString(Charset.defaultCharset())
                // Write the license and the source code to the file
                it.writeText(licenseText + content)
            }
        }
    }
}
gradle/license-plugin/plugin/src/main/groovy/license/LicensePlugin.groovy
import org.gradle.api.Project
import org.gradle.api.Plugin
import org.gradle.api.DefaultTask
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.TaskAction

class LicensePlugin implements Plugin<Project> {
    // Don't change anything here
}

abstract class LicenseTask extends DefaultTask {
    @Input
    def licenseFilePath = project.layout.settingsDirectory.file("license.txt").asFile.path

    @TaskAction
    void action() {
        // Read the license text
        def licenseText = new File(licenseFilePath).text
        // Walk the directories looking for java files
        project.layout.settingsDirectory.asFile.eachFileRecurse { file ->
            int lastIndexOf = file.getName().lastIndexOf('.')
            if ((lastIndexOf != -1) && (file.getName().substring(lastIndexOf)) == ".java") {// Read the source code
                def content = file.getText()
                //println(licenseText + '\n' + content)
                // Write the license and the source code to the file
                file.text = licenseText + '\n' + content
            }
        }
    }
}

LicenseTask 类封装了任务操作逻辑，并声明了任务期望的任何输入和输出。

任务操作使用 @TaskAction 注解。在内部，逻辑首先查找名为 "license.txt" 的文件。该文件包含 Apache 许可证的文本

license.txt
/*
* Licensed under the Apache License
*/

然后，该任务查找扩展名为 .java 的文件，并添加许可证头。

该任务有一个输入，即许可证文件名，使用 @Input 注解。

Gradle 使用 @Input 注解来确定任务是否需要运行。如果任务之前未运行，或者自上次执行以来输入值已更改，则 Gradle 将执行该任务。

虽然已创建自定义类，但尚未将其添加到 LicensePlugin。当前无法运行 LicenseTask。

您现在可以做的只是确保 ./gradlew build 运行时不失败

$ ./gradlew build

SETTINGS FILE: This is executed during the initialization phase

> Configure project :app
BUILD SCRIPT: This is executed during the configuration phase

BUILD SUCCESSFUL in 1s
13 actionable tasks: 6 executed, 7 up-to-date

下一步： 编写插件 >>