استفاده از Navigation در اندروید

نویگیشن در اندروید

دسترسی سریع

پلاگین ها و کتابخونه های مورد نیاز Navigation Graph NavHost NavController
برای جابه جایی کاربر در قسمت های مختلف برنامه (معمولا جا به جایی بین Fragment ها) از Navigation استفاده می کنیم

توجه:

هنگام استفاده از navigation توصیه میشه سیاست تک activity و چند فرگمنتی رو به کار ببرید یعنی تنها یک activity داریم و کاربر فقط بین fragment ها جا به جا میشه

توجه:

در این مقاله فرض بر این شده با Fragment, Activity و مباحث پایه ای اندروید آشنایی دارید.

مزایای استفاده از Navigation

۱-کنترل تراکنش بین fragment ها

۲-کنترل عملگر های Up و Back در برنامه

۳-تهیه ی منابع استاندارد برای استفاده از انیمیشن ها

۴-اجرا و کنترل Deep Link

۵-قابلیت استفاده از پلاگین Safe-Args برای پاس دادن داده ها بین Fragment ها به صورت امن

۶-پشتیبانی مناسب از ViewModel

خب بریم ببینیم چه خبره!

پلاگین ها و کتابخونه های مورد نیاز

افزودن Navigation به پروژه

RootProject -> app -> build.gradle

dependencies{ ... implementation "androidx.navigation:navigation-fragment-ktx:2.5.1" implementation "androidx.navigation:navigation-ui-ktx:2.5.1" }

افزودن پلاگین safe-args به پروژه

از safe-args برای فرستادن متغیر ها از یک فرگمنت به فرگمنت دیگه استفاده میشه

RootProject -> build.gradle

dependencies { ... classpath "androidx.navigation.safeargs.kotlin:androidx.navigation.safeargs.kotlin.gradle.plugin:$nav_version" ... }
plugins { ... id 'androidx.navigation.safeargs.kotlin' version '2.5.1' apply false }

RootProject -> app -> build.gradle

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

برای جا به جایی بین فرگمنت ها با Navigation باید کار های زیر را انجام بدیم:

- ایجاد فایل Navigation Graph و ترسیم مسیر های بین فرگمنت ها.

- تعریف NavHost معمولا در main_activity تعریفش می کنیم.

- جابه جایی با استفاده از NavController (معمولا NavController رو با استفاده از متد findNavController در Fragment, Activity یا View صدا می زنیم).

Navigation Graph

یک فایل xml که تمامی مقصد ها و مسیر های بین فرگمنت ها رو داخلش ترسیم میکنیم این فایل باید در مسیر زیر ایجاد بشه:

RootProject -> app -> src -> main -> res -> navigation

فایل Navigation Graph دارای عناصر زیر است:

1- navigation

عنصر navigation ریشه ی Navigation Graph است بقیه ی عناصر فرزندان این عنصر هستند این عنصر باید دارای دو فیلد id و startDestination باشه

<navigation xmlns:android="http://schemas.android.com/apk/res/android" xmlns:app="http://schemas.android.com/apk/res-auto" xmlns:tools="http://schemas.android.com/tools" android:id="..." app:startDestination="..."> ... </navigation>

فیلد id شامل ای دی برای navigation است.

فیلد startDestination شامل آی دی فرگمنتیه که به عنوان نقطه ی شروع در نظر گرفته میشه.

2- fragment

با استفاده از این عنصر destination ها رو تعریف میکنیم

به این عنصر destination هم گفته میشه.

<fragment android:id="..." android:name="..." android:label="..." tools:layout="..." />

فیلد id شامل آی دی برای fragment است

فیلد name شامل اسم کلاس Fragment مورد نظر است.

فیلد label شامل اسم برچسب برای destination است.

در فیلد layout که اختیاریه ادرس فایل xml مربوط به Fragment در layout رو میدیم.

3- action:

زمانی که میخوایم یک مسیر بین fragment ها تعریف کنیم این عنصر رو به عنوان فرزند fragment اولی تعریف میکنیم.

<fragment ... > ... <action android:id="..." app:destination="..."> ... </action> </fragment>

فیلد id شامل آی دی برای action است.

فیلد destination شامل آی دی fragment دومی است.

نکته:

برای این عنصر فیلد های انیمیشنی ام وجود داره که هنگام جا به جایی بین فرگمنت ها میشه از انیمیشن استفاده کرد ولی ما برای اختصار ازشون صرف نظر کردیم

4- argument:

زمانی که کاربر میخواد بین فرگمنت ها جا به جا بشه با این عنصر میتونیم داده های primary, string و object هایی از جنس parcelable رو از فرگمنت اولی به فرگمنت دومی منتقل کنیم این عنصرو باید به عنوان فرزند action تعریف کنیم

<action ... > <argument android:name="..." app:argType="..." app:nullable="..." /> </action>

فیلد name شامل اسم دلخواه برای داده مورد نظر است.

فیلد argType شامل نوع داده ایست که میخوایم از اولی به دومی منتقل کنیم.

با فیلد nullable تعیین میکنیم که داده ی مورد نظر برای انتقال میتونه null باشه یا خیر که نوعش boolean است.

مثال:

فرض کنید دوتا Fragment داریم و میخوایم کاربر از اولی به دومی جا به جا بشه فرگمنت اول رو به عنوان نقطه ی شروع در نظر میگیریم.

ابتدا یک فایل با اسم دلخواه در مسیر زیر ایجاد میکنیم

Root Project -> resources -> navigation -> filename.xml

سپس مانند نمونه ی زیر destination ها و مسیر های بینشونو تعریف میکنیم:

<navigation xmlns:android="http://schemas.android.com/apk/res/android" xmlns:app="http://schemas.android.com/apk/res-auto" xmlns:tools="http://schemas.android.com/tools" android:id="@+id/main_nav_graph" app:startDestination="@id/destination0"> <fragment android:id="@+id/firstFragment" android:name="packageName.FirstFragment" android:label="FirstFragment Label" tools:layout="@layout/fragment_first"> <action android:id="@+id/from_FirstFragment_to_SecondFragment" android:destination="@fragment1"> <argument android:name="argName" app:argType="object" app:nullable="false"/> </action> </fragment> <fragment android:id="@+id/secondFragment" android:name="packagename.SecondFragment" android:label="Fragment1 Label" tools:layout="@layout/fragment_second"/> </navigation>

اگه کد هاتون مثل بالا باشه مانند تصویر زیر را باید در تب design ببینید

تصویر navigation graph در اندروید

همانطور که مشاهده می کنید firstFragment به عنوان startDestination تعریف شده و علامت خانه است فلش از firstFragment به secondFragment هم مسیریه که با عنصر action تعریف کردیم.

نکته:

میتونید بجای نوشتن کد های xml به صورت ویژوال هم در قسمت design این کارا رو بکنید اما برای درک درست تر بهتره که با xml مسیر ها و destination ها رو تعریف کنید.

NavHost

به عنوان میزبان fragment ها زمانی که کاربر بخواد از یک فرگمنت به فرگمنت دیگه ای جا به جا بشه فرگمنت اولی از NavHost خارج میشه و فرگمنت دومی برای نمایش داخل NavHost جایگزین میشه معمولا NavHost رو داخل main_activity تعریف میکنند

<androidx.fragment.app.FragmentContainerView android:id="..." android:layout_width="match_parent" android:layout_height="match_parent" android:name="androidx.navigation.fragment.NavHostFragment" app:navGraph="..." app:defaultNavHost="true" />

فیلد id شامل آیدی برای NavHost است.

فیلد name شامل اسم کلاس NavHostFragment است.

فیلد navGraph شامل اسم Navigation Graph تعریف شده در پوشه ی navigation است.

فیلد defaultNavHost میگه NavHost تعریف شده به عنوان پیشفرض در نظر گرفته بشه.

NavController

وظیفه ی مدیریت جا به جایی کاربر بین fragment ها رو داره وقتی بخوایم کاربر از یک فرگمنت به فرگمنت دیگه ای جا به جا بشه با استفاده از این کلاس میتونیم این جا به جایی رو انجام بدیم این کلاس رو میتونیم با استفاده از متد ()findNavController در activity, fragment یا view صدا بزنیم و ازش استفاده کنیم
اگر در Navigation Graph داخل عنصر fragment حداقل یک عنصر action تعریف کنیم اندروید استادیو خودکار کلاس FragmentDirections مربوط به فرگمنت مورد نظرو میسازه این کلاس متد های مرتبط با عنصر های action ایجاد شده رو برای جا به جایی با استفاده از متد navigate در کلاس NavController را در بر داره

مثال:

برای اینکه بخوایم کاربر با زدن یک کلید از یک فرگمنت به فرگمنت دیگه ای بره مثل زیر عمل می کنیم

class FirstFragment: Fragment(){ ... override fun onCreateView( inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle? ): View? { ... button.setOnClickListener { val action = FirstFragmentDirections.fromFirstFragmentToSecondFragment(arg0 , arg1, ... argn) findNavController().navigate(action) } return view } ... }

در اینجا کلاس FirstFragmentDirections خودکار توسط اندروید استادیو ساخته شده همونطور که گفته شد این کلاس زمانی ساخته میشه که حداقل یک عنصر اکشن داخل عنصر fragment مورد نظر در فایل Navigation Graph تعریف کرده باشیم متد fromFirstFragmentToSecondFragment هم بر اساس id که برای action تعریف میکنیم ایجاد میشه اگه بخوایم داخل عنصر action عنصر argument تعریف کنیم این متد حاوی پارامتر هایی میشه که از جنس argument های تعریف شده داخل عنصر اکشن هستند

تا اینجای کار با موارد ضروری جهت پیادهسازی Navigation در پروژه اشنا شدیم امیدوارم بدردتون بخوره روزاتون پر کد کداتون پر پول 😎

مطالب مرتبط

arrow_drop_up
کپی شد!