บันทึกและจัดการสถานะการนําทาง

ส่วนต่อไปนี้จะอธิบายกลยุทธ์ในการบันทึก Back Stack และจัดเก็บสถานะที่เชื่อมโยงกับรายการใน Back Stack

บันทึก Back Stack

การตรวจสอบว่าสถานะการนำทางของแอปยังคงอยู่ตลอดเหตุการณ์ในวงจรต่างๆ รวมถึงการเปลี่ยนแปลงการกำหนดค่าและการสิ้นสุดการประมวลผล เป็นสิ่งสำคัญอย่างยิ่งต่อประสบการณ์ของผู้ใช้ที่ดี ใน Navigation 3 คุณเป็นเจ้าของ Back Stack จึงไม่มีหลักเกณฑ์ที่เข้มงวดเกี่ยวกับวิธีสร้างหรือบันทึก อย่างไรก็ตาม Navigation 3 มีเมธอดอำนวยความสะดวกที่ให้ Back Stack ที่บันทึกได้ ดังนี้ rememberNavBackStack

ใช้ rememberNavBackStack

ฟังก์ชันที่ประกอบกันได้ที่ชื่อ rememberNavBackStack ออกแบบมาเพื่อสร้าง Back Stack ที่ยังคงอยู่แม้จะมีการเปลี่ยนแปลงการกำหนดค่าและการสิ้นสุดการประมวลผล

เพื่อให้ rememberNavBackStack ทำงานได้อย่างถูกต้อง คีย์แต่ละรายการใน Back Stack ของคุณต้องเป็นไปตามข้อกำหนดเฉพาะต่อไปนี้

  • ใช้อินเทอร์เฟซ NavKey: ทุกคีย์ใน Back Stack ต้องใช้อินเทอร์เฟซ NavKey ซึ่งจะทำหน้าที่เป็นอินเทอร์เฟซเครื่องหมายที่ส่งสัญญาณไปยังไลบรารีว่าสามารถบันทึกคีย์ได้
  • มีคำอธิบายประกอบ @Serializable: นอกเหนือจากการใช้ NavKey แล้ว คลาสและออบเจ็กต์หลักต้องมีคำอธิบายประกอบ @Serializable ด้วย

ข้อมูลโค้ดต่อไปนี้แสดงการติดตั้งใช้งาน rememberNavBackStack ที่ถูกต้อง

@Serializable
data object Home : NavKey

@Composable
fun NavBackStack() {
    val backStack = rememberNavBackStack(Home)
}

จำ Back Stack ที่มีประเภทย่อยเป็น NavKey

ฟังก์ชันที่ประกอบกันได้ที่ชื่อ rememberNavBackStack จะแสดงผล NavBackStack<NavKey> หากแอปกำหนดประเภทย่อยของ NavKey ของตัวเองซึ่งคีย์ทั้งหมดรับค่ามา คุณสามารถคงการพิมพ์นั้นไว้ได้โดยใช้ฟังก์ชัน remember ที่กำหนดเอง ดังนี้

@Serializable
sealed interface MyAppNavKey : NavKey

@Serializable
data object ScreenA: MyAppNavKey

@Serializable
data class ScreenB(val id: String): MyAppNavKey

@Composable
fun rememberMyAppNavBackStack(vararg elements: MyAppNavKey): NavBackStack<MyAppNavKey> {
    return rememberSerializable(serializer = serializer()) {
        NavBackStack(*elements)
    }
}

@Composable
fun MyApp() {
    // defaultNavBackStack is NavBackStack<NavKey>
    val defaultNavBackStack = rememberNavBackStack(ScreenA)
    // myAppNavBackStack is NavBackStack<MyAppNavKey>
    val myAppNavBackStack = rememberMyAppNavBackStack(ScreenA)
}

ดูตัวอย่างเพิ่มเติม รวมถึงวิธีจัดการกับ Open Polymorphism ได้ที่ NavBackStackSamples

ทางเลือก: การจัดเก็บใน ViewModel

อีกวิธีหนึ่งในการจัดการ Back Stack คือการจัดเก็บไว้ใน ViewModel หากต้องการคงข้อมูลไว้ตลอดการสิ้นสุดการประมวลผลเมื่อใช้ ViewModel หรือพื้นที่เก็บข้อมูลที่กำหนดเองอื่นๆ คุณต้องทำดังนี้

  • ตรวจสอบว่าคีย์ของคุณสามารถแปลงเป็นอนุกรมได้: เช่นเดียวกับ rememberNavBackStack คีย์การนำทางของคุณต้องสามารถแปลงเป็นอนุกรมได้
  • จัดการการแปลงเป็นอนุกรมและการแปลงกลับเป็นออบเจ็กต์ด้วยตนเอง: คุณมีหน้าที่รับผิดชอบในการบันทึกการแสดงผลที่แปลงเป็นอนุกรมของแต่ละคีย์ลงในพื้นที่เก็บข้อมูลถาวร (เช่น SharedPreferences, ฐานข้อมูล หรือไฟล์) และแปลงกลับเป็นออบเจ็กต์ด้วยตนเองเมื่อแอปของคุณกำลังจะทำงานในเบื้องหลังหรือกำลังได้รับการกู้คืน

กำหนดขอบเขตอินสแตนซ์ ViewModel รายการเป็นออบเจ็กต์ NavEntry รายการ

ViewModels ใช้เพื่อคงสถานะที่เกี่ยวข้องกับ UI ไว้เมื่อมีการเปลี่ยนแปลงการกำหนดค่า เช่น การหมุนหน้าจอ โดยค่าเริ่มต้น ViewModels จะกำหนดขอบเขตเป็น ViewModelStoreOwner ที่ใกล้ที่สุด ซึ่งโดยปกติจะเป็น Activity หรือ Fragment

อย่างไรก็ตาม คุณอาจต้องการกำหนดขอบเขตของ ViewModel ให้เป็น NavEntry ที่เฉพาะเจาะจง (เช่น หน้าจอหรือปลายทางที่เฉพาะเจาะจง) ใน Back Stack แทนที่จะเป็น Activity ทั้งหมด วิธีนี้ช่วยให้มั่นใจได้ว่าระบบจะเก็บสถานะของ ViewModel ไว้เฉพาะในขณะที่ NavEntry นั้นเป็นส่วนหนึ่งของ Back Stack และจะล้างสถานะเมื่อนำ NavEntry ออก

ไลบรารีส่วนเสริม androidx.lifecycle:lifecycle-viewmodel-navigation3 มี NavEntryDecorator ที่ช่วยอำนวยความสะดวกในเรื่องนี้ เดคอเรเตอร์นี้จะให้ ViewModelStoreOwner สำหรับ NavEntry แต่ละรายการ เมื่อคุณสร้าง ViewModel ภายในเนื้อหาของ NavEntry (เช่น การใช้ viewModel() ใน Compose) ระบบจะกำหนดขอบเขตให้กับคีย์ของ NavEntry นั้นๆ ใน Back Stack โดยอัตโนมัติ ซึ่งหมายความว่าระบบจะสร้าง ViewModel เมื่อเพิ่ม NavEntry ลงใน Back Stack และล้างเมื่อนำออก

หากต้องการใช้ NavEntryDecorator เพื่อกำหนดขอบเขต ViewModel ไปยัง NavEntry ให้ทำตามขั้นตอนต่อไปนี้

  1. เพิ่มทรัพยากร Dependency androidx.lifecycle:lifecycle-viewmodel-navigation3 ลงในไฟล์ app/build.gradle.kts
  2. เพิ่ม rememberSaveableStateHolderNavEntryDecorator() เริ่มต้นลงในรายการ entryDecorators เมื่อสร้าง NavDisplay
  3. เพิ่ม rememberViewModelStoreNavEntryDecorator() ลงในรายการ entryDecorators

NavDisplay(
    entryDecorators = listOf(
        // Add the default decorators for managing scenes and saving state
        rememberSaveableStateHolderNavEntryDecorator(),
        // Then add the view model store decorator
        rememberViewModelStoreNavEntryDecorator()
    ),
    backStack = backStack,
    entryProvider = entryProvider { },
)