โต้ตอบกับคอมโพเนนต์การนำทางแบบเป็นโปรแกรม

คอมโพเนนต์การนำทางมีวิธีสร้างและโต้ตอบกับองค์ประกอบการนำทางบางอย่างแบบเป็นโปรแกรม

สร้าง NavHostFragment

คุณสามารถใช้ NavHostFragment.create() เพื่อสร้าง NavHostFragment ที่มีทรัพยากรกราฟที่เฉพาะเจาะจงแบบเป็นโปรแกรมได้ ดังที่แสดงในตัวอย่างต่อไปนี้

Kotlin

val finalHost = NavHostFragment.create(R.navigation.example_graph)
supportFragmentManager.beginTransaction()
    .replace(R.id.nav_host, finalHost)
    .setPrimaryNavigationFragment(finalHost) // equivalent to app:defaultNavHost="true"
    .commit()

Java

NavHostFragment finalHost = NavHostFragment.create(R.navigation.example_graph);
getSupportFragmentManager().beginTransaction()
    .replace(R.id.nav_host, finalHost)
    .setPrimaryNavigationFragment(finalHost) // equivalent to app:defaultNavHost="true"
    .commit();

โปรดทราบว่า setPrimaryNavigationFragment(finalHost) ช่วยให้ NavHost ของคุณขัดจังหวะการกดปุ่มย้อนกลับของระบบได้ นอกจากนี้ คุณยังใช้ลักษณะการทำงานนี้ใน XML NavHost ได้โดยเพิ่ม app:defaultNavHost="true" หากคุณกำลังใช้ลักษณะการทำงานของปุ่มย้อนกลับที่กำหนดเอง และไม่ต้องการให้ NavHost ขัดจังหวะการกดปุ่มย้อนกลับ คุณสามารถส่ง null ไปยัง setPrimaryNavigationFragment() ได้

ตั้งแต่ Navigation 2.2.0 เป็นต้นไป คุณสามารถรับข้อมูลอ้างอิงไปยัง NavBackStackEntry สำหรับปลายทางใดก็ได้ในสแต็กการนำทางโดยเรียกใช้ NavController.getBackStackEntry() และส่งรหัสปลายทาง หาก Back Stack มีอินสแตนซ์ของปลายทางที่ระบุมากกว่า 1 รายการ getBackStackEntry() จะแสดงผลอินสแตนซ์บนสุดจากสแต็ก

NavBackStackEntry ที่แสดงผลจะมีออบเจ็กต์ต่อไปนี้ที่ระดับปลายทาง

ออบเจ็กต์เหล่านี้จะใช้ได้ตลอดอายุการใช้งานของปลายทางใน Back Stack เมื่อปลายทางที่เชื่อมโยงถูกนำออกจาก Back Stack ระบบจะทำลาย Lifecycle ไม่บันทึกสถานะอีกต่อไป และล้างออบเจ็กต์ ViewModel ทั้งหมด

พร็อพเพอร์ตี้เหล่านี้จะให้ Lifecycle และที่เก็บสำหรับออบเจ็กต์และคลาส ViewModel ที่ทำงานร่วมกับสถานะที่บันทึกไว้ ไม่ว่าคุณจะใช้ปลายทางประเภทใดก็ตาม

ซึ่งจะเป็นประโยชน์อย่างยิ่งเมื่อทำงานกับประเภทปลายทางที่ไม่มี Lifecycle ที่เชื่อมโยงโดยอัตโนมัติ เช่น ปลายทางที่กำหนดเอง

ตัวอย่างเช่น คุณสามารถสังเกต Lifecycle ของ NavBackStackEntry ได้เช่นเดียวกับที่สังเกต Lifecycle ของ Fragment หรือกิจกรรม นอกจากนี้ NavBackStackEntry ยังเป็น LifecycleOwner ซึ่งหมายความว่าคุณสามารถใช้เมื่อสังเกต LiveData หรือใช้กับคอมโพเนนต์อื่นๆ ที่รับรู้วงจรได้ ดังที่แสดงในตัวอย่างต่อไปนี้

Kotlin

myViewModel.liveData.observe(backStackEntry, Observer { myData ->
    // react to live data update
})

Java

myViewModel.getLiveData().observe(backStackEntry, myData -> {
    // react to live data update
});

สถานะวงจรจะอัปเดตโดยอัตโนมัติทุกครั้งที่คุณเรียกใช้ navigate() สถานะวงจรของปลายทางที่ไม่ได้อยู่ที่ด้านบนของ Back Stack จะเปลี่ยนจาก RESUMED เป็น STARTED หากปลายทางยังคงมองเห็นได้ภายใต้ปลายทาง FloatingWindow เช่น ปลายทางกล่องโต้ตอบ หรือเปลี่ยนเป็น STOPPED ในกรณีอื่นๆ

การแสดงผลลัพธ์ไปยังปลายทางก่อนหน้า

ใน Navigation 2.3 ขึ้นไป NavBackStackEntry จะให้สิทธิ์เข้าถึง SavedStateHandle SavedStateHandle คือแผนที่คีย์-ค่าที่ใช้จัดเก็บและดึงข้อมูลได้ ค่าเหล่านี้จะยังคงอยู่ตลอดการสิ้นสุดการประมวลผล รวมถึงการเปลี่ยนแปลงการกำหนดค่า และยังคงใช้งานได้ผ่านออบเจ็กต์เดียวกัน เมื่อใช้ SavedStateHandle ที่ระบุ คุณจะเข้าถึงและส่งข้อมูลระหว่างปลายทางได้ ซึ่งมีประโยชน์อย่างยิ่งในฐานะกลไกในการรับข้อมูลกลับจากปลายทางหลังจากที่นำออกจากสแต็กแล้ว

หากต้องการส่งข้อมูลกลับไปยังปลายทาง A จากปลายทาง B ให้ตั้งค่าปลายทาง A เพื่อรอฟังผลลัพธ์ใน SavedStateHandle ก่อน โดยให้ดึงข้อมูล NavBackStackEntry โดยใช้ API getCurrentBackStackEntry() แล้วobserve LiveData ที่ SavedStateHandle มีให้

Kotlin

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    val navController = findNavController();
    // We use a String here, but any type that can be put in a Bundle is supported
    navController.currentBackStackEntry?.savedStateHandle?.getLiveData<String>("key")?.observe(
        viewLifecycleOwner) { result ->
        // Do something with the result.
    }
}

Java

@Override
public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
    NavController navController = NavHostFragment.findNavController(this);
    // We use a String here, but any type that can be put in a Bundle is supported
    MutableLiveData<String> liveData = navController.getCurrentBackStackEntry()
            .getSavedStateHandle()
            .getLiveData("key");
    liveData.observe(getViewLifecycleOwner(), new Observer<String>() {
        @Override
        public void onChanged(String s) {
            // Do something with the result.
        }
    });
}

ในปลายทาง B คุณต้องsetผลลัพธ์ในSavedStateHandleของปลายทาง A โดยใช้ getPreviousBackStackEntry() API

Kotlin

navController.previousBackStackEntry?.savedStateHandle?.set("key", result)

Java

navController.getPreviousBackStackEntry().getSavedStateHandle().set("key", result);

หากต้องการจัดการผลลัพธ์เพียงครั้งเดียว คุณต้องเรียกใช้ remove() ใน SavedStateHandle เพื่อล้างผลลัพธ์ หากไม่นำผลลัพธ์ออก LiveData จะยังคงแสดงผลลัพธ์ล่าสุดไปยังอินสแตนซ์ Observer ใหม่

ข้อควรพิจารณาเมื่อใช้ปลายทางของกล่องโต้ตอบ

เมื่อคุณnavigateไปยังปลายทางที่ใช้มุมมองแบบเต็มของNavHost (เช่น ปลายทาง <fragment>) ปลายทางก่อนหน้าจะหยุดวงจรการทำงาน ซึ่งจะป้องกันไม่ให้มีการเรียกกลับไปยัง LiveData ที่ได้จาก SavedStateHandle

อย่างไรก็ตาม เมื่อไปยังปลายทางของกล่องโต้ตอบ ปลายทางก่อนหน้าจะปรากฏบนหน้าจอด้วย และจะSTARTEDด้วยแม้ว่าจะไม่ใช่ปลายทางปัจจุบันก็ตาม ซึ่งหมายความว่าการเรียกใช้ getCurrentBackStackEntry() จากภายในเมธอดวงจร เช่น onViewCreated() จะแสดงผล NavBackStackEntry ของปลายทางกล่องโต้ตอบหลังจากการเปลี่ยนแปลงการกำหนดค่าหรือการสิ้นสุดการประมวลผลและการสร้างใหม่ (เนื่องจากกล่องโต้ตอบได้รับการกู้คืนเหนือปลายทางอื่นๆ) ดังนั้น คุณควรใช้ getBackStackEntry() กับรหัสของปลายทางเพื่อให้แน่ใจว่าคุณใช้ NavBackStackEntry ที่ถูกต้องเสมอ

ซึ่งหมายความว่า Observer ที่คุณตั้งค่าไว้ในผลลัพธ์ LiveData จะทำงานแม้ว่าปลายทางของกล่องโต้ตอบจะยังคงอยู่บนหน้าจอ หากต้องการตรวจสอบผลลัพธ์เฉพาะเมื่อปิดปลายทางกล่องโต้ตอบและปลายทางที่เกี่ยวข้องกลายเป็นปลายทางปัจจุบัน คุณสามารถสังเกต Lifecycle ที่เชื่อมโยงกับ NavBackStackEntry และดึงผลลัพธ์เฉพาะเมื่อกลายเป็น RESUMED

Kotlin

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    super.onViewCreated(view, savedInstanceState)
    val navController = findNavController();
    // After a configuration change or process death, the currentBackStackEntry
    // points to the dialog destination, so you must use getBackStackEntry()
    // with the specific ID of your destination to ensure we always
    // get the right NavBackStackEntry
    val navBackStackEntry = navController.getBackStackEntry(R.id.your_fragment)

    // Create our observer and add it to the NavBackStackEntry's lifecycle
    val observer = LifecycleEventObserver { _, event ->
        if (event == Lifecycle.Event.ON_RESUME
            && navBackStackEntry.savedStateHandle.contains("key")) {
            val result = navBackStackEntry.savedStateHandle.get<String>("key");
            // Do something with the result
        }
    }
    navBackStackEntry.lifecycle.addObserver(observer)

    // As addObserver() does not automatically remove the observer, we
    // call removeObserver() manually when the view lifecycle is destroyed
    viewLifecycleOwner.lifecycle.addObserver(LifecycleEventObserver { _, event ->
        if (event == Lifecycle.Event.ON_DESTROY) {
            navBackStackEntry.lifecycle.removeObserver(observer)
        }
    })
}

Java

@Override
public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
    super.onViewCreated(view, savedInstanceState);
    NavController navController = NavHostFragment.findNavController(this);
    // After a configuration change or process death, the currentBackStackEntry
    // points to the dialog destination, so you must use getBackStackEntry()
    // with the specific ID of your destination to ensure we always
    // get the right NavBackStackEntry
    final NavBackStackEntry navBackStackEntry = navController.getBackStackEntry(R.id.your_fragment);

    // Create our observer and add it to the NavBackStackEntry's lifecycle
    final LifecycleEventObserver observer = new LifecycleEventObserver() {
        @Override
        public void onStateChanged(@NonNull LifecycleOwner source, @NonNull Lifecycle.Event event) {
            if (event.equals(Lifecycle.Event.ON_RESUME)
                && navBackStackEntry.getSavedStateHandle().contains("key")) {
                String result = navBackStackEntry.getSavedStateHandle().get("key");
                // Do something with the result
            }
        }
    };
    navBackStackEntry.getLifecycle().addObserver(observer);

    // As addObserver() does not automatically remove the observer, we
    // call removeObserver() manually when the view lifecycle is destroyed
    getViewLifecycleOwner().getLifecycle().addObserver(new LifecycleEventObserver() {
        @Override
        public void onStateChanged(@NonNull LifecycleOwner source, @NonNull Lifecycle.Event event) {
            if (event.equals(Lifecycle.Event.ON_DESTROY)) {
                navBackStackEntry.getLifecycle().removeObserver(observer)
            }
        }
    });
}

Back Stack ของการนำทางจะจัดเก็บ NavBackStackEntry ไม่เพียงแต่สำหรับปลายทางแต่ละแห่งเท่านั้น แต่ยังรวมถึงกราฟการนำทางระดับบนแต่ละรายการที่มีปลายทางแต่ละแห่งด้วย ซึ่งช่วยให้คุณดึงข้อมูล NavBackStackEntry ที่กำหนดขอบเขตไว้ในกราฟการนำทางได้ NavBackStackEntry ที่กำหนดขอบเขตตามกราฟการนำทางช่วยให้คุณสร้าง ViewModel ที่กำหนดขอบเขตตามกราฟการนำทางได้ ซึ่งจะช่วยให้คุณแชร์ข้อมูลที่เกี่ยวข้องกับ UI ระหว่างปลายทางของกราฟได้ ออบเจ็กต์ ViewModel ที่สร้างขึ้นด้วยวิธีนี้จะคงอยู่จนกว่า NavHost ที่เกี่ยวข้องและ ViewModelStore ของออบเจ็กต์จะถูกล้าง หรือจนกว่ากราฟการนำทางจะถูกนำออกจาก Back Stack

ตัวอย่างต่อไปนี้แสดงวิธีดึงข้อมูล ViewModel ที่กำหนดขอบเขตไว้ในกราฟการนำทาง

Kotlin

val viewModel: MyViewModel
        by navGraphViewModels(R.id.my_graph)

Java

NavBackStackEntry backStackEntry = navController.getBackStackEntry(R.id.my_graph);
MyViewModel viewModel = new ViewModelProvider(backStackEntry).get(MyViewModel.class);

หากใช้ Navigation 2.2.0 หรือเก่ากว่า คุณต้องระบุโรงงานของคุณเองเพื่อใช้สถานะที่บันทึกไว้กับ ViewModel ดังที่แสดงในตัวอย่างต่อไปนี้

Kotlin

val viewModel: MyViewModel by navGraphViewModels(R.id.my_graph) {
    SavedStateViewModelFactory(requireActivity().application, requireParentFragment())
}

Java

NavBackStackEntry backStackEntry = navController.getBackStackEntry(R.id.my_graph);

ViewModelProvider viewModelProvider = new ViewModelProvider(
        backStackEntry.getViewModelStore(),
        new SavedStateViewModelFactory(
                requireActivity().getApplication(), requireParentFragment()));

MyViewModel myViewModel = provider.get(myViewModel.getClass());

ดูข้อมูลเพิ่มเติมเกี่ยวกับ ViewModel ได้ที่ภาพรวมของ ViewModel

การแก้ไขกราฟการนำทางที่ขยายแล้ว

คุณสามารถแก้ไขกราฟการนําทางที่ขยายแล้วแบบไดนามิกได้ที่รันไทม์

ตัวอย่างเช่น หากคุณมี BottomNavigationView ที่เชื่อมโยงกับ NavGraph ปลายทางเริ่มต้นของ NavGraph จะกำหนดแท็บที่เลือกเมื่อเริ่มต้นแอป อย่างไรก็ตาม คุณอาจต้องลบล้างลักษณะการทำงานนี้ เช่น เมื่อค่ากำหนดของผู้ใช้ระบุแท็บที่ต้องการให้โหลดเมื่อเริ่มต้นแอป หรือแอปอาจต้องเปลี่ยนแท็บเริ่มต้นตามพฤติกรรมที่ผ่านมาของผู้ใช้ คุณสามารถรองรับกรณีเหล่านี้ได้โดยระบุปลายทางเริ่มต้นของ NavGraph แบบไดนามิก

ลองพิจารณาNavGraphต่อไปนี้

<?xml version="1.0" encoding="utf-8"?>
<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/nav_graph"
    app:startDestination="@id/home">
    <fragment
        android:id="@+id/home"
        android:name="com.example.android.navigation.HomeFragment"
        android:label="fragment_home"
        tools:layout="@layout/fragment_home" />
    <fragment
        android:id="@+id/location"
        android:name="com.example.android.navigation.LocationFragment"
        android:label="fragment_location"
        tools:layout="@layout/fragment_location" />
    <fragment
        android:id="@+id/shop"
        android:name="com.example.android.navigation.ShopFragment"
        android:label="fragment_shop"
        tools:layout="@layout/fragment_shop" />
    <fragment
        android:id="@+id/settings"
        android:name="com.example.android.navigation.SettingsFragment"
        android:label="fragment_settings"
        tools:layout="@layout/fragment_settings" />
</navigation>

เมื่อโหลดกราฟนี้ แอตทริบิวต์ app:startDestination จะระบุว่าให้แสดง HomeFragment หากต้องการลบล้างปลายทางเริ่มต้นแบบไดนามิก ให้ทำดังนี้

  1. ก่อนอื่น ให้เติมลม NavGraph ด้วยตนเอง
  2. ลบล้างปลายทางเริ่มต้น
  3. สุดท้าย ให้แนบกราฟกับ NavController ด้วยตนเอง

Kotlin

val navHostFragment =
        supportFragmentManager.findFragmentById(R.id.nav_host_fragment) as NavHostFragment

val navController = navHostFragment.navController
val navGraph = navController.navInflater.inflate(R.navigation.bottom_nav_graph)
navGraph.startDestination = R.id.shop
navController.graph = navGraph
binding.bottomNavView.setupWithNavController(navController)

Java

NavHostFragment navHostFragment = (NavHostFragment) getSupportFragmentManager()
        .findFragmentById(R.id.nav_host_fragment);

NavController navController = navHostFragment.getNavController();
NavGraph navGraph = navController.getNavInflater().inflate(R.navigation.bottom_nav_graph);
navGraph.setStartDestination(R.id.shop);
navController.setGraph(navGraph);
NavigationUI.setupWithNavController(binding.bottomNavView, navController);

ตอนนี้เมื่อแอปเริ่มทำงาน ระบบจะแสดง ShopFragment แทน HomeFragment

เมื่อใช้ Deep Link NavController จะสร้าง Back Stack โดยอัตโนมัติสำหรับปลายทางของ Deep Link หากผู้ใช้ไปยัง Deep Link แล้วย้อนกลับ ผู้ใช้จะไปถึงจุดหมายเริ่มต้น ณ จุดใดจุดหนึ่ง การลบล้างจุดหมายเริ่มต้นโดยใช้เทคนิคในตัวอย่างก่อนหน้าช่วยให้มั่นใจได้ว่าระบบจะเพิ่มจุดหมายเริ่มต้นที่ถูกต้องลงใน Back Stack ที่สร้างขึ้น

โปรดทราบว่าเทคนิคนี้ยังช่วยให้ลบล้างแง่มุมอื่นๆ ของ NavGraph ได้ตามต้องการด้วย การแก้ไขกราฟทั้งหมดต้องทำก่อนการเรียกใช้ setGraph() เพื่อให้แน่ใจว่ามีการใช้โครงสร้างที่ถูกต้องเมื่อจัดการ Deep Link, กู้คืนสถานะ และย้ายไปยังปลายทางเริ่มต้นของกราฟ