使用場景：

使用Navigation完成fragment間的跳轉操作。

---

問題描述：

Navigation 實現 fragment 間的跳轉用的是replace()方法，此方法會移除原來的fragment，再新增新的fragment，所以回到上一個fragment時就需要重新走一遍生命週期流程，重新載入資料。

---

解決方案：

分析 NavController類 中的navigate 原始碼

private void navigate(@NonNull NavDestination node, @Nullable Bundle args,
            @Nullable NavOptions navOptions, @Nullable Navigator.Extras navigatorExtras) {
        ...
        Navigator<NavDestination> navigator = mNavigatorProvider.getNavigator(
                node.getNavigatorName());  根據節點名稱生成不同的navigator
        Bundle finalArgs = node.addInDefaultArgs(args);
        NavDestination newDest = navigator.navigate(node, finalArgs,
                navOptions, navigatorExtras);  呼叫navigator 中的 navigate方法
       ...
    }

getNavigator 原始碼如下

private final HashMap<String, Navigator<? extends NavDestination>> mNavigators =
        new HashMap<>();

public <T extends Navigator<?>> T getNavigator(@NonNull String name) {
    if (!validateName(name)) {
        throw new IllegalArgumentException("navigator name cannot be an empty string");
    }

    Navigator<? extends NavDestination> navigator = mNavigators.get(name); // 根據傳入的node獲取不同的navigator
    if (navigator == null) {
        throw new IllegalStateException("Could not find Navigator with name \"" + name
                + "\". You must call NavController.addNavigator() for each navigation type.");
    }
    return (T) navigator;
}

因此，想要呼叫自定義navigate()方法就需要 自定義一個Navigator類，同時改變fragment節點名稱，將fragment節點名稱與Navigator類作為key，value 新增到 HashMap型別的mNavigators中。

自定義Navigator

@Navigator.Name("custom_fragment")  // 節點名稱定義為custom_fragment,作為 mNavigatorProvider 變數的 key
class CustomNavigator(  //作為 mNavigatorProvider 變數的 value
    private val context: Context,
    private val manager: FragmentManager,
    private val containerId: Int
) : FragmentNavigator(context, manager, containerId) {

    override fun navigate(  // 重寫 navigate 方法
        destination: Destination,
        args: Bundle?,
        navOptions: NavOptions?,
        navigatorExtras: Navigator.Extras?
    ): NavDestination? {
        val tag = destination.id.toString() // 跳轉目的地
        val transaction = manager.beginTransaction() // 開啟fragment事務

        val currentFragment = manager.primaryNavigationFragment // navigation 頂層fragment
        if (currentFragment != null) {
            transaction.hide(currentFragment)   // 隱藏當前fragment
        }

        var fragment = manager.findFragmentByTag(tag)   // 找到目的地fragment
        if (fragment == null) { // fragment未被初始化
            val className = destination.className
            fragment = manager.fragmentFactory.instantiate(context.classLoader, className) // 例項化 fragment
            transaction.add(containerId, fragment, tag) // 將碎片新增到容器中
        } else { // fragment 已經初始化過了
            transaction.show(fragment) // 顯示fragment
        }

        transaction.setPrimaryNavigationFragment(fragment) //將fragment 設定為頂層fragment
        transaction.setReorderingAllowed(true)
        transaction.commitNow() // 提交事務

        return destination // 返回目的地，用於監聽
    }
}

修改節點名稱

因為節點名稱定義為custom_fragment，所以修改為<custom_fragment>

<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/my_nav"
    app:startDestination="@id/home_dest"
    tools:ignore="UnusedNavigation">

    <custom_fragment
        android:id="@+id/home_dest"
        android:name="com.cl.androidstudy.ui.home.HomeFragment"
        android:label="fragment_home"
        tools:layout="@layout/fragment_home" />
    <custom_fragment
        android:id="@+id/system_dest"
        android:name="com.cl.navicationtest.SystemFragment"
        android:label="fragment_system"
        tools:layout="@layout/fragment_system" />
    <custom_fragment
        android:id="@+id/square_dest"
        android:name="com.cl.navicationtest.SquareFragment"
        android:label="fragment_square"
        tools:layout="@layout/fragment_square" />
    <custom_fragment
        android:id="@+id/me_dest"
        android:name="com.cl.androidstudy.ui.me.MeFragment"
        android:label="fragment_me"
        tools:layout="@layout/fragment_me" />
</navigation>

邏輯程式碼

val navController = Navigation.findNavController(this, R.id.fragment) // 建立navController
val navHostFragment = supportFragmentManager.findFragmentById(R.id.fragment)!!
val navigator = CustomNavigator(
    this,
    navHostFragment.childFragmentManager,
    R.id.fragment
)// 生成自定義Navigator物件
navController.navigatorProvider.addNavigator("custom_fragment", navigator) // 新增 key, value
navController.setGraph(R.navigation.my_nav)  // 要在 CustomNavigator 類被載入之後新增graph，不然找不到 custom_fragment節點

參考部落格: https://juejin.im/post/6844903896104747022#heading-2