Android-Jetpack笔记-Navigation之Fragment支持复用

上篇文章Android-Jetpack笔记-Navigation之Fragment使用提到,每次切换目的地,fragment是反复销毁重建的,按照谷歌推荐的1个APP只需1个activity的思路开发,这样是没问题的,但是这里的fragment是作为首页的3个常驻页面,我们是希望能够保存起来的,毕竟,销毁重建需要重新请求网络数据,重新初始化view,严重影响用户体验,那么接下来继续上篇文章的分析,支持Fragment的复用。

Jetpack笔记代码

本文源码基于SDK 29,IDE是Android studio 3.5.3

解决

给上篇文章的项目加些日志,从面板页切到通知页,再从通知页切回面板页,查看日志,

image

可见面板页发生了销毁重建,接着创建一个FixFragmentNavigator继承FragmentNavigator并重写navigate方法,直接把父类的实现copy过来,第1步,在调用fragment初始化的地方,改成复用:

//FixFragmentNavigator.java
NavDestination navigate(){
    //fix 1: 把类名作为tag,寻找已存在的Fragment
    //(如果想只针对个别fragment进行保活复用,可以在tag上做些标记比如加个前缀,这里不再展开)
    Fragment frag = mFragmentManager.findFragmentByTag(className);
    if (null == frag) {
        //不存在,则创建
        frag = instantiateFragment(mContext, mFragmentManager, className, args);
    }
}

第2步,将ft.replace换成show和hide

//FixFragmentNavigator.java
NavDestination navigate(){
    //        ft.replace(mContainerId, frag);
    //fix 2: replace换成show和hide
    List<Fragment> fragments = mFragmentManager.getFragments();
    for (Fragment fragment : fragments) {
        ft.hide(fragment);
    }
    if (!frag.isAdded()) {
        ft.add(mContainerId, frag, className);
    }
    ft.show(frag);
    ft.setPrimaryNavigationFragment(frag);
}

第3步,反射获取父类的mBackStack

//FixFragmentNavigator.java
NavDestination navigate(){
    //fix 3: mBackStack是私有的,而且没有暴露出来,只能反射获取
    ArrayDeque<Integer> mBackStack;
    try {
        Field field = FragmentNavigator.class.getDeclaredField("mBackStack");
        field.setAccessible(true);
        mBackStack = (ArrayDeque<Integer>) field.get(this);
    } catch (Exception e) {
        e.printStackTrace();
        return null;
    }
}

第4步,把父类的私有方法generateBackStackName也copy过来,

//FixFragmentNavigator.java
//fix 4: 从父类那边copy过来即可
private String generateBackStackName(int backStackIndex, int destId) {
    return backStackIndex + "-" + destId;
}

第5步,给FixFragmentNavigator加上注解给他取个名字,原因放后面说,

@Navigator.Name("fixFragment")
//fix 5: 需要指定1个名字,源码里自带的名字有navigation、activity、fragment、dialog
class FixFragmentNavigator extends FragmentNavigator {
}

至此FixFragmentNavigator就写好了,完整代码可以查看Jetpack笔记代码,接下来要如何把他使用进去呢?

先在布局文件中去掉app:navGraph="@navigation/mobile_navigation",然后来到activity,编写如下代码,

//NavigationActivity.java
void onCreate(Bundle savedInstanceState) {
    setContentView(R.layout.activity_navigation);
    BottomNavigationView navView = findViewById(R.id.nav_view);

    //获取页面容器NavHostFragment
    Fragment fragment = getSupportFragmentManager().findFragmentById(R.id.nav_host_fragment);
    //获取导航控制器
    NavController navController = NavHostFragment.findNavController(fragment);
    //创建自定义的Fragment导航器
    FixFragmentNavigator fragmentNavigator =
        new FixFragmentNavigator(this, fragment.getChildFragmentManager(), fragment.getId());
    //获取导航器提供者
    NavigatorProvider provider = navController.getNavigatorProvider();
    //把自定义的Fragment导航器添加进去
    provider.addNavigator(fragmentNavigator);
    //手动创建导航图
    NavGraph navGraph = initNavGraph(provider, fragmentNavigator);
    //设置导航图
    navController.setGraph(navGraph);
    //底部导航设置点击事件
    navView.setOnNavigationItemSelectedListener(item -> {
        navController.navigate(item.getItemId());
        return true;
    });
}

//手动创建导航图,把3个目的地添加进来
private NavGraph initNavGraph(NavigatorProvider provider, FixFragmentNavigator fragmentNavigator) {
    NavGraph navGraph = new NavGraph(new NavGraphNavigator(provider));

    //用自定义的导航器来创建目的地
    FragmentNavigator.Destination destination1 = fragmentNavigator.createDestination();
    destination1.setId(R.id.navigation_home);
    destination1.setClassName(HomeFragment.class.getCanonicalName());
    destination1.setLabel(getResources().getString(R.string.title_home));
    navGraph.addDestination(destination1);

    //省略
    navGraph.addDestination(destination2);
    //省略
    navGraph.addDestination(destination3);

    navGraph.setStartDestination(R.id.navigation_home);

    return navGraph;
}

具体流程都写在代码注释里了,至此就实现了对fragment的复用。

前边提到的自定义导航器需要指定名字@Navigator.Name("fixFragment"),是因为不同类型的目的地(页面)需要使用不同的导航器,在NavigatorProvider里有个map存储了多个导航器,

//NavigatorProvider.java
private final HashMap<String, Navigator<? extends NavDestination>> mNavigators =
            new HashMap<>();

// "navigation" NavGraphNavigator
// "activity" ActivityNavigator
// "fragment" FragmentNavigator
// "dialog" DialogFragmentNavigator
// "fixFragment" FixFragmentNavigator 这个就是我们自定义的导航器

然后,使用自定义导航器FixFragmentNavigatorcreateDestination创建目的地,这样就把导航器和目的地绑定在一起了。可以看出,Navigation的思想是,把各种类型的页面都抽象成目的地Destination,进行统一跳转,不同的导航器则封装了不同类型页面跳转的实现,由NavController统一调度,而许许多多的目的地则编织成了一个导航图NavGraph

参考

image