Chapter 6. Build Script Basics
6.1. Projects and tasks
Everything in Gradle sits on top of two basic concepts: projects and tasks.
Every Gradle build is made up of one or more projects. What a project represents depends on what it is that you are doing with Gradle. For example, a project might represent a library JAR or a web application. It might represent a distribution ZIP assembled from the JARs produced by other projects. A project does not necessarily represent a thing to be built. It might represent a thing to be done, such as deploying your application to staging or production environments. Don't worry if this seems a little vague for now. Gradle's build-by-convention support adds a more concrete definition for what a project is.
Each project is made up of one or more tasks. A task represents some atomic piece of work which a build performs. This might be compiling some classes, creating a JAR, generating javadoc, or publishing some archives to a repository.
For now, we will look at defining some simple tasks in a build with one project. Later chapters will look at working with multiple projects and more about working with projects and tasks.
6.2. Hello world
You run a Gradle build using the gradle command. The gradle command looks for a file called build.gradle
in the current directory. [2] We call this build.gradle
file a build script, although strictly speaking it is a build configuration script, as we will see later. The build script defines a project and its tasks.
To try this out, create the following build script named build.gradle
.
Example 6.1. Your first build script
build.gradle
In a command-line shell, move to the containing directory and execute the build script with gradle -q hello
:
What does -q
do?
Most of the examples in this user guide are run with the -q
command-line option. This suppresses Gradle's log messages, so that only the output of the tasks is shown. This keeps the example output in this user guide a little clearer. You don't need to use this option if you don't want. See Chapter 18, Logging for more details about the command-line options which affect Gradle's output.
Example 6.2. Execution of a build script
Output of gradle -q hello
What's going on here? This build script defines a single task, called hello
, and adds an action to it. When you rungradle hello
, Gradle executes the hello
task, which in turn executes the action you've provided. The action is simply a closure containing some Groovy code to execute.
If you think this looks similar to Ant's targets, you would be right. Gradle tasks are the equivalent to Ant targets, but as you will see, they are much more powerful. We have used a different terminology than Ant as we think the word task is more expressive than the word target. Unfortunately this introduces a terminology clash with Ant, as Ant calls its commands, such as javac
or copy
, tasks. So when we talk about tasks, wealways mean Gradle tasks, which are the equivalent to Ant's targets. If we talk about Ant tasks (Ant commands), we explicitly say ant task.
6.3. A shortcut task definition
There is a shorthand way to define a task like our hello
task above, which is more concise.
Example 6.3. A task definition shortcut
build.gradle
Again, this defines a task called hello
with a single closure to execute. We will use this task definition style throughout the user guide.
6.4. Build scripts are code
Gradle's build scripts give you the full power of Groovy. As an appetizer, have a look at this:
Example 6.4. Using Groovy in Gradle's tasks
build.gradle
Output of gradle -q upper
or
Example 6.5. Using Groovy in Gradle's tasks
build.gradle
Output of gradle -q count
6.5. Task dependencies
As you probably have guessed, you can declare tasks that depend on other tasks.
Example 6.6. Declaration of task that depends on other task
build.gradle
Output of gradle -q intro
To add a dependency, the corresponding task does not need to exist.
Example 6.7. Lazy dependsOn - the other task does not exist (yet)
build.gradle
Output of gradle -q taskX
The dependency of taskX
to taskY
is declared before taskY
is defined. This is very important for multi-project builds. Task dependencies are discussed in more detail in Section 15.4, “Adding dependencies to a task”.
Please notice that you can't use shortcut notation (see Section 6.8, “Shortcut notations”) when referring to a task that is not yet defined.
6.6. Dynamic tasks
The power of Groovy can be used for more than defining what a task does. For example, you can also use it to dynamically create tasks.
Example 6.8. Dynamic creation of a task
build.gradle
Output of gradle -q task1
6.7. Manipulating existing tasks
Once tasks are created they can be accessed via an API. For instance, you could use this to dynamically add dependencies to a task, at runtime. Ant doesn't allow anything like this.
Example 6.9. Accessing a task via API - adding a dependency
build.gradle
Output of gradle -q task0
Or you can add behavior to an existing task.
Example 6.10. Accessing a task via API - adding behaviour
build.gradle
Output of gradle -q hello
The calls doFirst
and doLast
can be executed multiple times. They add an action to the beginning or the end of the task's actions list. When the task executes, the actions in the action list are executed in order. The <<
operator is simply an alias for doLast
.
6.8. Shortcut notations
As you might have noticed in the previous examples, there is a convenient notation for accessing an existing task. Each task is available as a property of the build script:
Example 6.11. Accessing task as a property of the build script
build.gradle
Output of gradle -q hello
This enables very readable code, especially when using the tasks provided by the plugins, like the compile
task.
6.9. Extra task properties
You can add your own properties to a task. To add a property named myProperty
, set ext.myProperty
to an initial value. From that point on, the property can be read and set like a predefined task property.
Example 6.12. Adding extra properties to a task
build.gradle
Output of gradle -q printTaskProperties
Extra properties aren't limited to tasks. You can read more about them in Section 13.4.2, “Extra properties”.
6.10. Using Ant Tasks
Ant tasks are first-class citizens in Gradle. Gradle provides excellent integration for Ant tasks by simply relying on Groovy. Groovy is shipped with the fantastic AntBuilder
. Using Ant tasks from Gradle is as convenient and more powerful than using Ant tasks from a build.xml
file. From the example below, you can learn how to execute ant tasks and how to access ant properties:
Example 6.13. Using AntBuilder to execute ant.loadfile target
build.gradle
Output of gradle -q loadfile
There is lots more you can do with Ant in your build scripts. You can find out more in Chapter 17, Using Ant from Gradle.
6.11. Using methods
Gradle scales in how you can organize your build logic. The first level of organizing your build logic for the example above, is extracting a method.
Example 6.14. Using methods to organize your build logic
build.gradle
Output of gradle -q loadfile
Later you will see that such methods can be shared among subprojects in multi-project builds. If your build logic becomes more complex, Gradle offers you other very convenient ways to organize it. We have devoted a whole chapter to this. See Chapter 60, Organizing Build Logic.
6.12. Default tasks
Gradle allows you to define one or more default tasks for your build.
Example 6.15. Defining a default tasks
build.gradle
Output of gradle -q
This is equivalent to running gradle clean run
. In a multi-project build every subproject can have its own specific default tasks. If a subproject does not specify default tasks, the default tasks of the parent project are used (if defined).
6.13. Configure by DAG
As we later describe in full detail (see Chapter 56, The Build Lifecycle), Gradle has a configuration phase and an execution phase. After the configuration phase, Gradle knows all tasks that should be executed. Gradle offers you a hook to make use of this information. A use-case for this would be to check if the release task is among the tasks to be executed. Depending on this, you can assign different values to some variables.
In the following example, execution of the distribution
and release
tasks results in different value of the version
variable.
Example 6.16. Different outcomes of build depending on chosen tasks
build.gradle
Output of gradle -q distribution
Output of gradle -q release
The important thing is that whenReady
affects the release task before the release task is executed. This works even when the release task is not the primary task (i.e., the task passed to thegradle command).
6.14. Where to next?
In this chapter, we have had a first look at tasks. But this is not the end of the story for tasks. If you want to jump into more of the details, have a look at Chapter 15, More about Tasks.
Otherwise, continue on to the tutorials in Chapter 7, Java Quickstart and Chapter 8, Dependency Management Basics.
[2] There are command line switches to change this behavior. See Appendix D, Gradle Command Line)
Previous|Contents|Next