Android使用popUpTo导航清栈后Fragment导航栏显示返回按钮问题

问题背景 #

项目基于Android Studio 「New | Activity | Basic Activity」向导生成，包含两个Fragment：第一个改造为登录页，第二个为应用主页。需求为登录完成后清空返回栈，跳转至主页时按返回键直接退出应用，不回退到登录页。

初始实现通过导航动作配置完成了清栈逻辑：

• 导航图action配置：

app:popUpTo="@id/FirstFragment"
app:popUpToInclusive="true"

• 导航执行代码：

NavHostFragment
    .findNavController(this)
    .navigate(R.id.action_FirstFragment_to_SecondFragment)

该实现的清栈效果符合预期，但存在异常：跳转至主页（SecondFragment）后，标题栏仍显示无实际功能的返回箭头，此时返回栈已无页面可弹出，点击箭头无响应。

排查过程中确认两个基础逻辑：

1. 初期无法生成FirstFragmentDirections类的原因是Safe Args配置不全，必须同时配置对应的maven仓库和插件，多数零散资料仅提及插件配置，会导致类生成失败。
2. 返回箭头的默认显示规则和导航图的app:startDestination属性绑定：只有被配置为startDestination的启动页默认不显示返回箭头，其余目的地默认显示返回箭头。

可落地方案 #

方案1：自定义顶级页面配置（推荐，无侵入） #

NavigationUI 默认仅将导航图中配置的startDestination识别为顶级页面，顶级页面默认不显示返回箭头。在宿主Activity初始化导航逻辑时，手动把主页也加入顶级页面集合即可，不需要修改原有导航跳转逻辑：

// 替换Activity中原有的NavigationUI绑定ActionBar的代码
val navController = findNavController(R.id.nav_host_fragment_content_main)
// 传入所有需要隐藏返回箭头的顶级页ID
val appBarConfig = AppBarConfiguration(
    setOf(R.id.FirstFragment, R.id.SecondFragment)
)
NavigationUI.setupActionBarWithNavController(this, navController, appBarConfig)

该配置下，只要当前栈顶是集合内的页面，就会自动隐藏返回箭头：登录页作为启动页正常无箭头，登录跳转后清栈到主页也不会出现无效箭头，其他普通业务页不受影响，仍按默认规则显示返回箭头。

方案2：单页面手动控制箭头显示 #

如果不想修改全局导航配置，可以直接在主页Fragment中手动控制ActionBar的返回按钮显示：

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    super.onViewCreated(view, savedInstanceState)
    // 如果使用自定义Toolbar，替换为对应Toolbar实例的对应方法即可
    (requireActivity() as AppCompatActivity).supportActionBar?.setDisplayHomeAsUpEnabled(false)
}

如果担心其他页面跳转回主页时配置被覆盖，可以给NavController加目的地变化监听，全局匹配到主页时就自动隐藏箭头：

// 在宿主Activity中添加监听即可
navController.addOnDestinationChangedListener { _, destination, _ ->
    if (destination.id == R.id.SecondFragment) {
        supportActionBar?.setDisplayHomeAsUpEnabled(false)
    }
}

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