Simplify your dependency administration with Gradle Model Catalog in Android | by Nirav Tukadiya | April 2023

Gradle is a construct automation software used to construct, take a look at, and deploy software program. The Gradle model catalog is a software that helps builders handle variations of their dependencies in a single place. On this weblog, we’ll discover what Gradle model classes are, why they’re necessary, and easy methods to use them in Android improvement with real-life examples.

Gradle model catalog is a characteristic launched in Gradle 7.0. The Gradle model catalog is a file that incorporates an inventory of variations for a selected dependency. The model catalog file is separate out of your construct.gradle file, and it incorporates solely model info. By utilizing the model catalog, you’ll be able to simply handle the variations of your dependencies in a single place.

Class model classes are necessary as a result of they help you handle variations of your dependencies in a single centralized location. This makes it simpler to handle dependencies throughout a number of initiatives as a result of you’ll be able to replace the model in a single place and replicate it throughout all of your initiatives. As well as, the model catalog makes it straightforward to make sure that all builders in a undertaking are utilizing the identical model of a selected dependency.

Utilizing the Gradle model catalog throughout Android improvement could be very easy. Here is easy methods to get began:

Step one is to create a model catalog file. You may create this file in any folder in your undertaking and you may title it something you want. For instance, you’ll be able to create a file named “variations.properties” within the root listing of your undertaking.

The contents of the model catalog file ought to seem like this:

# variations.properties
junit.jupiter.api=5.8.0-M1
junit.platform.commons=1.8.0-M1
junit.classic.engine=5.8.0-M1

Subsequent, you could configure your construct.gradle file to make use of the model catalog. Right here is an instance of how to do that:

dependencies {
testImplementation("org.junit.jupiter:junit-jupiter-api:${variations.junit.jupiter.api}")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
testImplementation("org.junit.platform:junit-platform-commons:${variations.junit.platform.commons}")
testRuntimeOnly("org.junit.classic:junit-vintage-engine:${variations.junit.classic.engine}")
}
repositories {
mavenCentral()
maven {
url "https://plugins.gradle.org/m2/"
}
}


dependencies {
//...


implementation(enforcedPlatform("com.google.android.gms:play-services-bom:${variations.playServices}"))
}


dependencies {
//...


implementation(enforcedPlatform("androidx.core:core-ktx:${variations.androidXCore}"))
}


dependencyResolutionManagement {
repositories {
google()
mavenCentral()
}
versionCatalogs {
create("variations") {
from("$rootDir/variations.properties")
}
}
}

This block of code does just a few issues:

1. It declares dependencies that ought to use the model catalog.
2. It units up the repositories that Gradle will use to search out dependencies.
3. It declares the model catalog and specifies the placement of the model catalog file.

As soon as you’ve got arrange the model catalog, you should utilize variations in your code. Here is an instance of easy methods to use variations in a take a look at class:

@Take a look at
enjoyable `confirm that model catalog works`() {
assertEquals("5.8.0-M1", Variations.junit.jupiter.api)
assertEquals("1.8.0-M1", Variations.junit.platform.commons)
assertEquals("5.8.0-M1", Variations.junit.classic.engine)
}

On this instance, we’re accessing variations of JUnit dependencies utilizing the Model object. The Model object is robotically generated by Gradle based mostly on the model catalog file.

The Gradle model catalog is a strong software for managing your variations of dependencies throughout Android improvement. By utilizing the model catalog you’ll be able to make sure that all builders in a undertaking are utilizing the identical model of a selected dependency and you may simply replace the model in a single place in all his initiatives. I hope this weblog helped you perceive what Gradle model classes are and easy methods to use them in Android improvement.

Learn extra:

1. Gradle documentation on model catalog: https://docs.gradle.org/present/userguide/platforms.html#sec:version-catalogs
2. Gradle launch notes for model 7.0: https://docs.gradle.org/7.0/release-notes.html#version-catalogs
3. Gradle Summit 2020 discusses versioning classes: https://www.youtube.com/watch?v=_Xq3cZrjvJM
4. Gradle weblog publish on versioning class: https://weblog.gradle.org/gradle-version-catalogs
5. The Gradle Neighborhood Discussion board discusses the versioning class: https://focus on.gradle.org/t/gradle-version-catalogs/37555

These assets can present readers with extra info and detailed explanations of the Gradle model classes, their makes use of, and advantages.