Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletter Hub
Free Learning
Arrow right icon
timer SALE ENDS IN
0 Days
:
00 Hours
:
00 Minutes
:
00 Seconds
Gradle Effective Implementations Guide
Gradle Effective Implementations Guide

Gradle Effective Implementations Guide: This comprehensive guide will get you up and running with build automation using Gradle. , Second Edition

eBook
Mex$561.99 Mex$803.99
Paperback
Mex$1004.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing
Table of content icon View table of contents Preview book icon Preview Book

Gradle Effective Implementations Guide

Chapter 2.  Creating Gradle Build Scripts

In Gradle, projects and tasks are two important concepts. A Gradle build always consists of one or more projects. A project defines some sort of component that we want to build. There are no defining rules about what the component is. It can be a JAR file with utility classes to be used in other projects, or a web application to be deployed to the corporate intranet. A project doesn't have to be about building and packaging code, it can also be about doing things such as copying files on a remote server or deployment of applications to servers.

A project has one or more tasks. A task is a small piece of work that is executed when we run a build, for example, compiling source code, packaging code in an archive file, generating documentation, and so on.

In this chapter, we will discuss how to define a project with tasks and use it as a Gradle build. We will cover the following topics:

  • Defining tasks
  • Defining dependencies between tasks...

Writing a build script

In the first chapter, we have already written our first build script. Let's create a similar build script with a simple task. Gradle will look for a file with the name build.gradle in the current directory. The build.gradle file contains the tasks that make up our project. In this example, we define a simple task that prints out a simple message to the console:

// Assign value to description property. 
project.description = 'Simple project' 
 
// DSL to create a new task using 
// Groovy << operator. 
task simple << { 
    println 'Running simple task for project ' + 
      project.description 
} 

If we run the build, we see the following output in the console:

:simple
Running simple task for project Simple project
BUILD SUCCESSFUL
Total time: 0.57 secs

A couple of interesting things happen with this small build script. Gradle reads the script file and creates a Project object. The build script configures the Project object...

Defining tasks

A project has one or more tasks to execute some actions, so a task is made up of actions. These actions are executed when the task is executed. Gradle supports several ways to add actions to our tasks. In this section, we discuss about the different ways to add actions to a task.

We can use the doFirst and doLast methods to add actions to our task, and we can use the left-shift operator (<<) as a synonym for the doLast method. With the doLast method or the left-shift operator (<<), we add actions at the end of the list of actions for the task. With the doFirst method, we can add actions to the beginning of the list of actions. The following script shows how we can use the several methods:

task first { 
    doFirst { 
        println 'Running first' 
    } 
} 
 
task second { 
    doLast { Task task -> 
        println "Running ${task.name}" 
    } 
} 
 
// Here we use the << operator 
// as synonym for the doLast...

Build scripts are Groovy code

We must keep in mind that Gradle scripts use Groovy. This means that we can use all the Groovy's good stuff in our scripts. We already saw the use of so-called Groovy GString in our sample script. The GString object is defined as a String with double quotes and can contain references to variables defined in a ${... } section. The variable reference is resolved when we get the value of the GString.

However, other great Groovy constructs can also be used in Gradle scripts. The following sample script shows some of these constructs:

task numbers << { 
    // To define a range of numbers 
    // we can use the following syntax: 
    // start..end. 
    // The each method executes the code 
    // in the closure for each element 
    // in a collection, like a range. 
    (1..4).each { number -> 
        // def is short for define. 
        // Used to define a variable without 
        // an explicit type of the variable. 
        def...

Defining dependencies between tasks

Until now, we have defined tasks independent of each other. However, in our projects, we need dependencies between tasks. For example, a task to package compiled class files is dependent on the task to compile the class files. The build system should then run the compile task first, and when the task is finished, the package task must be executed.

In Gradle, we can add task dependencies with the dependsOn method for a task. We can specify a task name as the String value or task object as the argument. We can even specify more than one task name or object to specify multiple task dependencies. First, let's look at a simple task dependency:

task first << { task -> 
    println "Run ${task.name}" 
} 
 
task second << { task -> 
    println "Run ${task.name}" 
} 
 
// Define dependency of task second on task first 
second.dependsOn 'first' 

Note that we define the dependency of the second task on the...

Writing a build script


In the first chapter, we have already written our first build script. Let's create a similar build script with a simple task. Gradle will look for a file with the name build.gradle in the current directory. The build.gradle file contains the tasks that make up our project. In this example, we define a simple task that prints out a simple message to the console:

// Assign value to description property. 
project.description = 'Simple project' 
 
// DSL to create a new task using 
// Groovy << operator. 
task simple << { 
    println 'Running simple task for project ' + 
      project.description 
} 

If we run the build, we see the following output in the console:

:simple
Running simple task for project Simple project
BUILD SUCCESSFUL
Total time: 0.57 secs

A couple of interesting things happen with this small build script. Gradle reads the script file and creates a Project object. The build script configures the Project object, and finally, the set of tasks...

Defining tasks


A project has one or more tasks to execute some actions, so a task is made up of actions. These actions are executed when the task is executed. Gradle supports several ways to add actions to our tasks. In this section, we discuss about the different ways to add actions to a task.

We can use the doFirst and doLast methods to add actions to our task, and we can use the left-shift operator (<<) as a synonym for the doLast method. With the doLast method or the left-shift operator (<<), we add actions at the end of the list of actions for the task. With the doFirst method, we can add actions to the beginning of the list of actions. The following script shows how we can use the several methods:

task first { 
    doFirst { 
        println 'Running first' 
    } 
} 
 
task second { 
    doLast { Task task -> 
        println "Running ${task.name}" 
    } 
} 
 
// Here we use the << operator 
// as synonym for the doLast method. 
task third << { taskObject...

Build scripts are Groovy code


We must keep in mind that Gradle scripts use Groovy. This means that we can use all the Groovy's good stuff in our scripts. We already saw the use of so-called Groovy GString in our sample script. The GString object is defined as a String with double quotes and can contain references to variables defined in a ${... } section. The variable reference is resolved when we get the value of the GString.

However, other great Groovy constructs can also be used in Gradle scripts. The following sample script shows some of these constructs:

task numbers << { 
    // To define a range of numbers 
    // we can use the following syntax: 
    // start..end. 
    // The each method executes the code 
    // in the closure for each element 
    // in a collection, like a range. 
    (1..4).each { number -> 
        // def is short for define. 
        // Used to define a variable without 
        // an explicit type of the variable. 
        def squared = number * number...

Defining dependencies between tasks


Until now, we have defined tasks independent of each other. However, in our projects, we need dependencies between tasks. For example, a task to package compiled class files is dependent on the task to compile the class files. The build system should then run the compile task first, and when the task is finished, the package task must be executed.

In Gradle, we can add task dependencies with the dependsOn method for a task. We can specify a task name as the String value or task object as the argument. We can even specify more than one task name or object to specify multiple task dependencies. First, let's look at a simple task dependency:

task first << { task -> 
    println "Run ${task.name}" 
} 
 
task second << { task -> 
    println "Run ${task.name}" 
} 
 
// Define dependency of task second on task first 
second.dependsOn 'first' 

Note that we define the dependency of the second task on the first task, in the last line. When we run...

Setting default tasks


To execute a task, we use the task name on the command line when we run gradle. So, if our build script contains a task with the first name, we can run the task with the following command:

$ gradle first

However, we can also define a default task or multiple default tasks that need to be executed, even if we don't explicitly set the task name. So, if we run the gradle command without arguments, the default task of our build script will be executed.

To set the default task or tasks, we use the defaultTasks method. We pass the names of the tasks that need to be executed to the method. In the following build script, we make the first and second tasks the default tasks:

defaultTasks 'first', 'second' 
 
task first { 
    doLast { 
        println "I am first" 
    } 
} 
 
task second { 
    doFirst { 
        println "I am second" 
    } 
} 

We can run our build script and get the following output:

$ gradle
:first
I am first
:second
I am second
BUILD SUCCESSFUL
Total time...

Organizing tasks


In Chapter 1Starting with Gradle, we already discussed that we could use the tasks task of Gradle to see the tasks that are available for a build. Let's suppose we have the following simple build script:

defaultTasks 'second' 
 
task first << { 
    println "I am first" 
} 
 
task second(dependsOn: first) << { 
    println "I am second" 
} 

Nothing fancy here. The second task is the default task and depends on the first task. When we run the tasks task on the command line, we get the following output:

$ gradle -q tasks
------------------------------------------------------------
All tasks runnable from root project
------------------------------------------------------------
Default tasks: second
Build Setup tasks
-----------------
init - Initializes a new Gradle build. [incubating]
wrapper - Generates Gradle wrapper files. [incubating]
Help tasks
----------
components - Displays the components produced by root project 'organize'. [incubating]
dependencies...

Adding tasks in other ways


Until now, we have added tasks to our build project using the task keyword, followed by the name of the task. However, there are more ways to add tasks to our project. We can use a String value with the task name to define a new task, as follows:

task 'simple' << { task -> 
    println "Running ${task.name}" 
} 

We can also use variable expressions to define a new task. If doing so, we must use parenthesis, otherwise the expression cannot be resolved. The following sample script defines a simpleTask variable with the simple string value. This expression is used to define the task. The result is that our project now contains a task with the name simple:

// Define name of task 
// as a variable. 
def simpleTask = 'simple' 
 
// Variable is used for the task name. 
task(simpleTask) << { task -> 
    println "Running ${task.name}" 
} 

We can run the tasks task to see our newly created task:

$ gradle -q tasks
...
Other tasks
-----------
simple
...

We...

Accessing tasks as project properties


Each task that we add is also available as a project property, and we can reference this property like we can reference any other property in our build script. We can, for example, invoke methods or get and set the property values of our task through the property reference. This means that we are very flexible in how we create our tasks and add behavior to the tasks. In the following script, we use the project property reference to a task to change the description property:

// Create a simple task. 
task simple << { task -> 
    println "Running ${task.name}" 
} 
 
// The simple task is available as 
// project property. 
simple.description = 'Print task name' 
 
// We can invoke methods from the 
// Task object. 
simple.doLast { 
    println "Done" 
} 
 
// We can also reference the task 
// via the project property 
// explicitly. 
project.simple.doFirst { 
    println "Start" 
} 

When we run our task from the command line, we get the following...

Left arrow icon Right arrow icon

Key benefits

  • Practical and engaging from start to finish covering the fundamentals of Gradle
  • Learn the skills required to develop Java applications with Gradle and integrate at an enterprise level
  • Apply the correct plugin and configuration to our Gradle build files to work with the different languages

Description

Gradle is a project automation tool that has a wide range of applications. The basic aim of Gradle is to automate a wide variety of tasks performed by software developers, including compiling computer source code to binary code, packaging binary codes, running tests, deploying applications to production systems, and creating documentation. The book will start with the fundamentals of Gradle and introduce you to the tools that will be used in further chapters. You will learn to create and work with Gradle scripts and then see how to use Gradle to build your Java Projects. While building Java application, you will find out about other important topics such as dependency management, publishing artifacts, and integrating the application with other JVM languages such as Scala and Groovy. By the end of this book, you will be able to use Gradle in your daily development. Writing tasks, applying plugins, and creating build logic will be your second nature.

Who is this book for?

This book is for Java developers who have working knowledge of build automation processes and are now looking to gain expertise with Gradle and add to their skill set.

What you will learn

  • Write your first Gradle Script
  • Write build logic with the Gradle build language
  • Explore the Java plugins supported by Gradle
  • Understand dependency management in Gradle
  • Package and publish your (web) application
  • Integrate Scala and Groovy with Gradle
  • Write your own custom tasks and plugins
  • Integrate Gradle with your IDE

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : May 30, 2016
Length: 368 pages
Edition : 2nd
Language : English
ISBN-13 : 9781784394974
Languages :
Tools :

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing

Product Details

Publication date : May 30, 2016
Length: 368 pages
Edition : 2nd
Language : English
ISBN-13 : 9781784394974
Languages :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
$19.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
$199.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just Mex$85 each
Feature tick icon Exclusive print discounts
$279.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just Mex$85 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total Mex$ 2,686.97
Gradle Effective Implementations Guide
Mex$1004.99
Gradle Essentials
Mex$676.99
Mastering Gradle
Mex$1004.99
Total Mex$ 2,686.97 Stars icon

Table of Contents

12 Chapters
1. Starting with Gradle Chevron down icon Chevron up icon
2. Creating Gradle Build Scripts Chevron down icon Chevron up icon
3. Working with Gradle Build Scripts Chevron down icon Chevron up icon
4. Using Gradle for Java Projects Chevron down icon Chevron up icon
5. Dependency Management Chevron down icon Chevron up icon
6. Testing, Building, and Publishing Artifacts Chevron down icon Chevron up icon
7. Multi-project Builds Chevron down icon Chevron up icon
8. Mixed Languages Chevron down icon Chevron up icon
9. Maintaining Code Quality Chevron down icon Chevron up icon
10. Writing Custom Tasks and Plugins Chevron down icon Chevron up icon
11. Gradle in the Enterprise Chevron down icon Chevron up icon
12. IDE Support Chevron down icon Chevron up icon

Customer reviews

Rating distribution
Full star icon Full star icon Full star icon Full star icon Half star icon 4.3
(3 Ratings)
5 star 33.3%
4 star 66.7%
3 star 0%
2 star 0%
1 star 0%
Damian Sep 08, 2023
Full star icon Full star icon Full star icon Full star icon Full star icon 5
The book remains no doubts about how the Gradle works and does it in a very pleasant way. I couldn’t stop the reading.
Amazon Verified review Amazon
Roman May 14, 2018
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
A little outdated (book based on Gradle version 2.11), but gives a strong basis and understanding what is going under the hood.Written in simple language, no problem to understand for non-native speakers.Best gradle book so far.
Amazon Verified review Amazon
Amazon Customer Apr 27, 2017
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
This is a very good introduction to Gradle. Even though the project is advancing at a fast pace, most of the book is relevant. The only downside is that the book is a bit pricey.
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is included in a Packt subscription? Chevron down icon Chevron up icon

A subscription provides you with full access to view all Packt and licnesed content online, this includes exclusive access to Early Access titles. Depending on the tier chosen you can also earn credits and discounts to use for owning content

How can I cancel my subscription? Chevron down icon Chevron up icon

To cancel your subscription with us simply go to the account page - found in the top right of the page or at https://subscription.packtpub.com/my-account/subscription - From here you will see the ‘cancel subscription’ button in the grey box with your subscription information in.

What are credits? Chevron down icon Chevron up icon

Credits can be earned from reading 40 section of any title within the payment cycle - a month starting from the day of subscription payment. You also earn a Credit every month if you subscribe to our annual or 18 month plans. Credits can be used to buy books DRM free, the same way that you would pay for a book. Your credits can be found in the subscription homepage - subscription.packtpub.com - clicking on ‘the my’ library dropdown and selecting ‘credits’.

What happens if an Early Access Course is cancelled? Chevron down icon Chevron up icon

Projects are rarely cancelled, but sometimes it's unavoidable. If an Early Access course is cancelled or excessively delayed, you can exchange your purchase for another course. For further details, please contact us here.

Where can I send feedback about an Early Access title? Chevron down icon Chevron up icon

If you have any feedback about the product you're reading, or Early Access in general, then please fill out a contact form here and we'll make sure the feedback gets to the right team. 

Can I download the code files for Early Access titles? Chevron down icon Chevron up icon

We try to ensure that all books in Early Access have code available to use, download, and fork on GitHub. This helps us be more agile in the development of the book, and helps keep the often changing code base of new versions and new technologies as up to date as possible. Unfortunately, however, there will be rare cases when it is not possible for us to have downloadable code samples available until publication.

When we publish the book, the code files will also be available to download from the Packt website.

How accurate is the publication date? Chevron down icon Chevron up icon

The publication date is as accurate as we can be at any point in the project. Unfortunately, delays can happen. Often those delays are out of our control, such as changes to the technology code base or delays in the tech release. We do our best to give you an accurate estimate of the publication date at any given time, and as more chapters are delivered, the more accurate the delivery date will become.

How will I know when new chapters are ready? Chevron down icon Chevron up icon

We'll let you know every time there has been an update to a course that you've bought in Early Access. You'll get an email to let you know there has been a new chapter, or a change to a previous chapter. The new chapters are automatically added to your account, so you can also check back there any time you're ready and download or read them online.

I am a Packt subscriber, do I get Early Access? Chevron down icon Chevron up icon

Yes, all Early Access content is fully available through your subscription. You will need to have a paid for or active trial subscription in order to access all titles.

How is Early Access delivered? Chevron down icon Chevron up icon

Early Access is currently only available as a PDF or through our online reader. As we make changes or add new chapters, the files in your Packt account will be updated so you can download them again or view them online immediately.

How do I buy Early Access content? Chevron down icon Chevron up icon

Early Access is a way of us getting our content to you quicker, but the method of buying the Early Access course is still the same. Just find the course you want to buy, go through the check-out steps, and you’ll get a confirmation email from us with information and a link to the relevant Early Access courses.

What is Early Access? Chevron down icon Chevron up icon

Keeping up to date with the latest technology is difficult; new versions, new frameworks, new techniques. This feature gives you a head-start to our content, as it's being created. With Early Access you'll receive each chapter as it's written, and get regular updates throughout the product's development, as well as the final course as soon as it's ready.We created Early Access as a means of giving you the information you need, as soon as it's available. As we go through the process of developing a course, 99% of it can be ready but we can't publish until that last 1% falls in to place. Early Access helps to unlock the potential of our content early, to help you start your learning when you need it most. You not only get access to every chapter as it's delivered, edited, and updated, but you'll also get the finalized, DRM-free product to download in any format you want when it's published. As a member of Packt, you'll also be eligible for our exclusive offers, including a free course every day, and discounts on new and popular titles.