How do I define a variable for the dependency version in Gradle

When managing project dependencies in Gradle, defining and using variables to specify dependency versions is a common practice that enhances the maintainability and reusability of the project. Here are the steps to define and use dependency version variables in Gradle:

Step 1: Define version variables in the build.gradle file at the root of the project

You can define variables in the ext block of the build.gradle file. For example, if you want to define version numbers for Spring Boot and Lombok, you can do the following:

groovy
ext {
    springBootVersion = '2.3.1.RELEASE'
    lombokVersion = '1.18.12'
}

Here, the ext block is used to define properties at the project level (here, version variables).

Step 2: Use these variables to specify dependency versions

After defining the version variables, you can use them in your dependency declarations. For example:

groovy
dependencies {
    implementation "org.springframework.boot:spring-boot-starter-web:${springBootVersion}"
    compileOnly "org.projectlombok:lombok:${lombokVersion}"
}

This approach ensures that updating dependency versions requires only modifying the version numbers in the ext block, eliminating the need to search and replace hardcoded version numbers across multiple files.

Example: Using version variables in multi-module projects

In multi-module projects, version variables are typically defined in the root project's build.gradle file and used in the submodules. For example:

Root project's build.gradle:

groovy
ext {
    junitVersion = '5.7.0'
}

subprojects {
    apply plugin: 'java'

    dependencies {
        testImplementation "org.junit.jupiter:junit-jupiter:${junitVersion}"
    }
}

This way, all subprojects use the JUnit version defined in the root project to configure their dependencies.

Summary

Using variables to manage dependency versions makes Gradle projects more organized and easier to maintain. Especially in multi-module projects or when frequently updating dependency versions, this method significantly reduces maintenance overhead.