अपने बिल्ड को वर्शन कैटलॉग पर माइग्रेट करें

Gradle वर्शन कैटलॉग की मदद से, डिपेंडेंसी और प्लगिन को आसानी से जोड़ा और मैनेज किया जा सकता है. Gradle वर्शन कैटलॉग का इस्तेमाल करने से, एक से ज़्यादा मॉड्यूल होने पर डिपेंडेंसी और प्लग इन को मैनेज करना आसान हो जाता है. अलग-अलग बिल्ड फ़ाइलों में डिपेंडेंसी के नाम और वर्शन को हार्डकोड करने और डिपेंडेंसी को अपग्रेड करने के लिए हर एंट्री को अपडेट करने के बजाय, डिपेंडेंसी का एक मुख्य वर्शन कैटलॉग बनाया जा सकता है. Android Studio की मदद से, अलग-अलग मॉड्यूल इस कैटलॉग को टाइप-सेफ़ तरीके से रेफ़र कर सकते हैं.

इस पेज पर, अपने Android ऐप्लिकेशन को वर्शन कैटलॉग पर माइग्रेट करने के बारे में बुनियादी जानकारी दी गई है. ज़्यादा जानने के लिए, बिल्ड डिपेंडेंसी जोड़ना और Gradle का दस्तावेज़ देखें.

वर्शन कैटलॉग फ़ाइल बनाना

वर्शन कैटलॉग फ़ाइल बनाकर शुरुआत करें. अपने रूट प्रोजेक्ट के gradle फ़ोल्डर में, libs.versions.toml नाम की एक फ़ाइल बनाएं. Gradle, libs.versions.toml फ़ाइल में कैटलॉग को डिफ़ॉल्ट रूप से खोजता है. इसलिए, हमारा सुझाव है कि आप इस डिफ़ॉल्ट नाम का इस्तेमाल करें.

अपनी libs.versions.toml फ़ाइल में ये सेक्शन जोड़ें:

[versions]

[libraries]

[plugins]

सेक्शन का इस्तेमाल इस तरह किया जाता है:

  • versions ब्लॉक में, ऐसे वैरिएबल तय करें जिनमें आपकी डिपेंडेंसी और प्लग इन के वर्शन शामिल हों. इन वैरिएबल का इस्तेमाल, बाद के ब्लॉक (libraries और plugins ब्लॉक) में किया जाता है.
  • libraries ब्लॉक में, अपनी डिपेंडेंसी तय करें.
  • plugins ब्लॉक में, अपने प्लग इन तय करें.

माइग्रेशन के चरण

हमारा सुझाव है कि आप यहां दिए गए क्रम में ही ये चरण पूरे करें. कोई बिल्ड, बिल्ड स्क्रिप्ट और कैटलॉग से डिपेंडेंसी और प्लग इन का इस्तेमाल एक साथ कर सकता है. इसलिए, अपनी डिपेंडेंसी और प्लग इन को अलग-अलग माइग्रेट करने के लिए समय लें.

माइग्रेशन की प्रोसेस इस तरह है:

  1. कैटलॉग में नई एंट्री जोड़ें.
  2. अपने Android प्रोजेक्ट को सिंक करें.
  3. पिछली स्ट्रिंग डिक्लेरेशन को कैटलॉग टाइप-सेफ़ ऐक्सेसर से बदलें.

डिपेंडेंसी माइग्रेट करना

libs.versions.toml फ़ाइल के versions और libraries, दोनों सेक्शन में हर डिपेंडेंसी के लिए एक एंट्री जोड़ें. अपने प्रोजेक्ट को सिंक करें. इसके बाद, बिल्ड फ़ाइलों में उनके डिक्लेरेशन को उनके कैटलॉग के नामों से बदलें.

इस कोड स्निपेट में, डिपेंडेंसी हटाने से पहले की build.gradle.kts फ़ाइल दिखती है:

Kotlin

dependencies {
    implementation("androidx.core:core-ktx:1.9.0")

}

Groovy

dependencies {
    implementation 'androidx.core:core-ktx:1.9.0'

}

इस कोड स्निपेट में, वर्शन कैटलॉग फ़ाइल में डिपेंडेंसी तय करने का तरीका बताया गया है:

[versions]
ktx = "1.9.0"

[libraries]
androidx-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "ktx" }

कैटलॉग में डिपेंडेंसी ब्लॉक के लिए, डैश-केस (जैसे कि androidx-ktx) का इस्तेमाल करने का सुझाव दिया जाता है. इससे आपकी बिल्ड फ़ाइलों में कोड पूरा करने में मदद मिलती है.

डिपेंडेंसी की ज़रूरत वाले हर मॉड्यूल की build.gradle.kts फ़ाइल में, डिपेंडेंसी को उन नामों से तय करें जो आपने TOML फ़ाइल में तय किए हैं.

Kotlin

dependencies {
   implementation(libs.androidx.ktx)

}

Groovy

dependencies {
   implementation libs.androidx.ktx

}

प्लग इन माइग्रेट करना

libs.versions.toml फ़ाइल के वर्शन और प्लग इन, दोनों सेक्शन में हर प्लग इन के लिए एक एंट्री जोड़ें. अपने प्रोजेक्ट को सिंक करें. इसके बाद, बिल्ड फ़ाइलों में plugins{} ब्लॉक में मौजूद उनके डिक्लेरेशन को कैटलॉग में मौजूद उनके नामों से बदलें.

इस कोड स्निपेट में, प्लगिन को हटाने से पहले की build.gradle.kts फ़ाइल दिखती है:

Kotlin

// Top-level `build.gradle.kts` file
plugins {
   id("com.android.application") version "7.4.1" apply false

}

// Module-level `build.gradle.kts` file
plugins {
   id("com.android.application")

}

Groovy

// Top-level `build.gradle` file
plugins {
   id 'com.android.application' version '7.4.1' apply false

}

// Module-level `build.gradle` file
plugins {
   id 'com.android.application'

}

इस कोड स्निपेट से पता चलता है कि वर्शन कैटलॉग फ़ाइल में प्लगिन को कैसे तय किया जाता है:

[versions]
androidGradlePlugin = "7.4.1"

[plugins]
android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }

डिपेंडेंसी की तरह ही, plugins ब्लॉक कैटलॉग एंट्री के लिए डैश-केस (जैसे, android-application) फ़ॉर्मैट का सुझाव दिया जाता है. इससे आपकी बिल्ड फ़ाइलों में कोड पूरा करने में मदद मिलती है.

यहां दिए गए कोड से पता चलता है कि टॉप और मॉड्यूल लेवल की build.gradle.kts फ़ाइलों में, com.android.application प्लग इन को कैसे तय किया जाता है. वर्शन कैटलॉग फ़ाइल से मिलने वाले प्लगिन के लिए alias का इस्तेमाल करें. साथ ही, वर्शन कैटलॉग फ़ाइल से न मिलने वाले प्लगिन के लिए id का इस्तेमाल करें. जैसे, कन्वेंशन प्लगिन.

Kotlin

// Top-level build.gradle.kts
plugins {
   alias(libs.plugins.android.application) apply false

}

// module build.gradle.kts
plugins {
   alias(libs.plugins.android.application)

}

Groovy

// Top-level build.gradle
plugins {
   alias libs.plugins.android.application apply false

}

// module build.gradle
plugins {
   alias libs.plugins.android.application

}

ज़्यादा जानें

वर्शन कैटलॉग को कॉन्फ़िगर करने के अन्य विकल्पों के बारे में जानने के लिए, ये संसाधन देखें: