透過在您的建置腳本中建立一個簡單的 Task，來學習撰寫 Gradle Task 的基礎知識。

在本節中，您將

  • 了解 Task

  • 為外掛程式建立自訂 Task

步驟 0. 開始之前

  1. 您在 第 1 部分 初始化了您的 Java 應用程式。

  2. 您從 第 2 部分 了解了 Gradle 建置生命週期。

  3. 您在 第 3 部分 新增了一個子專案和一個獨立的建置。

  4. 您在 第 4 部分 檢視了一個設定檔。

  5. 您在 第 5 部分 撰寫了一個建置腳本。

步驟 1. 了解 Task

Task 是一個可執行的程式碼片段，其中包含一系列動作。

動作透過 doFirst{} 和 doLast{} 閉包添加到 Task。

Task 可以依賴其他 Task。

步驟 2. 註冊和配置 Task

在本教學課程的早期，我們在 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() 方法來建立新的 Task。
2 您可以使用 named() 方法來配置現有的 Task。
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() 方法來建立新的 Task。
2 您可以使用 named() 方法來配置現有的 Task。

步驟 3. 建立自訂 Task

要建立自訂 Task，您必須在 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 類別封裝了 Task 動作邏輯，並宣告了 Task 預期的任何輸入和輸出。

Task 動作使用 @TaskAction 註解。在內部，邏輯首先找到一個名為 "license.txt" 的檔案。此檔案包含 Apache 授權的文字

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

然後，Task 尋找副檔名為 .java 的檔案並新增授權標頭。

Task 有一個單一輸入，即授權檔案名稱，使用 @Input 註解。

Gradle 使用 @Input 註解來判斷 Task 是否需要執行。如果 Task 之前未執行過，或者輸入值自上次執行以來已變更，則 Gradle 將執行 Task。

雖然已建立自訂類別，但尚未將其添加到 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

下一步： 撰寫外掛程式 >>