नेविगेशन की मदद से, किसी डेस्टिनेशन के लिए आर्ग्युमेंट तय करके, नेविगेशन ऑपरेशन में डेटा अटैच किया जा सकता है. उदाहरण के लिए, उपयोगकर्ता की प्रोफ़ाइल वाले डेस्टिनेशन को यूज़र आईडी आर्ग्युमेंट की ज़रूरत पड़ सकती है, ताकि यह तय किया जा सके कि किस उपयोगकर्ता की प्रोफ़ाइल दिखानी है.
आम तौर पर, आपको डेस्टिनेशन के बीच कम से कम डेटा पास करना चाहिए. उदाहरण के लिए, आपको किसी ऑब्जेक्ट को वापस पाने के लिए, ऑब्जेक्ट को पास करने के बजाय, एक कुंजी पास करनी चाहिए. ऐसा इसलिए, क्योंकि Android पर सेव की गई सभी स्थितियों के लिए कुल जगह सीमित होती है. अगर आपको ज़्यादा डेटा पास करना है, तो ViewModel की खास जानकारी में बताए गए तरीके के मुताबिक, ViewModel का इस्तेमाल करें.
डेस्टिनेशन के आर्ग्युमेंट के बारे में बताएं
डेस्टिनेशन के बीच डेटा पास करने के लिए, पहले आर्ग्युमेंट को तय करें. इसके लिए, उसे उस डेस्टिनेशन में जोड़ें जिसे डेटा मिलता है. इसके लिए, यह तरीका अपनाएं:
- नेविगेशन एडिटर में, उस डेस्टिनेशन पर क्लिक करें जिसे आर्ग्युमेंट मिलता है.
- एट्रिब्यूट पैनल में, जोड़ें (+) पर क्लिक करें.
- इसके बाद, Add Argument Link विंडो दिखेगी. इसमें आर्ग्युमेंट का नाम, आर्ग्युमेंट का टाइप, और आर्ग्युमेंट की डिफ़ॉल्ट वैल्यू डालें. साथ ही, यह भी बताएं कि आर्ग्युमेंट की वैल्यू शून्य हो सकती है या नहीं.
- जोड़ें पर क्लिक करें. ध्यान दें कि आर्ग्युमेंट अब एट्रिब्यूट पैनल में, आर्ग्युमेंट की सूची में दिखता है.
- इसके बाद, उस कार्रवाई पर क्लिक करें जो आपको इस डेस्टिनेशन पर ले जाती है. एट्रिब्यूट पैनल में, अब आपको आर्ग्युमेंट की डिफ़ॉल्ट वैल्यू सेक्शन में, जोड़ा गया नया आर्ग्युमेंट दिखेगा.
यह भी देखा जा सकता है कि आर्ग्युमेंट को एक्सएमएल में जोड़ा गया है. एक्सएमएल व्यू पर टॉगल करने के लिए, टेक्स्ट टैब पर क्लिक करें. इसके बाद, देखें कि आपका आर्ग्युमेंट, आर्ग्युमेंट पाने वाले डेस्टिनेशन में जोड़ा गया है या नहीं. यहां एक उदाहरण दिया गया है:
<fragment android:id="@+id/myFragment" > <argument android:name="myArg" app:argType="integer" android:defaultValue="0" /> </fragment>
आर्ग्युमेंट के वे टाइप जो इसके साथ काम करते हैं
नेविगेशन लाइब्रेरी में, इस तरह के आर्ग्युमेंट इस्तेमाल किए जा सकते हैं:
| प्रकार | app:argType सिंटैक्स | डिफ़ॉल्ट वैल्यू के लिए सहायता | रास्तों के हिसाब से मैनेज किया जाता है | Nullable |
|---|---|---|---|---|
| पूर्णांक | app:argType="integer" | हां | हां | नहीं |
| फ़्लोट | app:argType="float" | हां | हां | नहीं |
| लंबा | app:argType="long" | हां - डिफ़ॉल्ट वैल्यू हमेशा 'L' सफ़िक्स के साथ खत्म होनी चाहिए (उदाहरण के लिए, "123L"). | हां | नहीं |
| बूलियन | app:argType="boolean" | हां - "true" या "false" | हां | नहीं |
| स्ट्रिंग | app:argType="string" | हां | हां | हां |
| Resource Reference | app:argType="reference" | हां - डिफ़ॉल्ट वैल्यू, "@resourceType/resourceName" (उदाहरण के लिए, "@style/myCustomStyle") या "0" के फ़ॉर्मैट में होनी चाहिए | हां | नहीं |
| कस्टम Parcelable | app:argType="<type>", जहां <type> Parcelable का पूरी तरह क्वालिफ़ाइड क्लास नेम है |
"@null" की डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जा सकता है. यह अन्य डिफ़ॉल्ट वैल्यू के साथ काम नहीं करता. | नहीं | हां |
| कस्टम सीरियलाइज़ेबल | app:argType="<type>", जहां <type> Serializable का पूरी तरह क्वालिफ़ाइड क्लास नेम है |
"@null" की डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जा सकता है. यह अन्य डिफ़ॉल्ट वैल्यू के साथ काम नहीं करता. | नहीं | हां |
| कस्टम Enum | app:argType="<type>", जहां <type> enum का पूरी तरह क्वालिफ़ाइड नाम है | हां - डिफ़ॉल्ट वैल्यू, अनक्वालिफ़ाइड नाम से मैच होनी चाहिए. उदाहरण के लिए, MyEnum.SUCCESS से मैच करने के लिए "SUCCESS". | नहीं | नहीं |
अगर किसी आर्ग्युमेंट टाइप में शून्य वैल्यू इस्तेमाल की जा सकती हैं, तो android:defaultValue="@null" का इस्तेमाल करके, शून्य की डिफ़ॉल्ट वैल्यू तय की जा सकती है.
स्ट्रिंग से रूट, डीप लिंक, और यूआरआई को उनके आर्ग्युमेंट के साथ पार्स किया जा सकता है. Parcelables और Serializables जैसे कस्टम डेटा टाइप का इस्तेमाल करके ऐसा नहीं किया जा सकता. इसके बारे में पिछली टेबल में बताया गया है. कस्टम कॉम्प्लेक्स डेटा को पास करने के लिए, डेटा को ViewModel या डेटाबेस जैसी किसी दूसरी जगह पर सेव करें. साथ ही, नेविगेट करते समय सिर्फ़ आइडेंटिफ़ायर पास करें. इसके बाद, नेविगेशन पूरा होने पर डेटा को नई जगह पर वापस पाएं.
कस्टम टाइप में से कोई एक चुनने पर, क्लास चुनें डायलॉग बॉक्स दिखता है. इसमें आपको उस टाइप के लिए क्लास चुनने के लिए कहा जाता है. प्रोजेक्ट टैब की मदद से, अपने मौजूदा प्रोजेक्ट से कोई क्लास चुनी जा सकती है.
<inferred type> को चुनकर, नेविगेशन लाइब्रेरी को दी गई वैल्यू के आधार पर टाइप तय करने की अनुमति दी जा सकती है.
अरे को चुनकर यह बताया जा सकता है कि आर्ग्युमेंट, चुने गए टाइप की वैल्यू का अरे होना चाहिए. यहां दी गई बातों का ध्यान रखें:
- enum के ऐरे और संसाधन के रेफ़रंस के ऐरे इस्तेमाल नहीं किए जा सकते.
- अरे में बिना किसी वैल्यू वाली वैल्यू इस्तेमाल की जा सकती हैं. भले ही, अंडरलाइंग टाइप की बिना किसी वैल्यू वाली वैल्यू के लिए सपोर्ट उपलब्ध हो या नहीं. उदाहरण के लिए,
app:argType="integer[]"का इस्तेमाल करके,app:nullable="true"का इस्तेमाल किया जा सकता है. इससे यह पता चलता है कि शून्य कलेक्शन को पास किया जा सकता है. - अरे में सिर्फ़ एक डिफ़ॉल्ट वैल्यू, "@null" का इस्तेमाल किया जा सकता है. ऐरे के लिए, कोई और डिफ़ॉल्ट वैल्यू इस्तेमाल नहीं की जा सकती.
किसी कार्रवाई में डेस्टिनेशन आर्ग्युमेंट को बदलना
डेस्टिनेशन-लेवल के आर्ग्युमेंट और डिफ़ॉल्ट वैल्यू का इस्तेमाल, उन सभी कार्रवाइयों के लिए किया जाता है जो डेस्टिनेशन पर ले जाती हैं. ज़रूरत पड़ने पर, आर्ग्युमेंट की डिफ़ॉल्ट वैल्यू को बदला जा सकता है. इसके अलावा, अगर कोई वैल्यू पहले से मौजूद नहीं है, तो उसे सेट किया जा सकता है. इसके लिए, आपको कार्रवाई के लेवल पर आर्ग्युमेंट तय करना होगा. यह आर्ग्युमेंट, डेस्टिनेशन में बताए गए आर्ग्युमेंट के नाम और टाइप से मेल खाना चाहिए.
यहां दिए गए एक्सएमएल में, एक आर्ग्युमेंट के साथ ऐसी कार्रवाई का एलान किया गया है जो पिछले उदाहरण में दिए गए डेस्टिनेशन-लेवल के आर्ग्युमेंट को बदल देती है:
<action android:id="@+id/startMyFragment"
app:destination="@+id/myFragment">
<argument
android:name="myArg"
app:argType="integer"
android:defaultValue="1" />
</action>
टाइप सेफ़्टी के साथ डेटा पास करने के लिए, Safe Args का इस्तेमाल करना
नेविगेशन कॉम्पोनेंट में Safe Args नाम का एक Gradle प्लगिन होता है. यह टाइप-सेफ़ नेविगेशन और उससे जुड़े किसी भी आर्ग्युमेंट को ऐक्सेस करने के लिए, आसान ऑब्जेक्ट और बिल्डर क्लास जनरेट करता है. नेविगेट करने और डेटा पास करने के लिए, Safe Args का इस्तेमाल करने का सुझाव दिया जाता है. इससे टाइप सेफ़्टी पक्का होती है.
अगर Gradle का इस्तेमाल नहीं किया जा रहा है, तो 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 को चालू करने के बाद, जनरेट किए गए कोड में हर कार्रवाई के लिए, टाइप सेफ़ क्लास और तरीके शामिल होते हैं. साथ ही, इसमें डेटा भेजने और पाने वाले हर डेस्टिनेशन के लिए भी टाइप सेफ़ क्लास और तरीके शामिल होते हैं.
हर उस डेस्टिनेशन के लिए एक क्लास बनाई जाती है जहां से कोई कार्रवाई शुरू होती है. इस क्लास का नाम, यात्रा शुरू करने की जगह के नाम के साथ "Directions" शब्द जोड़कर बनाया जाता है. उदाहरण के लिए, अगर ऑरिजिन डेस्टिनेशन एक फ़्रैगमेंट है, जिसका नाम
SpecifyAmountFragmentहै, तो जनरेट की गई क्लास कोSpecifyAmountFragmentDirectionsकहा जाता है.इस क्लास में, ओरिजिनेटिंग डेस्टिनेशन में तय की गई हर कार्रवाई के लिए एक तरीका होता है.
आर्ग्युमेंट पास करने के लिए इस्तेमाल की जाने वाली हर कार्रवाई के लिए, एक इनर क्लास बनाई जाती है. इसका नाम, कार्रवाई के आधार पर तय होता है. उदाहरण के लिए, अगर कार्रवाई का नाम
confirmationAction,है, तो क्लास का नामConfirmationActionहोगा. अगर आपकी कार्रवाई मेंdefaultValueके बिना आर्ग्युमेंट शामिल हैं, तो आर्ग्युमेंट की वैल्यू सेट करने के लिए, उससे जुड़ी कार्रवाई क्लास का इस्तेमाल करें.डेस्टिनेशन के लिए एक क्लास बनाई जाती है. इस क्लास का नाम, डेस्टिनेशन के नाम के साथ "Args" शब्द जोड़कर बनाया जाता है. उदाहरण के लिए, अगर डेस्टिनेशन फ़्रैगमेंट का नाम
ConfirmationFragment,है, तो जनरेट की गई क्लास कोConfirmationFragmentArgsकहा जाता है. आर्ग्युमेंट पाने के लिए, इस क्लास केfromBundle()तरीके का इस्तेमाल करें.
यहां दिए गए उदाहरण में, आर्ग्युमेंट सेट करने और उसे navigate() तरीके में पास करने के लिए, इन तरीकों का इस्तेमाल करने का तरीका बताया गया है:
Kotlin
override fun onClick(v: View) {
val amountTv: EditText = view!!.findViewById(R.id.editTextAmount)
val amount = amountTv.text.toString().toInt()
val action = SpecifyAmountFragmentDirections.confirmationAction(amount)
v.findNavController().navigate(action)
}
Java
@Override
public void onClick(View view) {
EditText amountTv = (EditText) getView().findViewById(R.id.editTextAmount);
int amount = Integer.parseInt(amountTv.getText().toString());
ConfirmationAction action =
SpecifyAmountFragmentDirections.confirmationAction();
action.setAmount(amount);
Navigation.findNavController(view).navigate(action);
}
रिसीव करने वाले डेस्टिनेशन के कोड में, बंडल को वापस पाने और उसके कॉन्टेंट का इस्तेमाल करने के लिए, getArguments() तरीके का इस्तेमाल करें. -ktx डिपेंडेंसी का इस्तेमाल करते समय, Kotlin के उपयोगकर्ता आर्ग्युमेंट ऐक्सेस करने के लिए, by navArgs() प्रॉपर्टी डेलिगेट का भी इस्तेमाल कर सकते हैं.
Kotlin
val args: ConfirmationFragmentArgs by navArgs()
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
val tv: TextView = view.findViewById(R.id.textViewAmount)
val amount = args.amount
tv.text = amount.toString()
}
Java
@Override
public void onViewCreated(View view, @Nullable Bundle savedInstanceState) {
TextView tv = view.findViewById(R.id.textViewAmount);
int amount = ConfirmationFragmentArgs.fromBundle(getArguments()).getAmount();
tv.setText(amount + "");
}
ग्लोबल ऐक्शन के साथ Safe Args का इस्तेमाल करना
ग्लोबल ऐक्शन के साथ Safe Args का इस्तेमाल करते समय, आपको अपने रूट <navigation> एलिमेंट के लिए android:id वैल्यू देनी होगी. इसके बारे में यहां दिए गए उदाहरण में बताया गया है:
<?xml version="1.0" encoding="utf-8"?> <navigation xmlns:app="http://schemas.android.com/apk/res-auto" xmlns:tools="http://schemas.android.com/tools" xmlns:android="http://schemas.android.com/apk/res/android" android:id="@+id/main_nav" app:startDestination="@id/mainFragment"> ... </navigation>
नेविगेशन, <navigation> एलिमेंट के लिए Directions क्लास जनरेट करता है. यह क्लास, android:id वैल्यू पर आधारित होती है. उदाहरण के लिए, अगर आपके पास android:id=@+id/main_nav वाला <navigation> एलिमेंट है, तो जनरेट की गई क्लास को MainNavDirections कहा जाता है. <navigation> एलिमेंट में मौजूद सभी डेस्टिनेशन के लिए, उनसे जुड़े सभी ग्लोबल ऐक्शन को ऐक्सेस करने के तरीके जनरेट किए गए हैं. इसके लिए, पिछले सेक्शन में बताए गए तरीकों का इस्तेमाल किया गया है.
Bundle ऑब्जेक्ट की मदद से, एक डेस्टिनेशन से दूसरे डेस्टिनेशन पर डेटा पास करना
अगर Gradle का इस्तेमाल नहीं किया जा रहा है, तो Bundle ऑब्जेक्ट का इस्तेमाल करके, डेस्टिनेशन के बीच आर्ग्युमेंट पास किए जा सकते हैं. Bundle ऑब्जेक्ट बनाएं और उसे navigate() का इस्तेमाल करके डेस्टिनेशन पर भेजें, जैसा कि इस उदाहरण में दिखाया गया है:
Kotlin
val bundle = bundleOf("amount" to amount)
view.findNavController().navigate(R.id.confirmationAction, bundle)
Java
Bundle bundle = new Bundle();
bundle.putString("amount", amount);
Navigation.findNavController(view).navigate(R.id.confirmationAction, bundle);
डेस्टिनेशन के कोड में, Bundle को वापस पाने और उसके कॉन्टेंट का इस्तेमाल करने के लिए, getArguments() तरीके का इस्तेमाल करें:
Kotlin
val tv = view.findViewById<TextView>(R.id.textViewAmount)
tv.text = arguments?.getString("amount")
Java
TextView tv = view.findViewById(R.id.textViewAmount);
tv.setText(getArguments().getString("amount"));
स्टार्ट डेस्टिनेशन को डेटा पास करना
अपने ऐप्लिकेशन के स्टार्ट डेस्टिनेशन पर डेटा भेजा जा सकता है. सबसे पहले, आपको साफ़ तौर पर एक Bundle बनाना होगा, जिसमें डेटा मौजूद हो. इसके बाद, Bundle को स्टार्ट डेस्टिनेशन पर भेजने के लिए, इनमें से किसी एक तरीके का इस्तेमाल करें:
- अगर
NavHostको प्रोग्राम के हिसाब से बनाया जा रहा है, तोNavHostFragment.create(R.navigation.graph, args)को कॉल करें. यहांargsवहBundleहै जिसमें आपका डेटा मौजूद है. - इसके अलावा,
NavController.setGraph()के इनमें से किसी एक ओवरलोड को कॉल करके, शुरुआती डेस्टिनेशन के आर्ग्युमेंट सेट किए जा सकते हैं:- ग्राफ़ के आईडी का इस्तेमाल करें:
navController.setGraph(R.navigation.graph, args) - ग्राफ़ का इस्तेमाल करें:
navController.setGraph(navGraph, args)
- ग्राफ़ के आईडी का इस्तेमाल करें:
शुरुआती डेस्टिनेशन का डेटा वापस पाने के लिए, Fragment.getArguments() पर कॉल करें.
ProGuard के बारे में ज़रूरी बातें
अगर आपको अपने कोड को छोटा करना है, तो आपको Parcelable, Serializable, और Enum क्लास के नामों को छोटा करने की प्रोसेस के दौरान, उन्हें छिपाने से रोकना होगा. ऐसा करने के दो तरीके हैं:
- @Keep एनोटेशन का इस्तेमाल करें.
- keepnames नियमों का इस्तेमाल करें.
यहां दिए गए सब-सेक्शन में, इन तरीकों के बारे में बताया गया है.
@Keep एनोटेशन का इस्तेमाल करना
यहां दिए गए उदाहरण में, मॉडल क्लास की परिभाषाओं में @Keep एनोटेशन जोड़े गए हैं:
Kotlin
@Keep class ParcelableArg : Parcelable { ... }
@Keep class SerializableArg : Serializable { ... }
@Keep enum class EnumArg { ... }
Java
@Keep public class ParcelableArg implements Parcelable { ... }
@Keep public class SerializableArg implements Serializable { ... }
@Keep public enum EnumArg { ... }
keepnames नियमों का इस्तेमाल करना
अपनी proguard-rules.pro फ़ाइल में keepnames नियम भी जोड़े जा सकते हैं, जैसा कि इस उदाहरण में दिखाया गया है:
proguard-rules.pro
...
-keepnames class com.path.to.your.ParcelableArg
-keepnames class com.path.to.your.SerializableArg
-keepnames class com.path.to.your.EnumArg
...
अन्य संसाधन
नेविगेशन के बारे में ज़्यादा जानने के लिए, यहां दिए गए अन्य संसाधन देखें.