更新Jetpack Compose依赖后Navigation状态保存失效如何修复

问题根因 #

navigation-compose从2.4.0版本开始对状态恢复逻辑做了两个不兼容变更，直接导致原有逻辑失效：

1. 状态恢复的触发逻辑变更：老版本alpha07中，restoreState() 无论何时调用都会直接覆盖当前NavController的返回栈。新版本中，NavHost 初始化完成后会给NavController标记「导航图已初始化」状态，此时再调用restoreState()不会主动回退/切换当前可见的目的地，只会恢复后台返回栈。而你原有代码中restoreState()是放在DisposableEffect中执行，DisposableEffect的执行时机晚于当前Composable内所有UI节点的初始化，也就是NavHost已经初始化完成并加载了startDestination之后才会执行恢复逻辑，自然无效。
2. 返回键处理逻辑变更：新版本NavController默认和当前Composable的Lifecycle绑定，当Tab切换导致EmployeesTab被移除组合时，NavController会自动禁用返回键监听，你原有代码中onDispose里手动调用enableOnBackPressed(false)会打乱内部的状态绑定，反而导致恢复后的返回栈无法响应返回键。

修复方案 #

方案1：最小改动适配原有逻辑 #

只需要调整恢复逻辑的执行时机，删除多余的返回键控制代码即可：

@Composable
fun EmployeesTab(navState: MutableState<Bundle>) {
    val navController = rememberNavController()
    // 在NavHost初始化之前同步恢复状态，不要放在Effect里延迟执行
    navController.restoreState(navState.value)
    
    DisposableEffect(navController) {
        val callback = NavController.OnDestinationChangedListener { controller, _, _ ->
            navState.value = controller.saveState() ?: Bundle()
        }
        navController.addOnDestinationChangedListener(callback)

        onDispose {
            navController.removeOnDestinationChangedListener(callback)
            // 删除手动控制返回键的代码
        }
    }

    NavHost(navController, startDestination = "employees") {
        // 原有导航配置保持不变
        composable("employees") {
            appBarViewModel.onNavigate(AppScreen.Employees, navController)
            Employees(it.hiltViewModel(), navController)
        }
        composable("employee/{userId}") {
            appBarViewModel.onNavigate(AppScreen.EmployeeDetails, navController)
            Employee(it.hiltViewModel())
        }
    }
}

方案2：用官方内置多返回栈方案（更推荐） #

2.4.0版本开始navigation-compose已经原生支持多Tab返回栈保存恢复，不需要手动维护每个Tab的NavController和状态Bundle，只需要修改BottomNavigation的点击逻辑即可：

// 顶层只需要一个全局NavController
val navController = rememberNavController()
// BottomNavigationItem点击逻辑修改为：
BottomNavigationItem(
    selected = currentDestination?.hierarchy?.any { it.route == tabRoute } == true,
    onClick = {
        navController.navigate(tabRoute) {
            // 点击Tab时回退到根导航节点，同时保存当前Tab的返回栈
            popUpTo(navController.graph.findStartDestination().id) {
                saveState = true
            }
            // 避免重复创建同一个Tab实例
            launchSingleTop = true
            // 切换Tab时恢复之前保存的返回栈
            restoreState = true
        }
    }
)

该方案官方已经做了全场景适配，不需要自己处理状态保存恢复，代码简洁性和稳定性都更高。

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