自定义BottomNavigationView多返回栈导航异常问题排查

问题场景 #

我正在给自定义BottomNavigationView实现多返回栈支持，未使用NavigationUI自带的带菜单项的BottomNavigationView。通过以下代码关联NavController：

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

bottomNavigationView.setupWithNavController(navController)

按照官方文档《手动使用底层API实现支持》的要求，在<action>元素中添加了app:restoreState="true"和app:popUpToSaveState="true"属性，但遇到以下异常：

• 应用启动后，AlphaFragment正常显示；
• 通过navigate_to_beta_from_alpha导航至BetaFragment，操作正常；
• 调用navigate_to_alpha_from_beta返回AlphaFragment时无反应，BetaFragment仍显示；
• 再次尝试导航至BetaFragment时崩溃，报错：

  java.lang.IllegalArgumentException: Navigation action/destination com.example.app:id/navigate_to_beta_from_alpha cannot be found from the current destination Destination(com.example.app:id/betaFragment) label=Beta class=com.example.app.ui.BetaFragment
  

相关配置文件 #

nav_graph.xml #

<?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"
    android:id="@+id/nav_graph"
    app:startDestination="@+id/alpha">

    <include app:graph="@navigation/alpha"/>
    <include app:graph="@navigation/beta"/>
</navigation>

alpha.xml #

<?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/alpha"
    app:startDestination="@+id/alphaFragment">
    <fragment
        android:id="@+id/alphaFragment"
        android:name="com.example.ui.AlphaFragment"
        android:label="Alpha"
        tools:layout="@layout/fragment_alpha"/>
    <action
        android:id="@+id/navigate_to_beta_from_alpha"
        app:destination="@+id/beta"
        app:popUpTo="@id/alphaFragment"
        app:popUpToSaveState="true"
        app:restoreState="true" />
</navigation>

beta.xml #

<?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/beta"
    app:startDestination="@+id/betaFragment">
<fragment
        android:id="@+id/betaFragment"
        android:name="com.example.ui.BetaFragment"
        android:label="Beta"
        tools:layout="@layout/fragment_beta"/>
<action
        android:id="@+id/navigate_to_alpha_from_beta"
        app:destination="@+id/alpha"
        app:popUpTo="@id/betaFragment"
        app:popUpToSaveState="true"
        app:restoreState="true" />
</navigation>

activity_main.xml #

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout 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:layout_width="match_parent"
    android:layout_height="match_parent">

    <androidx.fragment.app.FragmentContainerView
        android:id="@+id/nav_host_fragment"
        android:name="androidx.navigation.fragment.NavHostFragment"
        android:layout_width="0dp"
        android:layout_height="0dp"
        app:defaultNavHost="true"
        app:layout_constraintBottom_toTopOf="@+id/bottomNavigationView"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:navGraph="@navigation/nav_graph" />

    <com.example.app.ui.custom.BottomNavigationView
        android:id="@+id/bottomNavigationView"
        android:layout_width="0dp"
        android:layout_height="88dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent" />
</androidx.constraintlayout.widget.ConstraintLayout>

问题原因分析及解决方案 #

1. 导航Action配置错误（核心原因） #

当前的popUpTo目标设置为单个Fragment（alphaFragment/betaFragment），而非子导航图的根节点（alpha/beta），导致多返回栈状态无法正确保存和恢复：

• 从Alpha导航到Beta时，popUpTo="@id/alphaFragment"会弹出AlphaFragment并保存其状态，但返回栈会被清空，导航到Beta后，返回栈仅包含BetaFragment；
• 调用返回Alpha的Action时，popUpTo="@id/betaFragment"弹出BetaFragment，此时返回栈为空，尝试恢复Alpha状态时，因为保存的是单个Fragment状态而非整个导航图的栈状态，Navigation无法正确重建页面，导致无反应；
• 崩溃是因为此时NavController的当前目的地仍为BetaFragment，若误调用了仅在AlphaFragment下存在的navigate_to_beta_from_alphaAction，就会触发找不到Action的异常。

修正后的Action配置：

alpha.xml中的Action

<action
    android:id="@+id/navigate_to_beta_from_alpha"
    app:destination="@+id/beta"
    app:popUpTo="@id/alpha" <!-- 改为子导航图根节点 -->
    app:popUpToSaveState="true"
    app:restoreState="true" />

beta.xml中的Action

<action
    android:id="@+id/navigate_to_alpha_from_beta"
    app:destination="@+id/alpha"
    app:popUpTo="@id/beta" <!-- 改为子导航图根节点 -->
    app:popUpToSaveState="true"
    app:restoreState="true" />

2. 自定义BottomNavigationView的导航逻辑验证 #

如果你的自定义BottomNavigationView并非继承自官方BottomNavigationView，setupWithNavController方法可能无法正确绑定导航切换逻辑。需确保：

• 自定义View正确实现了底部导航项的点击监听；
• 点击时调用navController.navigate()切换到对应子导航图，而非直接调用Fragment的Action；
• 避免重复调用错误的Action（比如在Beta页面误触发Alpha页面的导航Action）。

3. 额外验证点 #

• 确认NavController的defaultNavHost已设置为true（你在activity_main.xml中已配置），确保返回键能正确处理返回栈；
• 测试时可通过navController.currentDestination打印当前目的地，确认导航状态是否符合预期。

内容的提问来源于stack exchange，提问作者sunshine