Safe Args

एक डेस्टिनेशन से दूसरे डेस्टिनेशन पर जाने के लिए, Safe Args Gradle प्लग इन का इस्तेमाल करने का सुझाव दिया जाता है. यह प्लग इन, ऑब्जेक्ट और बिल्डर क्लास जनरेट करता है. इनसे डेस्टिनेशन के बीच टाइप-सेफ़ नेविगेशन की सुविधा मिलती है. नेविगेट करने और डेस्टिनेशन के बीच डेटा पास करने के लिए, Safe Args का इस्तेमाल करें.

Safe Args चालू करना

अपने प्रोजेक्ट में Safe Args जोड़ने के लिए, सबसे ऊपर के लेवल की build.gradle फ़ाइल में यह classpath शामिल करें:

Groovy

buildscript {
    repositories {
        google()
    }
    dependencies {
        def nav_version = "2.10.2"
        classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"
    }
}

Kotlin

buildscript {
    repositories {
        google()
    }
    dependencies {
        val nav_version = "2.10.2"
        classpath("androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version")
    }
}

आपको उपलब्ध दो प्लगिन में से किसी एक को भी लागू करना होगा.

Java या Java और Kotlin के मिक्स मॉड्यूल के लिए, Java भाषा का कोड जनरेट करने के लिए, अपने ऐप्लिकेशन या मॉड्यूल की build.gradle फ़ाइल में यह लाइन जोड़ें:

Groovy

plugins {
  id 'androidx.navigation.safeargs'
}

Kotlin

plugins {
    id("androidx.navigation.safeargs")
}

इसके अलावा, सिर्फ़ Kotlin मॉड्यूल के लिए सही Kotlin कोड जनरेट करने के लिए, यह जोड़ें:

Groovy

plugins {
  id 'androidx.navigation.safeargs.kotlin'
}

Kotlin

plugins {
    id("androidx.navigation.safeargs.kotlin")
}

AndroidX पर माइग्रेट करने के मुताबिक, आपकी gradle.properties फ़ाइल में android.useAndroidX=true होना चाहिए.

जनरेट किया गया कोड

Safe Args को चालू करने के बाद, जनरेट किए गए कोड में आपके तय किए गए हर ऐक्शन के लिए क्लास और तरीके शामिल होते हैं. साथ ही, इसमें हर भेजने और पाने वाले डेस्टिनेशन के लिए क्लास भी शामिल होती हैं.

Safe Args, हर उस डेस्टिनेशन के लिए एक क्लास जनरेट करता है जहां से कोई कार्रवाई शुरू होती है. जनरेट किए गए क्लास के नाम में, ओरिजिनेटिंग डेस्टिनेशन क्लास के नाम में "Directions" जुड़ जाता है. उदाहरण के लिए, अगर ओरिजिनेटिंग डेस्टिनेशन का नाम SpecifyAmountFragment है, तो जनरेट की गई क्लास का नाम SpecifyAmountFragmentDirections होगा.

जनरेट की गई क्लास में, ओरिजिनेटिंग डेस्टिनेशन में तय की गई हर कार्रवाई के लिए एक स्टैटिक तरीका होता है. यह तरीका, तय किए गए किसी भी ऐक्शन पैरामीटर को आर्ग्युमेंट के तौर पर लेता है और NavDirections ऑब्जेक्ट दिखाता है. इसे सीधे navigate() को पास किया जा सकता है.

Safe Args का उदाहरण

उदाहरण के लिए, एक ऐसा नेविगेशन ग्राफ़ देखें जिसमें एक ही कार्रवाई से दो डेस्टिनेशन, SpecifyAmountFragment और ConfirmationFragment को कनेक्ट किया गया हो. ConfirmationFragment, एक float पैरामीटर लेता है, जिसे कार्रवाई के हिस्से के तौर पर दिया जाता है.

Safe Args, SpecifyAmountFragmentDirections क्लास जनरेट करता है. इसमें एक तरीका, actionSpecifyAmountFragmentToConfirmationFragment() और एक इनर क्लास होती है, जिसे ActionSpecifyAmountFragmentToConfirmationFragment कहा जाता है. इनर क्लास को NavDirections से लिया जाता है. साथ ही, यह उससे जुड़े कार्रवाई के आईडी और float पैरामीटर को सेव करती है. इसके बाद, दिखाए गए NavDirections ऑब्जेक्ट को सीधे navigate() को पास किया जा सकता है, जैसा कि इस उदाहरण में दिखाया गया है:

Kotlin

override fun onClick(v: View) {
    val amount: Float = ...
    val action =
        SpecifyAmountFragmentDirections
            .actionSpecifyAmountFragmentToConfirmationFragment(amount)
    v.findNavController().navigate(action)
}

Java

@Override
public void onClick(View view) {
    float amount = ...;
    action =
        SpecifyAmountFragmentDirections
            .actionSpecifyAmountFragmentToConfirmationFragment(amount);
    Navigation.findNavController(view).navigate(action);
}

Safe Args की मदद से, डेस्टिनेशन के बीच डेटा पास करने के बारे में ज़्यादा जानने के लिए, टाइप सेफ़्टी के साथ डेटा पास करने के लिए Safe Args का इस्तेमाल करना लेख पढ़ें.

Safe Args का इस्तेमाल करके, टाइप सेफ़्टी को पक्का करना

Safe Args Gradle प्लग इन का इस्तेमाल करके, एक डेस्टिनेशन से दूसरे डेस्टिनेशन पर नेविगेट करना. यह प्लगिन, आसान ऑब्जेक्ट और बिल्डर क्लास जनरेट करता है. इनसे टाइप-सेफ़ नेविगेशन और डेस्टिनेशन के बीच आर्ग्युमेंट पास करने की सुविधा मिलती है.

अपने प्रोजेक्ट में Safe Args जोड़ने के लिए, सबसे ऊपर के लेवल की build.gradle फ़ाइल में यह classpath शामिल करें:

Groovy

buildscript {
    repositories {
        google()
    }
    dependencies {
        def nav_version = "2.10.2"
        classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"
    }
}

Kotlin

buildscript {
    repositories {
        google()
    }
    dependencies {
        val nav_version = "2.10.2"
        classpath("androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version")
    }
}

आपको उपलब्ध दो प्लगिन में से किसी एक को भी लागू करना होगा.

Java या Java और Kotlin के मिक्स मॉड्यूल के लिए, Java भाषा का कोड जनरेट करने के लिए, अपने ऐप्लिकेशन या मॉड्यूल की build.gradle फ़ाइल में यह लाइन जोड़ें:

Groovy

plugins {
  id 'androidx.navigation.safeargs'
}

Kotlin

plugins {
    id("androidx.navigation.safeargs")
}

इसके अलावा, सिर्फ़ Kotlin मॉड्यूल के लिए सही Kotlin कोड जनरेट करने के लिए, यह जोड़ें:

Groovy

plugins {
  id 'androidx.navigation.safeargs.kotlin'
}

Kotlin

plugins {
    id("androidx.navigation.safeargs.kotlin")
}

AndroidX पर माइग्रेट करने के मुताबिक, आपकी gradle.properties फ़ाइल में android.useAndroidX=true होना चाहिए.

Safe Args को चालू करने के बाद, प्लग इन एक कोड जनरेट करता है. इसमें आपके तय किए गए हर ऐक्शन के लिए क्लास और तरीके शामिल होते हैं. हर कार्रवाई के लिए, Safe Args हर ओरिजिनेटिंग डेस्टिनेशन के लिए भी एक क्लास जनरेट करता है. यह वह डेस्टिनेशन होता है जहां से कार्रवाई शुरू होती है. जनरेट की गई क्लास का नाम, डेस्टिनेशन क्लास के नाम और "Directions" शब्द को मिलाकर बनता है. उदाहरण के लिए, अगर डेस्टिनेशन का नाम SpecifyAmountFragment है, तो जनरेट की गई क्लास का नाम SpecifyAmountFragmentDirections होगा. जनरेट की गई क्लास में, ऑरिजिन डेस्टिनेशन में तय की गई हर कार्रवाई के लिए एक स्टैटिक तरीका होता है. यह तरीका, तय किए गए किसी भी ऐक्शन पैरामीटर को आर्ग्युमेंट के तौर पर लेता है और NavDirections ऑब्जेक्ट दिखाता है. इसे navigate() को पास किया जा सकता है.

उदाहरण के लिए, मान लें कि हमारे पास एक नेविगेशन ग्राफ़ है, जिसमें एक ही कार्रवाई है. यह कार्रवाई, शुरुआती डेस्टिनेशन SpecifyAmountFragment को, मिलने वाले डेस्टिनेशन ConfirmationFragment से कनेक्ट करती है.

Safe Args, एक ही तरीके actionSpecifyAmountFragmentToConfirmationFragment() वाली SpecifyAmountFragmentDirections क्लास जनरेट करता है. यह तरीका, NavDirections ऑब्जेक्ट दिखाता है. इसके बाद, इस NavDirections ऑब्जेक्ट को सीधे navigate() में पास किया जा सकता है, जैसा कि इस उदाहरण में दिखाया गया है:

Kotlin

override fun onClick(view: View) {
    val action =
        SpecifyAmountFragmentDirections
            .actionSpecifyAmountFragmentToConfirmationFragment()
    view.findNavController().navigate(action)
}

Java

@Override
public void onClick(View view) {
    NavDirections action =
        SpecifyAmountFragmentDirections
            .actionSpecifyAmountFragmentToConfirmationFragment();
    Navigation.findNavController(view).navigate(action);
}

Safe Args की मदद से, डेस्टिनेशन के बीच डेटा भेजने के बारे में ज़्यादा जानने के लिए, डेस्टिनेशन के बीच डेटा भेजना में जाकर, टाइप सेफ़्टी के साथ डेटा भेजने के लिए Safe Args का इस्तेमाल करना लेख पढ़ें.