Groovy & Gradle: JVM Automation and Build Engineering · 课时

任务属性与配置

学习向自定义任务添加属性、配置这些属性，并确保实现增量构建。

任务属性与配置 是 CoddyKit 上的免费 Groovy & Gradle: JVM Automation and Build Engineering 课时。这是第 3 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 Groovy & Gradle: JVM Automation and Build Engineering 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Groovy & Gradle: JVM Automation and Build Engineering 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

What are Task Properties?

Custom Gradle tasks can be made highly flexible by adding properties. These properties act like variables that allow you to configure a task's behavior from your build.gradle script.

Using properties makes your custom tasks reusable and adaptable to different project needs without having to change their core logic.

Defining Simple Properties

To add a property to a custom task, you simply declare a public field within your task class. For basic types like String, int, or boolean, this is straightforward.

For more advanced scenarios, Gradle also offers dedicated Property types, but we'll start with simple declarations.

Custom Task with a Property

Here's a basic custom task defined directly in build.gradle. It has a message property that will be printed when the task runs. Notice the default value set for the property.

import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction

class MyMessageTask extends DefaultTask {
    String message = "Default task message"

    @TaskAction
    void printMessage() {
        println "Task says: ${message}"
    }
}

task helloWorld(type: MyMessageTask)

Configuring Task Properties

Once a task property is defined, you can easily set its value from your build.gradle file. This is done within the task's configuration block, which allows you to customize the task instance.

Run the example to see how the default message is overridden.

import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction

class MyMessageTask extends DefaultTask {
    String message = "Default task message"

    @TaskAction
    void printMessage() {
        println "Task says: ${message}"
    }
}

task helloWorld(type: MyMessageTask) {
    message = "Hello from CoddyKit!"
}

Inputs for Incremental Builds

One of Gradle's most powerful features is incremental builds. This means Gradle can skip tasks if their inputs and outputs haven't changed since the last build, saving a lot of time.

To enable this, you must tell Gradle which properties are considered task inputs. These are properties whose values influence the task's outcome.

Declaring Input Properties

You mark a property as an input using the @Input annotation. Gradle will then track its value. If the value changes between builds, the task will execute. If not, Gradle can mark it as UP-TO-DATE and skip it.

For file or directory inputs, use @InputFile, @InputDirectory, or @InputFiles.

import org.gradle.api.DefaultTask
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.TaskAction

class MyInputTask extends DefaultTask {
    @Input
    String greeting = "Hola!"

    @TaskAction
    void greet() {
        println "Greeting: ${greeting}"
    }
}

task sayHello(type: MyInputTask) {
    greeting = "Bonjour!"
}

Outputs for Incremental Builds

Equally important are outputs. These are the files or directories that your task creates or modifies during its execution. Gradle also tracks these to determine if a task is up-to-date.

If a task's inputs haven't changed AND its declared outputs are present and valid, Gradle knows the task doesn't need to run again.

Declaring Output Properties

You use annotations like @OutputFile for a single result file or @OutputDirectory for a directory containing results. These tell Gradle where the task's generated artifacts will be stored.

The task will ensure the parent directory exists before writing the file.

import org.gradle.api.DefaultTask
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.OutputFile
import org.gradle.api.tasks.TaskAction

class MyOutputFileTask extends DefaultTask {
    @Input
    String content = "Default report content."

    @OutputFile
    File outputFile = project.file("build/reports/output.txt")

    @TaskAction
    void generateFile() {
        outputFile.parentFile.mkdirs()
        outputFile.write(content)
        println "Generated: ${outputFile.name}"
    }
}

task generateReport(type: MyOutputFileTask) {
    content = "Report data for: " + new Date().format("yyyy-MM-dd HH:mm:ss")
}

The Power of Incremental Builds

By correctly declaring both inputs and outputs, you unlock Gradle's powerful incremental build feature. This means your tasks only run when necessary, drastically speeding up build times.

This optimization is crucial for efficient development workflows and robust CI/CD pipelines, ensuring quick feedback and resource savings.

Quick Check on Properties

Imagine you have a custom Gradle task that takes a specific configuration file as an input. Which annotation would you use for the property that defines the path to this single configuration file?

Recap: Task Properties & Incremental Builds

In this lesson, you learned how to add properties to custom tasks, making them configurable and reusable. You also discovered how to mark properties as inputs (e.g., @Input, @InputFile) and outputs (e.g., @OutputFile, @OutputDirectory).

These annotations are key to enabling Gradle's powerful incremental build feature, which significantly speeds up your builds by skipping tasks that are already up-to-date. Keep practicing to master efficient task configuration!

常见问题解答

「任务属性与配置」课时是免费的吗？

是的 — 「任务属性与配置」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Groovy & Gradle: JVM Automation and Build Engineering 课程的其余内容，请升级到 CoddyKit PRO。 Groovy & Gradle: JVM Automation and Build Engineering 课程共包含 4 节课。

「任务属性与配置」这节课中我会学到什么？

学习向自定义任务添加属性、配置这些属性，并确保实现增量构建。你通过在浏览器中直接运行的动手代码来练习 Groovy & Gradle: JVM Automation and Build Engineering，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Groovy & Gradle: JVM Automation and Build Engineering 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Groovy & Gradle: JVM Automation and Build Engineering 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 3 节课，共 4 节。

「任务属性与配置」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Groovy & Gradle: JVM Automation and Build Engineering 课中编写并运行代码吗？

能。每节 Groovy & Gradle: JVM Automation and Build Engineering 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 Groovy & Gradle: JVM Automation and Build Engineering