多节点导航架构下Toolbar返回键事件监听异常问题排查

问题描述 #

使用官方Navigation组件时遇到以下场景问题：

• 导航结构包含多分支节点（如Login→MainModule1→SubModule1、MainModule1→MainModule2→SubModule4等），进入SubModule1后，点击Toolbar返回键，Fragment中通过requireActivity().onBackPressedDispatcher.addCallback()注册的返回回调未触发，但物理返回键可正常触发该回调。
• 若在MainActivity中添加onOptionsItemSelected直接调用onBackPressed()处理home键，虽能触发SubModule1的回调，但会导致汉堡菜单模式异常：点击汉堡后再点home键会回到SubModule1，重启应用点击汉堡菜单时MainModule1出现闪烁。

问题原因 #

1. 默认Toolbar返回键逻辑不关联OnBackPressedCallback：
   setupActionBarWithNavController默认将Toolbar的home按钮与NavController.navigateUp()绑定，而非Activity的onBackPressed()。Fragment通过OnBackPressedDispatcher注册的回调仅在onBackPressed()被调用时触发，因此Toolbar返回键无法触发该回调。
2. 一刀切的home键处理破坏抽屉默认逻辑：
   直接在onOptionsItemSelected中调用onBackPressed()，会覆盖Navigation对汉堡菜单的默认处理：当处于AppBarConfiguration定义的顶层目的地时，home按钮本应打开抽屉，现在却执行返回逻辑，导致抽屉相关的异常行为。

解决方案 #

重写onSupportNavigateUp()方法，区分当前是返回箭头还是汉堡菜单场景，分别处理：

步骤1：移除错误的onOptionsItemSelected处理 #

删除MainActivity中之前添加的home键处理代码，避免与Navigation的默认逻辑冲突。

步骤2：重写onSupportNavigateUp() #

override fun onSupportNavigateUp(): Boolean {
    val navController = findNavController(R.id.nav_host_fragment_content_main)
    // 判断当前页面是否为AppBarConfiguration定义的顶层目的地
    val isTopLevel = appBarConfiguration.topLevelDestinations.contains(navController.currentDestination?.id)
    
    return if (!isTopLevel) {
        // 非顶层页面，触发返回回调（对应Toolbar返回箭头）
        onBackPressed()
        true
    } else {
        // 顶层页面，执行默认逻辑（打开抽屉，对应汉堡菜单）
        navController.navigateUp(appBarConfiguration) || super.onSupportNavigateUp()
    }
}

效果验证 #

• 进入SubModule1时，Toolbar显示返回箭头，点击后触发Fragment的OnBackPressedCallback，执行自定义导航并传递参数回MainModule1。
• 处于顶层目的地（如MainModule1）时，Toolbar显示汉堡菜单，点击正常打开抽屉，无异常跳转或闪烁问题。

补充说明 #

Fragment中的回调注册逻辑无需修改，确保在onAttach中绑定Fragment生命周期即可：

override fun onAttach(context: Context) {
    super.onAttach(context)
    val callback = object : OnBackPressedCallback(true) {
        override fun handleOnBackPressed() {
            val action = AccountProfileFragmentDirections.goBackToDashboardFromAccountProfile(currentAccount)
            findNavController().navigate(action)
        }
    }
    requireActivity().onBackPressedDispatcher.addCallback(this, callback)
}

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