Using variables in Gradle build script

Question

I am using Gradle in my project. I have a task for doing some extra configuration with my war. I need to build a string to use in my task like, lets say I have:

task extraStuff{
    doStuff 'org.springframework:spring-web:3.0.6.RELEASE@war'
}

This works fine. What I need to do is define version (actually already defined in properties file) and use this in the task like:

springVersion=3.0.6.RELEASE

task extraStuff{
    doStuff 'org.springframework:spring-web:${springVersion}@war'
}

My problem is spring version is not recognised as variable. So how can I pass it inside the string?

Don't forget, you can break it out as well: doStuff group: 'org.springframework', name: 'spring-web', version: ${springVersion}, ext: 'war' — Jesse Chisholm
– Jesse Chisholm, Commented Feb 7, 2017 at 21:41
Don't forget, you can remove the parenthesis {} from ${spingVersion} as well: doStuff group: 'org.springframework', name: 'spring-web', version: $springVersion, ext: 'war' — HendraWD
– HendraWD, Commented Jun 8, 2018 at 3:37

hzitoun · Accepted Answer · 2022-12-28 15:03:23Z

109

If you're developing an Android application using Gradle, you can declare a variable (i.e holding a dependency version) thanks to the keyword def like below:

def version = '1.2'
    
dependencies {
  compile "groupId:artifactId:${version}"
}

edited Dec 28, 2022 at 15:03

answered Nov 13, 2017 at 16:15

hzitoun

5,8702 gold badges40 silver badges44 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Giuseppe Ricupero · Accepted Answer · 2016-01-08 11:35:18Z

57

I think the problem may lay on string literal delimiters:

The string literals are defined exactly as in groovy so enclose it in single or double quotes (e.g. "3.0.6.RELEASE");
Gstrings are not parsed in single quotes strings (both single '...' or triple '''...''' ones) if i recall correctly;

So the code will be:

springVersion = '3.0.6.RELEASE' //or with double quotes "..."

task extraStuff{
    doStuff "org.springframework:spring-web:${springVersion}@war"
}

answered Jan 8, 2016 at 11:35

Giuseppe Ricupero

6,3023 gold badges27 silver badges34 bronze badges

1 Comment

UTF_or_Death Over a year ago

True. Changing from single to double quotes fixed my problem

Kebab Krabby · Accepted Answer · 2019-07-10 11:16:18Z

On android there are actually 2 possibilities how to achieve this. It really depends which suits your needs. Those two possibilities have their pros and cons. You can use def variable or ext{} block. Variable def is awesome because it lets you click on the variable and points exactly where it is defined in the file compared to ext{} block which does NOT points to that exact variable. On the other hand ext{} has one good advantage and that is you can refer variables from project_name/build.gradle to project_name/app/build.gradle which in some cases is very useful BUT as I said if you click on that variable lets say only inside only one file it wont points out to the definition of that variable which is very bad because it takes you more search time if your dependency list grows.

1) def option which is propably best and saves you search time.

def lifecycle = '2.0.0'

dependencies {
    implementation 'androidx.lifecycle:lifecycle-extensions:$lifecycle'
}

2) second ext{} block. Its kinda ok if dependency list is not huge.

ext {
    lifecycle = '1.1.1'
}

dependencies {
    implementation 'androidx.lifecycle:lifecycle-extensions:$lifecycle'
}

3) In some cases if you want to share variables between project_name/build.gradle and project_name/app/build.gradle use ext{}

in project_name/build.gradle you define kotlin_shared_variable:

buildscript {
    ext.kotlin_shared_variable = '1.3.41'

    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_shared_variable"
    }
}

which you can use in project_name/app/build.gradle

dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_shared_variable"
}

and of course you can combine them.

So, the ext{} option works, but I cannot override that property using the -Plifecycle=2.0.0 command-line flag. The only way I've seen to do this is by providing the property in gradle.properties. Is that the recommended way of doing that?

drferpa · Accepted Answer · 2023-02-02 01:05:00Z

1

You can also define variables in the gradle.properties file at the root of your project. You don't have to use double quotes in that file. You would need to add the following line:

lifecycle=2.0.0

answered Feb 2, 2023 at 1:05

drferpa

362 bronze badges

1 Comment

prayagupadhyay Over a year ago

the ext { } approach did not work for me however this one did. so 1 vote to Doctor

Andy · Accepted Answer · 2021-09-06 07:36:41Z

0

see here.

Double-quoted strings are plain java.lang.String if there’s no interpolated expression, but are groovy.lang.GString instances if interpolation is present.

Gradle uses Groovy as a DSL. Here "${springVersion}" is a placeholder, what you want is to interpolate, so you should use the double quote, only the double quote in GString has the capability to interpolate.

edited Sep 6, 2021 at 7:36

answered Sep 6, 2021 at 5:55

Andy

774 bronze badges

Collectives™ on Stack Overflow

Using variables in Gradle build script

5 Answers 5

Comments

1 Comment

1 Comment

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

Comments

1 Comment

1 Comment

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related