1.前言

不管你之前用没用过Jetpack Navigation组件，但是或多或少你也可能听说过它。它是Jetpack库中的一个路由组件。此刻你的脑海中可能会浮现阿里ARouter框架。如果你熟悉ARouter但是对Navigation比较陌生，那么你先简单把它们联系在一起，有个直观的感受。

如果你对ARouter和Navigation都不太熟悉，没关系，并不影响你对本文的阅读。

Navigation支持Activity、Fragment、Dialog的路由跳转，功能非常强大。此刻灵魂拷问一下。

你知道Navigation是如何实现Activity、Fragment组件的跳转吗？

你知道Navigation如何接管系统返回键操作的?

第一个问题，在不看源码的情况下，我们大概也能略猜一二，Activity的路由是通过startActivity(intent)方法来实现的，Fragment的路由是通过FragmentTransaction的replace方法来实现的。关于真正的跳转原理，之后会出专文讲解，敬请关注本公众号，及时获取更文通知。

第二个问题，在不深入理解源码的情况下，如果被问到，我会直接被问懵。难道是重写onBackPressed()？

好了，不卖关子了，Navigation组件是通过FragmentTransaction.setPrimaryNavigationFragment()方法接管系统返回键操作的。有源码为证：

//NavHostFragment.java
public void onAttach(@NonNull Context context) {
    super.onAttach(context);
    // TODO This feature should probably be a first-class feature of the Fragment system,
    // but it can stay here until we can add the necessary attr resources to
    // the fragment lib.
    if (mDefaultNavHost) {
        getParentFragmentManager().beginTransaction()
                .setPrimaryNavigationFragment(this)
                .commit();
    }
}

NavHostFragment从字面意思理解，它是Navigation组件的导航宿主组件。Fragment组件如果想要在Navigation框架中实现路由功能必须满足两个条件：

1. Fragment必须依附在NavHostFragment上
2. NavHostFragment必须成为PrimaryNavigationFragment（后文简称：主导航Fragment）

行文至此，你可能有点懵，但是没关系，你只需要知道有主导航Fragment这个概念就行，接着往下看

本文的主角是setPrimaryNavigationFragment()，它是Fragment框架中的方法，它并不是什么新鲜玩意，它跟随Fragment框架一起发布的。但是很吊诡地是，翻遍所有的技术社区，都很难找到讲解它的文章。但是它真的很重要，它是Navigation组件的基础设施（水和电）。

要想深入理解Navigation实现原理，必须对Fragment实现原理深入了解。FragmentTransaction、BackStackRecord、FragmentManager等概念必须成竹于胸。推荐阅读深入理解Navigation架构之Fragment基础一文，扎扎实实掌握Fragment知识。

说回NavHostFragment

//NavHostFragment.java
public class NavHostFragment extends Fragment implements NavHost {
    public void onAttach(@NonNull Context context) {
        super.onAttach(context);
        // TODO This feature should probably be a first-class feature of the Fragment system,
        // but it can stay here until we can add the necessary attr resources to
        // the fragment lib.
        if (mDefaultNavHost) {
            getParentFragmentManager().beginTransaction()
                    .setPrimaryNavigationFragment(this)
                    .commit();
        }
    }
}

很简单的几行代码，却藏着不少信息

1. NavHostFragment是导航宿主Fragment，要实现路由跳转的Fragment都是它的child Fragment。这里就涉及到childFragmentManager，parentFragmentManager等知识了。
   
2. mDefaultNavHost是要设置成true，NavHostFragment才能成为主导航Fragment。
   
3. 从注释中，可以看出，setPrimaryNavigationFragment()虽然很不起眼，它即将升级为Fragment的一类公民了(first-class)。
   

2. FragmentManager 回退栈

栈是一种很简单的数据结构。它的特点是“后进先出”。在FragmentManager中回退栈定义如下：

public abstract class FragmentManager{
    ArrayList<BackStackRecord> mBackStack;
}

在FragmentTransaction中有addToBackStack(String name)方法，可以将某个方法加入回退栈中。

class FragmentActvitiy1: AppCompatActivity() {
  fun addFragmentNotAddToBackStack() {
      supportFragmentManager.commit {
            setReorderingAllowed(true)
            add<AFragment>(R.id.top_fragment_container_view)
      }
      supportFragmentManager.commit {
            setReorderingAllowed(true)
            add<BFragment>(R.id.top_fragment_container_view)
      }
  }
}

class FragmentActvitiy2: AppCompatActivity() {
  fun addFragmentNotAddToBackStack() {
      supportFragmentManager.commit {
            setReorderingAllowed(true)
            add<AFragment>(R.id.top_fragment_container_view)
            addToBackStack(null)
      }
      supportFragmentManager.commit {
            setReorderingAllowed(true)
            add<BFragment>(R.id.top_fragment_container_view)
            addToBackStack(null)
      }
  }

上述两段代码，唯一的区别就是FragmentActivity1没有调用addToBackStack()方法，而

FragmentActivity2调用了。

FragmentActivity1 按返回键效果如下：

FragmentActivity2 按返回键效果如下：

3. FragmentManager处理返回原理

handleOnBackPressed() 处理逻辑如下：

当回退栈中有记录时，调用popBackStackImmediate(),该方法调用popBackStackImmediate(String name, int id, int flags)

代码1处就是处理当前FragmentManager有主导航Fragment时的返回场景。如果主导航Fragment不为空时，交由childManager处理返回。如果childMananger拦截了返回键处理则返回，否则继续让当前FragmentManager处理。具体场景，后文详解。

代码2处 popBackStackState(ArrayList records, ArrayList isRecordPop, String name, int id, int flags)的作用是将回退栈中的FragmentTransaction(BackStackRecord)放到records集合中，以备后用。

出栈分为4种情况(简单起见，id不考虑了，否则根据排列组合有8中情况)

POP_BACK_STACK_INCLUSIVE = 1时表示，根据name找到返回栈里面的BackStackRecord，一起出栈。

假设有回退栈如下。我们来走下四种case。

case->popBackStack(null,0)

代码3处 removeRedundantOperationsAndExecute(mTmpRecords, mTmpIsPop)真正执行出栈操作。最终执行到executeOpsTogether方法。深入理解Navigation架构之Fragment基础一文有详细讲解。

4. setPrimaryNavigationFragment

经过前面那么多的铺垫，终于来到讲解本文主角setPrimaryNavigationFragment了(下文简称：“主导航Fragment”)。前文例子，我们都是基于FragmentActivity平铺Fragment场景讲解的。如果Fragment嵌套Fragment，该如何处理返回栈呢。“主导航Fragment”就是为了解决嵌套Fragment而设计的。前文讲到“Fragment必须依附在NavHostFragment上”，其实就是嵌套Fragment了。

从上图我们看到有三种角色。HostActivity，HostFragment，Child Fragment(s)。

HostFragment就是通过成为“主导航Fragment”，接管Activity的处理返回操作，并且将返回操作交由ChildFragment(s)去处理。作用可谓“承上启下”。

文字描述始终有点晦涩难懂。上场景图解。

分两种场景。

Case1 伪代码如下

Case2 伪代码如下

返回场景如下

Case1