העברת הניווט ב-Jetpack לכתיבה קולית

Navigation Compose API מאפשר לכם לנווט בין פונקציות Composable באפליקציית Compose, תוך ניצול היתרונות של הרכיב, התשתית והתכונות של Jetpack Navigation.

בדף הזה מוסבר איך לבצע מיגרציה מ-Jetpack Navigation מבוסס-Fragment ל-Navigation Compose, כחלק מהמיגרציה הגדולה יותר של ממשק משתמש מבוסס-View ל-Jetpack Compose.

תנאים מוקדמים להעברה

אפשר לעבור אל Navigation Compose אחרי שמחליפים את כל ה-Fragments ברכיבי מסך תואמים שניתנים להרכבה. רכיבי מסך מסוג Composable יכולים להכיל שילוב של תוכן Compose ותוכן View, אבל כל יעדי הניווט חייבים להיות רכיבים מסוג Composable כדי לאפשר העברה של Navigation Compose. עד אז, כדאי להמשיך להשתמש ברכיב הניווט מבוסס-Fragment בבסיס הקוד של View ו-Compose. מידע נוסף זמין במאמרי העזרה בנושא תאימות בין מערכות ניווט.

לא צריך להשתמש ב-Navigation Compose באפליקציה שמבוססת על Compose בלבד. אתם יכולים להמשיך להשתמש ברכיב הניווט מבוסס-Fragment, כל עוד אתם משתמשים ב-Fragments כדי לארח את התוכן שניתן להרכבה.

שלבים בהעברה

גם אם אתם פועלים לפי אסטרטגיית ההעברה המומלצת שלנו וגם אם אתם בוחרים בגישה אחרת, תגיעו למצב שבו כל יעדי הניווט הם רכיבי UI שניתנים להרכבה, ורכיבי Fragment משמשים רק כקונטיינרים של רכיבים שניתנים להרכבה. בשלב הזה, אפשר לבצע מיגרציה ל-Navigation Compose.

אם האפליקציה כבר פועלת לפי דפוס עיצוב של UDF ובהתאם למדריך שלנו בנושא ארכיטקטורה, המעבר ל-Jetpack Compose ול-Navigation Compose לא אמור לדרוש שינויים משמעותיים בשכבות אחרות של האפליקציה, מלבד שכבת ממשק המשתמש.

כדי לבצע מיגרציה אל Navigation Compose, פועלים לפי השלבים הבאים:

  1. מוסיפים את התלות של Navigation Compose לאפליקציה.

  2. יוצרים רכיב App-level שאפשר להרכיב ומוסיפים אותו ל-Activity כנקודת הכניסה של Compose, במקום ההגדרה של פריסת View:

    class SampleActivity : ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // setContentView<ActivitySampleBinding>(this, R.layout.activity_sample)
        setContent {
            SampleApp(/* ... */)
        }
    }
}
    MigrationCommonScenariosSnippets.kt

  3. יוצרים סוגים לכל יעד ניווט. משתמשים ב-data object ליעדים שלא נדרשים בהם נתונים, וב-data class או ב-class ליעדים שנדרשים בהם נתונים.

    @Serializable data object First
@Serializable data class Second(val id: String)
@Serializable data object Third

    MigrationCommonScenariosSnippets.kt

  4. מגדירים את NavController במקום שלכל רכיבי ה-Composable שצריכים להפנות אליו תהיה גישה אליו (בדרך כלל בתוך רכיב ה-Composable של App). הגישה הזו מבוססת על עקרונות של העברת מצב ומאפשרת להשתמש ב-NavController כמקור האמת לניווט בין מסכים שניתנים להרכבה ולשמירה על ערימת החזרה:

    @Composable
fun SampleApp() {
    val navController = rememberNavController()
    // ...
}
    MigrationCommonScenariosSnippets.kt

  5. יוצרים את NavHost של האפליקציה בתוך ה-composable‏ App ומעבירים את navController:

    @Composable
fun SampleApp() {
    val navController = rememberNavController()

    SampleNavHost(navController = navController)
}

@Composable
fun SampleNavHost(
    navController: NavHostController
) {
    NavHost(navController = navController, startDestination = First) {
        // ...
    }
}
    MigrationCommonScenariosSnippets.kt

  6. מוסיפים את היעדים composable כדי ליצור את גרף הניווט. אם כל מסך הועבר בעבר ל-Compose, השלב הזה כולל רק חילוץ של רכיבי המסך האלה מ-Fragments אל composable destinations:

    class FirstFragment : Fragment() {

    override fun onCreateView(
        inflater: LayoutInflater,
        container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View {
        return ComposeView(requireContext()).apply {
            setContent {
                // FirstScreen(...) EXTRACT FROM HERE
            }
        }
    }
}

@Composable
fun SampleNavHost(
    navController: NavHostController
) {
    NavHost(navController = navController, startDestination = First) {
        composable<First> {
            FirstScreen(/* ... */) // EXTRACT TO HERE
        }
        composable<Second> {
            SecondScreen(/* ... */)
        }
        // ...
    }
}
    MigrationCommonScenariosSnippets.kt

  7. אם פעלתם לפי ההנחיות בנושא תכנון ארכיטקטורה של ממשק המשתמש ב-Compose, ובמיוחד לפי ההנחיות לגבי האופן שבו צריך להעביר את ViewModel ואת אירועי הניווט לרכיבי Composable, השלב הבא הוא לשנות את האופן שבו אתם מספקים את ViewModel לכל רכיב Composable של המסך. לרוב אפשר להשתמש בהזרקת Hilt ובנקודת השילוב שלה עם Compose ו-Navigation באמצעות hiltViewModel:

    @Composable
fun FirstScreen(
    // viewModel: FirstViewModel = viewModel(),
    viewModel: FirstViewModel = hiltViewModel(),
    onButtonClick: () -> Unit = {},
) {
    // ...
}
    MigrationCommonScenariosSnippets.kt

  8. מחליפים את כל הקריאות לניווט findNavController() בקריאות navController ומעבירים אותן כאירועי ניווט לכל מסך שאפשר להוסיף לו רכיבים, במקום להעביר את כל navController. הגישה הזו תואמת לשיטות המומלצות לחשיפת אירועים מפונקציות שאפשר להרכיב למתקשרים, ושומרת על navController כמקור האמת היחיד.

    אפשר להעביר נתונים ליעד על ידי יצירת מופע של מחלקת המסלול שהוגדרה ליעד הזה. אחר כך אפשר לקבל אותו ישירות מהערך במחסנית החזרה ביעד או מ-ViewModel באמצעות SavedStateHandle.toRoute().

    @Composable
fun SampleNavHost(
    navController: NavHostController
) {
    NavHost(navController = navController, startDestination = First) {
        composable<First> {
            FirstScreen(
                onButtonClick = {
                    // findNavController().navigate(firstScreenToSecondScreenAction)
                    navController.navigate(Second(id = "ABC"))
                }
            )
        }
        composable<Second> { backStackEntry ->
            val secondRoute = backStackEntry.toRoute<Second>()
            SecondScreen(
                id = secondRoute.id,
                onIconClick = {
                    // findNavController().navigate(secondScreenToThirdScreenAction)
                    navController.navigate(Third)
                }
            )
        }
        // ...
    }
}
    MigrationCommonScenariosSnippets.kt

  9. מסירים את כל ה-Fragments, פריסות ה-XML הרלוונטיות, רכיבי הניווט המיותרים ומשאבים אחרים, וכן רכיבים תלויים ישנים של Fragment ו-Jetpack Navigation.

במסמכי ההגדרה מפורטים אותם שלבים עם פרטים נוספים שקשורים ל-Navigation Compose.

תרחישים נפוצים לדוגמה

לא משנה באיזה רכיב ניווט משתמשים, אותם עקרונות ניווט חלים.

תרחישים נפוצים להעברה:

מידע מפורט יותר על תרחישי השימוש האלה זמין במאמר ניווט באמצעות התכונה 'יצירה'.

אחזור נתונים מורכבים במהלך הניווט

מומלץ מאוד לא להעביר אובייקטים מורכבים של נתונים כשעוברים בין דפים. במקום זאת, כשמבצעים פעולות ניווט, מעבירים את המידע המינימלי הנדרש כארגומנטים, כמו מזהה ייחודי או סוג אחר של מזהה. מומלץ לאחסן אובייקטים מורכבים כנתונים במקור אחד לנתוני האמת, כמו שכבת הנתונים. מידע נוסף זמין במאמר אחזור נתונים מורכבים במהלך הניווט.

אם רכיבי ה-Fragment מעבירים אובייקטים מורכבים כארגומנטים, כדאי לשנות את מבנה הקוד כך שיהיה אפשר לאחסן את האובייקטים האלה בשכבת הנתונים ולאחזר אותם ממנה. דוגמאות לכך אפשר לראות במאגר Now in Android.

מגבלות

בקטע הזה מתוארות המגבלות הנוכחיות של Navigation Compose.

העברה מצטברת ל-Navigation Compose

בשלב הזה, אי אפשר להשתמש ב-Navigation Compose כשעדיין משתמשים ב-Fragments כיעדים בקוד. כדי להתחיל להשתמש ב-Navigation Compose, כל היעדים צריכים להיות פונקציות שאפשר להוסיף להן קומפוזיציה. אפשר לעקוב אחרי הבקשה הזו לתכונה בכלי למעקב אחר בעיות.

אנימציות של מעברים

החל מגרסה Navigation 2.7.0-alpha01, התמיכה בהגדרת מעברים מותאמים אישית, שבעבר הייתה זמינה מ-AnimatedNavHost, זמינה עכשיו ישירות ב-NavHost. מידע נוסף זמין בהערות המוצר.

מידע נוסף

למידע נוסף על מעבר ל-Navigation Compose, אפשר לעיין במקורות המידע הבאים:

  • ‫Navigation Compose codelab: לומדים את היסודות של Navigation Compose באמצעות codelab מעשי.
  • מאגר Now in Android: אפליקציית Android פונקציונלית לחלוטין שנבנתה לגמרי באמצעות Kotlin ו-Jetpack Compose, בהתאם לשיטות המומלצות לעיצוב ולפיתוח של Android, וכוללת Navigation Compose.
  • העברת Sunflower ל-Jetpack Compose: פוסט בבלוג שמתעד את תהליך ההעברה של אפליקציית הדוגמה Sunflower מ-Views ל-Compose, שכולל גם העברה ל-Navigation Compose.
  • Jetnews for every screen: פוסט בבלוג שמתעד את הארגון מחדש וההעברה של דוגמת Jetnews כדי לתמוך בכל המסכים באמצעות Jetpack Compose ו-Navigation Compose.