फ़्यूज़ की गई लाइब्रेरी की मदद से, एक से ज़्यादा Android लाइब्रेरी को एक साथ पब्लिश करना

कई मॉड्यूल वाले प्रोजेक्ट में, उपयोगकर्ताओं को Android लाइब्रेरी उपलब्ध कराना मुश्किल हो सकता है. ऐसा तब होता है, जब प्रोजेक्ट के स्ट्रक्चर को साफ़ तौर पर बनाए रखने की कोशिश की जा रही हो. कई मामलों में, तय की गई संख्या से ज़्यादा लाइब्रेरी पब्लिश करनी पड़ती हैं.

Android Gradle प्लगिन के साथ बंडल किया गया Fused Library प्लगिन, कई Android लाइब्रेरी मॉड्यूल को एक पब्लिश की जा सकने वाली Android लाइब्रेरी में पैकेज करने में मदद करता है. इससे आपको अपनी लाइब्रेरी के सोर्स कोड और संसाधनों को अपने बिल्ड में ज़रूरत के हिसाब से मॉड्यूलर बनाने में मदद मिलती है. साथ ही, डिस्ट्रिब्यूट होने के बाद आपके प्रोजेक्ट का स्ट्रक्चर एक्सपोज़ नहीं होता.

एक ही लाइब्रेरी के तौर पर डिस्ट्रिब्यूट करने के ये फ़ायदे हो सकते हैं:

  • आसान डिपेंडेंसी: यह कई लाइब्रेरी डिपेंडेंसी को एक एएआर से बदल देता है. इससे आपके उपयोगकर्ताओं के लिए, प्रोजेक्ट सेटअप और वर्शन मैनेजमेंट की प्रोसेस आसान हो जाती है
  • लाइब्रेरी का साइज़ कम करना: इससे कोड को छोटा करने में मदद मिल सकती है. इससे एएआर का साइज़ छोटा हो जाता है
  • बेहतर सुरक्षा: पब्लिश की गई लाइब्रेरी के इंटरनल इंप्लिमेंटेशन की जानकारी पर बेहतर कंट्रोल मिलता है

फ़्यूज़्ड लाइब्रेरी बनाना

फ़्यूज़्ड लाइब्रेरी बनाने के लिए, आपको एक नया Android मॉड्यूल बनाना होगा, डिपेंडेंसी जोड़नी होंगी, और फिर फ़्यूज़्ड लाइब्रेरी को पब्लिश करना होगा.

ज़रूरी शर्तें

Fused Library प्लगिन का इस्तेमाल करने के लिए, एजीपी 9.0 या इसके बाद के वर्शन का इस्तेमाल करें. Fused Library प्लगिन के पिछले वर्शन में अलग-अलग तरह के व्यवहार और समस्याएं हैं. इन्हें AGP 9.0 में ठीक किया गया है.

नया फ़्यूज़्ड लाइब्रेरी मॉड्यूल जोड़ना

प्लगिन का इस्तेमाल करने के लिए, आपको अपने प्रोजेक्ट में एक नया Android मॉड्यूल जोड़ना होगा:

इस उदाहरण में, फ़्यूज़्ड लाइब्रेरी मॉड्यूल को myFusedLibrary कहा जाएगा.

  1. include(":myFusedLibrary") को settings.gradle.kts फ़ाइल में जोड़ें.
  2. gradle/libs.versions.toml फ़ाइल में, [plugins] सेक्शन के नीचे android-fusedlibrary = { id = "com.android.fused-library", version.ref = "agp" } जोड़ें.
  3. टॉप लेवल की build.gradle.kts फ़ाइल में, प्लगिन ब्लॉक में alias(libs.plugins.android.fusedlibrary) apply false जोड़ें.
  4. myFusedLibrary मॉड्यूल बनाने के लिए, myFusedLibrary नाम की एक नई डायरेक्ट्री बनाएं. इसके लिए, 'My Application' पर राइट क्लिक करें > New > Directory पर जाएं.
  5. myFusedLibrary मॉड्यूल में build.gradle.kts फ़ाइल बनाएं (myFusedLibrary मॉड्यूल पर राइट क्लिक करें > New > File).
  6. इसे myFusedLibrary/build.gradle.kts फ़ाइल में चिपकाएं:

Kotlin

plugins {
    alias(libs.plugins.android.fusedlibrary)
    `maven-publish`
}

androidFusedLibrary {
    namespace = "com.example.myFusedLibrary"
    minSdk = 21
}

dependencies { }

Groovy

plugins {
    id 'com.android.fused-library'
}

androidFusedLibrary {
    namespace 'com.example.myFusedLibrary'
    minSdk 21
}

dependencies {

}

डिपेंडेंसी जोड़ें

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

उदाहरण के लिए:

Kotlin

dependencies {
    include(project(":image-rendering"))
    include("mycoolfonts:font-wingdings:5.0")
}

Groovy

dependencies {
    include project(':image-rendering')
    include 'mycoolfonts:font-wingdings:5.0'
}

फ़्यूज़ की गई लाइब्रेरी पब्लिश करना

फ़्यूज़्ड लाइब्रेरी पब्लिश करने से पहले, आपको Android लाइब्रेरी पब्लिश करने के बारे में जानकारी होनी चाहिए. फ़्यूज़्ड लाइब्रेरी को पब्लिश करने का तरीका, Android लाइब्रेरी को पब्लिश करने के तरीके जैसा ही है. हालांकि, फ़्यूज़्ड लाइब्रेरी को सही तरीके से पब्लिश करने के लिए, आपको कुछ अहम अंतरों को ध्यान में रखना होगा:

  • मेवन पब्लिश प्लगिन को ऐसे किसी भी मॉड्यूल पर लागू करना ज़रूरी है जिसमें फ़्यूज़्ड लाइब्रेरी प्लगिन लागू किया गया हो.
  • पब्लिकेशन को fusedLibraryComponent से इनहेरिट करना चाहिए, क्योंकि इससे फ़्यूज़्ड लाइब्रेरी आर्टफ़ैक्ट को कंपाइल करने के लिए ज़रूरी डिपेंडेंसी मिलती हैं.

यहां पब्लिकेशन के कॉन्फ़िगरेशन का एक उदाहरण दिया गया है:

Kotlin

plugins {
    alias(libs.plugins.android.fusedlibrary)
    `maven-publish`
}

androidFusedLibrary { … }

dependencies { … }

publishing {
    publications {
        register<MavenPublication>("release") {
             groupId = "my-company"
             artifactId = "my-fused-library"
             version = "1.0"
             from(components["fusedLibraryComponent"])
        }
    }
}

Groovy

plugins {
    id 'com.android.fused-library'
    id 'maven-publish'
}

androidFusedLibrary { … }

dependencies { … }

publishing {
    publications {
        release(MavenPublication) {
            groupId = "my-company"
            artifactId = "my-fused-library"
            version = "1.0"
            afterEvaluate {
            from components.fusedLibraryComponent
        }
    }
}

टेस्टिंग के लिए, फ़्यूज़्ड लाइब्रेरी पब्लिश करना

आपको Android ऐप्लिकेशन या Android लाइब्रेरी से पब्लिश की गई फ़्यूज़्ड लाइब्रेरी के आधार पर टेस्ट करना चाहिए. हमारा सुझाव है कि फ़्यूज़्ड लाइब्रेरी और उसकी प्रोजेक्ट डिपेंडेंसी को किसी लोकल Maven रिपॉज़िटरी में पब्लिश करें.

फ़्यूज़ की गई लाइब्रेरी के आर्टफ़ैक्ट को किसी लोकल रिपॉज़िटरी में पब्लिश करने के लिए, यहां दिए गए कॉन्फ़िगरेशन जैसा कॉन्फ़िगरेशन तय करें:

Kotlin

plugins {
    alias(libs.plugins.android.fusedlibrary)
    `maven-publish`
}

repositories {
    maven {
        name = "myLocalRepo"
        url = uri(layout.buildDirectory.dir("myLocalRepo"))
    }
}

Groovy

plugins {
    id 'com.android.fused-library'
    id 'maven-publish'
}

repositories {
    maven {
        name 'myLocalRepo'
        url layout.buildDirectory.dir('myLocalRepo')
    }
}

फ़्यूज़ की गई लाइब्रेरी अपलोड करना

फ़्यूज़ की गई लाइब्रेरी को डिस्ट्रिब्यूट करने के लिए, अपनी लाइब्रेरी अपलोड करना लेख पढ़ें.

व्यवहार और सुरक्षा के उपाय

Android लाइब्रेरी को जोड़ने में कई जटिलताएं होती हैं. इस वजह से, प्लग इन के लिए प्राथमिकताओं को तय करना मुश्किल हो सकता है. उदाहरण के लिए, एक ही क्लासपाथ वाली दो लाइब्रेरी को फ़्यूज़ करने पर, बिल्ड फ़ेल हो जाएगा. संसाधनों को मर्ज करते समय, अलग-अलग लाइब्रेरी में एक ही नाम वाले संसाधन को चुनते समय, तय की गई डिपेंडेंसी के क्रम को ध्यान में रखा जाएगा.

  • फ़्यूज़्ड लाइब्रेरी को सिर्फ़ Android लाइब्रेरी आर्टफ़ैक्ट एएआर के तौर पर पब्लिश किया जा सकता है, ताकि उन्हें डिपेंडेंसी के तौर पर जोड़ा जा सके.
  • डेटा बाइंडिंग का इस्तेमाल करने वाली लाइब्रेरी को फ़्यूज़ नहीं किया जा सकता.
  • एक फ़्यूज़्ड लाइब्रेरी में, कई बिल्ड टाइप और ऐप्लिकेशन टाइप को फ़्यूज़ नहीं किया जा सकता. अलग-अलग वैरिएंट के लिए, अलग-अलग फ़्यूज़्ड लाइब्रेरी बनाएं.

कॉन्फ़िगरेशन की ज़रूरत और इस्तेमाल में आसानी के बीच संतुलन बनाने के लिए, प्लगिन आर्टफ़ैक्ट को फ़्यूज़ करते समय, अस्पष्ट विरोधों पर बिल्ड को फ़ेल कर देगा या ह्यूरिस्टिक का इस्तेमाल करेगा. आर्टफ़ैक्ट को फ़्यूज़ करने के तरीके की जानकारी, इस टेबल में दी गई है:

प्रकार व्यवहार
कक्षाएं एक ही क्लासपाथ वाली लाइब्रेरी को फ़्यूज़ करने पर, बिल्ड फ़ेल हो जाएगा.
Android संसाधन संसाधनों को मर्ज करते समय, डिपेंडेंसी के क्रम को ध्यान में रखा जाएगा. ऐसा तब होगा, जब अलग-अलग जगहों पर एक ही नाम वाले संसाधन को चुना जाएगा.
AAR मेटाडेटा AAR मेटाडेटा के वर्शन को मर्ज करने के लिए, हर डिपेंडेंसी लाइब्रेरी की सबसे ज़्यादा वैल्यू को प्राथमिकता दी जाती है. इन वैल्यू को बदलने के लिए, एक डीएसएल दिया गया है.

Kotlin

 androidFusedLibrary { aarMetadata { minCompileSdk = 21 minCompileSdkExtension = 1 } }
Java के संसाधन एक जैसे पाथ वाली कई लाइब्रेरी में Java रिसॉर्स फ़ाइलों की अनुमति नहीं है. ऐसा करने पर, बिल्ड फ़ेल हो जाएगा.

पहले से मालूम समस्याएं

Fused Library एक नया प्लगिन है. इसमें कुछ ऐसी समस्याएं हैं जिनके बारे में हमें पहले से पता है. हम इन समस्याओं को ठीक करने के लिए काम कर रहे हैं, ताकि सभी इस्तेमाल के उदाहरणों को पूरा किया जा सके. अगर आपको कोई समस्या आती है, तो बग की शिकायत की जा सकती है.

  • समस्या #454305444: ऐसी लाइब्रेरी जिनमें उपभोक्ता के लिए ProGuard नियम शामिल हैं और जिन्हें 'proguard.txt' नहीं कहा जाता है उनकी वजह से बिल्ड फ़ेल हो जाता है. AGP 9.1 और इसके बाद के वर्शन में ठीक किया गया.
  • समस्या #374982739: अन्य .aar फ़ाइलों पर फ़ाइल डिपेंडेंसी जोड़ना
  • समस्या #231433225: RenderScript और Prefab आर्टफ़ैक्ट को फ़्यूज़ करने की सुविधा उपलब्ध नहीं है

फ़्यूज़्ड लाइब्रेरी की डिपेंडेंसी समझना

फ़्यूज़्ड लाइब्रेरी का कोई सोर्स नहीं होता. यह Android लाइब्रेरी को ही अपने सोर्स के तौर पर इस्तेमाल करती है. इसलिए, यह समझना ज़रूरी है कि कौनसा डेटा कहां से आता है. नतीजे के तौर पर मिले आर्टफ़ैक्ट में मर्ज की गई डिपेंडेंसी और आर्टफ़ैक्ट बनाने के लिए ज़रूरी डिपेंडेंसी की सूची बनाने के लिए, फ़्यूज़ की गई लाइब्रेरी पर gradle :report टास्क चलाएं. टास्क, JSON रिपोर्ट जनरेट करता है. यह रिपोर्ट, फ़्यूज़्ड लाइब्रेरी की build/reports डायरेक्ट्री में सेव होती है.

इंटरनल प्लगिन डिपेंडेंसी से जुड़ी ज़्यादा जानकारी के लिए, gradle :dependencies टास्क चलाएं. इससे प्लगिन कॉन्फ़िगरेशन की स्थिति देखी जा सकती है.