Gradle 可以对项目执行的工作由一个或多个任务定义。

author gradle 5

任务表示构建执行的某个独立工作单元。这可能是编译一些类、创建 JAR、生成 Javadoc 或将一些归档发布到存储库。

当用户在命令行中运行 ./gradlew build 时,Gradle 将执行 build 任务以及它所依赖的任何其他任务。

列出可用任务

Gradle 为项目提供了一些默认任务,可以通过运行 ./gradlew tasks 来列出这些任务。

> Task :tasks

------------------------------------------------------------
Tasks runnable from root project 'myTutorial'
------------------------------------------------------------

Build Setup tasks
-----------------
init - Initializes a new Gradle build.
wrapper - Generates Gradle wrapper files.

Help tasks
----------
buildEnvironment - Displays all buildscript dependencies declared in root project 'myTutorial'.
...

任务要么来自构建脚本,要么来自插件

一旦我们向项目应用插件,例如 application 插件,就会有其他任务可用。

build.gradle.kts
plugins {
    id("application")
}
$ ./gradlew tasks

> Task :tasks

------------------------------------------------------------
Tasks runnable from project ':app'
------------------------------------------------------------

Application tasks
-----------------
run - Runs this project as a JVM application

Build tasks
-----------
assemble - Assembles the outputs of this project.
build - Assembles and tests this project.

Documentation tasks
-------------------
javadoc - Generates Javadoc API documentation for the main source code.

Other tasks
-----------
compileJava - Compiles main Java source.

...

其中许多任务(例如 assemblebuildrun)对于开发人员来说应该是熟悉的。

任务分类

有两类可以执行的任务

  1. 可操作任务有一些操作附加到构建中执行工作:compileJava

  2. 生命周期任务是没有附加操作的任务:assemblebuild

通常,生命周期任务依赖于许多可操作任务,并用于一次执行许多任务。

任务注册和操作

让我们在构建脚本中查看一个简单的“Hello World”任务

build.gradle.kts
tasks.register("hello") {
    doLast {
        println("Hello world!")
    }
}
build.gradle
tasks.register('hello') {
    doLast {
        println 'Hello world!'
    }
}

在示例中,构建脚本使用 TaskContainer API 注册了一个名为 hello 的单一任务,并向其添加了一个操作

如果列出项目中的任务,则 Gradle 可以使用 hello 任务

$ ./gradlew app:tasks --all

> Task :app:tasks

------------------------------------------------------------
Tasks runnable from project ':app'
------------------------------------------------------------

Other tasks
-----------
compileJava - Compiles main Java source.
compileTestJava - Compiles test Java source.
hello
processResources - Processes main resources.
processTestResources - Processes test resources.
startScripts - Creates OS-specific scripts to run the project as a JVM application.

您可以使用 ./gradlew hello 在构建脚本中执行任务

$ ./gradlew hello
Hello world!

当 Gradle 执行 hello 任务时,它会执行提供的操作。在这种情况下,操作只是一个包含一些代码的块:println("Hello world!")

任务组和描述

前一节中的 hello 任务可以用描述详细说明,并通过以下更新分配给

build.gradle.kts
tasks.register("hello") {
    group = "Custom"
    description = "A lovely greeting task."
    doLast {
        println("Hello world!")
    }
}

将任务分配给组后,它将由 ./gradlew tasks 列出

$ ./gradlew tasks

> Task :tasks

Custom tasks
------------------
hello - A lovely greeting task.

要查看有关任务的信息,请使用 help --task <task-name> 命令

$./gradlew help --task hello

> Task :help
Detailed task information for hello

Path
:app:hello

Type
Task (org.gradle.api.Task)

Options
--rerun     Causes the task to be re-run even if up-to-date.

Description
A lovely greeting task.

Group
Custom

正如我们所看到的,hello 任务属于 custom 组。

任务依赖关系

您可以声明依赖于其他任务的任务

build.gradle.kts
tasks.register("hello") {
    doLast {
        println("Hello world!")
    }
}
tasks.register("intro") {
    dependsOn("hello")
    doLast {
        println("I'm Gradle")
    }
}
build.gradle
tasks.register('hello') {
    doLast {
        println 'Hello world!'
    }
}
tasks.register('intro') {
    dependsOn tasks.hello
    doLast {
        println "I'm Gradle"
    }
}
$ gradle -q intro
Hello world!
I'm Gradle

taskXtaskY 的依赖关系可以在定义 taskY 之前声明

build.gradle.kts
tasks.register("taskX") {
    dependsOn("taskY")
    doLast {
        println("taskX")
    }
}
tasks.register("taskY") {
    doLast {
        println("taskY")
    }
}
build.gradle
tasks.register('taskX') {
    dependsOn 'taskY'
    doLast {
        println 'taskX'
    }
}
tasks.register('taskY') {
    doLast {
        println 'taskY'
    }
}
$ gradle -q taskX
taskY
taskX

前一个示例中的 hello 任务已更新,以包括依赖关系

build.gradle.kts
tasks.register("hello") {
    group = "Custom"
    description = "A lovely greeting task."
    doLast {
        println("Hello world!")
    }
    dependsOn(tasks.assemble)
}

hello 任务现在依赖于 assemble 任务,这意味着 Gradle 必须在执行 hello 任务之前执行 assemble 任务

$ ./gradlew :app:hello

> Task :app:compileJava UP-TO-DATE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:jar UP-TO-DATE
> Task :app:startScripts UP-TO-DATE
> Task :app:distTar UP-TO-DATE
> Task :app:distZip UP-TO-DATE
> Task :app:assemble UP-TO-DATE

> Task :app:hello
Hello world!

任务配置

注册后,可以通过 TaskProvider API 访问任务以进行进一步配置。

例如,您可以使用它在运行时动态地向任务添加依赖关系

build.gradle.kts
repeat(4) { counter ->
    tasks.register("task$counter") {
        doLast {
            println("I'm task number $counter")
        }
    }
}
tasks.named("task0") { dependsOn("task2", "task3") }
build.gradle
4.times { counter ->
    tasks.register("task$counter") {
        doLast {
            println "I'm task number $counter"
        }
    }
}
tasks.named('task0') { dependsOn('task2', 'task3') }
$ gradle -q task0
I'm task number 2
I'm task number 3
I'm task number 0

或者,您可以向现有任务添加行为

build.gradle.kts
tasks.register("hello") {
    doLast {
        println("Hello Earth")
    }
}
tasks.named("hello") {
    doFirst {
        println("Hello Venus")
    }
}
tasks.named("hello") {
    doLast {
        println("Hello Mars")
    }
}
tasks.named("hello") {
    doLast {
        println("Hello Jupiter")
    }
}
build.gradle
tasks.register('hello') {
    doLast {
        println 'Hello Earth'
    }
}
tasks.named('hello') {
    doFirst {
        println 'Hello Venus'
    }
}
tasks.named('hello') {
    doLast {
        println 'Hello Mars'
    }
}
tasks.named('hello') {
    doLast {
        println 'Hello Jupiter'
    }
}
$ gradle -q hello
Hello Venus
Hello Earth
Hello Mars
Hello Jupiter
doFirstdoLast 调用可以执行多次。它们将一个操作添加到任务操作列表的开头或结尾。当任务执行时,操作列表中的操作将按顺序执行。

以下是使用 named 方法配置由插件添加的任务的示例

tasks.named("dokkaHtml") {
    outputDirectory.set(buildDir.resolve("dokka"))
}

任务类型

Gradle 任务是 Task 的子类。

在构建脚本中,通过扩展 DefaultTask 来创建 HelloTask

build.gradle.kts
// Extend the DefaultTask class to create a HelloTask class
abstract class HelloTask : DefaultTask() {
    @TaskAction
    fun hello() {
        println("hello from HelloTask")
    }
}

// Register the hello Task with type HelloTask
tasks.register<HelloTask>("hello") {
    group = "Custom tasks"
    description = "A lovely greeting task."
}

hello 任务已使用 类型 HelloTask 注册。

执行我们的新 hello 任务

$ ./gradlew hello

> Task :app:hello
hello from HelloTask

现在,hello 任务的类型是 HelloTask,而不是 Task

Gradle help 任务显示了更改

$ ./gradlew help --task hello

> Task :help
Detailed task information for hello

Path
:app:hello

Type
HelloTask (Build_gradle$HelloTask)

Options
--rerun     Causes the task to be re-run even if up-to-date.

Description
A lovely greeting task.

Group
Custom tasks

内置任务类型

Gradle 提供了许多内置任务类型,具有常见和流行的功能,例如复制或删除文件。

此示例任务使用 Copy 内置任务将 *.war 文件从 source 目录复制到 target 目录

tasks.register("copyTask",Copy) {
    from("source")
    into("target")
    include("*.war")
}

开发人员可以利用许多任务类型,包括 GroovyDocZipJarJacocoReportSignDelete,这些类型可在 DSL 中使用。

下一步: 了解如何编写任务 >>