Jetpack组件之自定义Navigator

遗留的问题

上篇文章 手撕Jetpack组件之Navigation分析了导航框架的整个流程,还遗留了一个问题:在Fragment切换时,由于用的是replace方法,所以再次回到某个Fragment界面时又会执行onCreateView方法导致界面重绘。 Fragment的加载都是在FragmentNavigator#navigate方法内执行,所以重写这个方法相对来说改动量是最小的。再来回顾navigate方法做的事情。

@Nullable
@Override
public NavDestination navigate(@NonNull Destination destination, @Nullable Bundle args,
        @Nullable NavOptions navOptions, @Nullable Navigator.Extras navigatorExtras) {
    ...
    
    // 注释1
    final Fragment frag = instantiateFragment(mContext, mFragmentManager,
            className, args);
    frag.setArguments(args);
    
    final FragmentTransaction ft = mFragmentManager.beginTransaction();

    ...

    // 注释2
    ft.replace(mContainerId, frag);
    // 注释3
    ft.setPrimaryNavigationFragment(frag);

    final @IdRes int destId = destination.getId();
    // 注释4
    final boolean initialNavigation = mBackStack.isEmpty();
    
    ...
    
    ft.commit();
    
    ...
    
}

注释1和注释2的代码逻辑非常简单,上来就创建再替换。既然这样的话,我们就可以按下面的步骤来实现:

  • 先将当前正在显示的Fragment隐藏,那如何能拿到正在显示的Fragment呢?请看到注释3,每一次新的Fragment都会调用setPrimaryNavigationFragment这个方法,既然有setXXX,那肯定会有getPrimaryNavigationFragment,只不过不是在FragmentTransaction对象上,而是在mFragmentManager对象上。
  • 根据tag查找这个目标Fragment是否有加载过,有就直接show,没有就反射创建
  • mBackStack是一个ArrayDeque类型的对象,用来记录Fragment的回退栈。它在父类中是私有的,只能通过反射来拿这个对象。
@Navigator.Name("customFragment")
public class CustomFragmentNavigator extends FragmentNavigator {
    private static final String TAG = "CustomFragmentNavigator";
    @NonNull
    private final Context mContext;
    @NonNull
    private final FragmentManager mFragmentManager;
    private final int mContainerId;

    public CustomFragmentNavigator(@NonNull Context context, @NonNull FragmentManager manager, int containerId) {
        super(context, manager, containerId);
        mContext = context;
        mFragmentManager = manager;
        mContainerId = containerId;
    }

    @Nullable
    @Override
    public NavDestination navigate(@NonNull Destination destination, @Nullable Bundle args, @Nullable NavOptions navOptions, @Nullable Navigator.Extras navigatorExtras) {
        if (mFragmentManager.isStateSaved()) {
            Log.i(TAG, "Ignoring navigate() call: FragmentManager has already"
                    + " saved its state");
            return null;
        }
        String className = destination.getClassName();
        if (className.charAt(0) == '.') {
            className = mContext.getPackageName() + className;
        }
//        final Fragment frag = instantiateFragment(mContext, mFragmentManager,
//                className, args);
//        frag.setArguments(args);

        final FragmentTransaction ft = mFragmentManager.beginTransaction();

        // 先把当前正在显示的Fragment隐藏
        Fragment current = mFragmentManager.getPrimaryNavigationFragment();
        if (current != null) {
            Log.i(TAG, "当前需要隐藏的fragment: " + current.getClass().getCanonicalName());
            ft.hide(current);
        }

        int enterAnim = navOptions != null ? navOptions.getEnterAnim() : -1;
        int exitAnim = navOptions != null ? navOptions.getExitAnim() : -1;
        int popEnterAnim = navOptions != null ? navOptions.getPopEnterAnim() : -1;
        int popExitAnim = navOptions != null ? navOptions.getPopExitAnim() : -1;
        if (enterAnim != -1 || exitAnim != -1 || popEnterAnim != -1 || popExitAnim != -1) {
            enterAnim = enterAnim != -1 ? enterAnim : 0;
            exitAnim = exitAnim != -1 ? exitAnim : 0;
            popEnterAnim = popEnterAnim != -1 ? popEnterAnim : 0;
            popExitAnim = popExitAnim != -1 ? popExitAnim : 0;
            ft.setCustomAnimations(enterAnim, exitAnim, popEnterAnim, popExitAnim);
        }
        // 查找需要显示的Fragment是否加载过
        Fragment frag = mFragmentManager.findFragmentByTag(className);
        if (frag == null) {
            // 说明从未加载过,那就需要通过反射创建对象
            frag = instantiateFragment(mContext, mFragmentManager, className, args);
            frag.setArguments(args);
            ft.add(mContainerId, frag, className);
            Log.d(TAG, "反射创建fragment: " + className);
        } else {
            ft.show(frag);
        }

//        ft.replace(mContainerId, frag);
        ft.setPrimaryNavigationFragment(frag);

        final @IdRes int destId = destination.getId();
        ArrayDeque<Integer> mBackStack = null;
        try {
            Field mBackStackField = FragmentNavigator.class.getDeclaredField("mBackStack");
            mBackStackField.setAccessible(true);
            //noinspection unchecked
            mBackStack = (ArrayDeque<Integer>) mBackStackField.get(this);
        } catch (Exception e) {
            Log.e(TAG, "反射获取mBackStack对象异常: " + e.getMessage());
        }

        final boolean initialNavigation = mBackStack.isEmpty();
        // TODO Build first class singleTop behavior for fragments
        final boolean isSingleTopReplacement = navOptions != null && !initialNavigation
                && navOptions.shouldLaunchSingleTop()
                && mBackStack.peekLast() == destId;

        boolean isAdded;
        if (initialNavigation) {
            isAdded = true;
        } else if (isSingleTopReplacement) {
            // Single Top means we only want one instance on the back stack
            if (mBackStack.size() > 1) {
                // If the Fragment to be replaced is on the FragmentManager's
                // back stack, a simple replace() isn't enough so we
                // remove it from the back stack and put our replacement
                // on the back stack in its place
                mFragmentManager.popBackStack(
                        generateBackStackName(mBackStack.size(), mBackStack.peekLast()),
                        FragmentManager.POP_BACK_STACK_INCLUSIVE);
                ft.addToBackStack(generateBackStackName(mBackStack.size(), destId));
            }
            isAdded = false;
        } else {
            ft.addToBackStack(generateBackStackName(mBackStack.size() + 1, destId));
            isAdded = true;
        }
        if (navigatorExtras instanceof Extras) {
            Extras extras = (Extras) navigatorExtras;
            for (Map.Entry<View, String> sharedElement : extras.getSharedElements().entrySet()) {
                ft.addSharedElement(sharedElement.getKey(), sharedElement.getValue());
            }
        }
        ft.setReorderingAllowed(true);
        ft.commit();
        // The commit succeeded, update our view of the world
        if (isAdded) {
            mBackStack.add(destId);
            return destination;
        } else {
            return null;
        }
    }

    private String generateBackStackName(int backStackIndex, int destId) {
        return backStackIndex + "-" + destId;
    }
}

类上面有一个注解,注解的值被用来作为key保存到NavigatorProvider中。

添加Navigator

我们自定义的Navigator准备好了,那放到哪里去了?上篇文章提到过,所有的Navigator都被保存在NavigatorProvider,那就先要获取这个provider对象。可以通过NavController对象获取,那如何获取这个controller对象呢?可以通过NavHostFragment来获取。所以最终我们先要获取到这个占位Fragment,怎么获取它呢,那就比较简单了,直接用FragmentManager就可以得到。

// 此处代码放在Activity的onCreate方法内
Fragment fragment = getSupportFragmentManager().findFragmentById(R.id.nav_host_fragment_activity_main);
assert fragment != null;
NavController navController = NavHostFragment.findNavController(fragment);
NavigatorProvider navigatorProvider = navController.getNavigatorProvider();
CustomFragmentNavigator customNavigator = new CustomFragmentNavigator(this, getSupportFragmentManager(), R.id.nav_host_fragment_activity_main);
navigatorProvider.addNavigator(customNavigator);

将界面与Navigator绑定

上篇文章提到过,整个navigation目录下的xml文件都是由NavGraph来管理,里面的fragment标签都会被封装成一个个NavDestination。这部分加载是由NavGraphNavigator负责。所以我们要把写在xml文件的逻辑用代码实现

NavGraph navGraph = new NavGraph(new NavGraphNavigator(navigatorProvider));

FragmentNavigator.Destination hfd = customNavigator.createDestination();
hfd.setId(R.id.id_home_fragment);
hfd.setClassName(HomeFragment.class.getCanonicalName());
hfd.setLabel(getResources().getString(R.string.title_home));
navGraph.addDestination(hfd);

FragmentNavigator.Destination dfd = customNavigator.createDestination();
dfd.setId(R.id.id_dashboard_fragment);
dfd.setClassName(DashboardFragment.class.getCanonicalName());
dfd.setLabel(getResources().getString(R.string.title_dashboard));
navGraph.addDestination(dfd);

FragmentNavigator.Destination nfd = customNavigator.createDestination();
nfd.setId(R.id.id_notifications_fragment);
nfd.setClassName(NotificationsFragment.class.getCanonicalName());
nfd.setLabel(getResources().getString(R.string.title_notifications));
navGraph.addDestination(nfd);

// 设置首页
navGraph.setStartDestination(R.id.id_home_fragment);
// 加载我们代码生成的导航图
navController.setGraph(navGraph);

binding.navView.setOnNavigationItemSelectedListener(item -> {
    // 监听tab的点击事件,同时变更与之对应的NavDestination
    navController.navigate(item.getItemId());
    return true;
});

布局文件中就不需要再去加载navigation目录下的文件了。

    <androidx.fragment.app.FragmentContainerView
        android:id="@+id/nav_host_fragment_activity_main"
        android:name="androidx.navigation.fragment.NavHostFragment"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:defaultNavHost="true"
        app:layout_constraintBottom_toTopOf="@id/nav_view"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />
    <!--        app:navGraph="@navigation/mobile_navigation" />-->
0a5258276ce8ec5aa825d7f2b700092420218191613432.gif
fragment_lifecycle.png

由于使用了自定义的Navigator,引入了一个新的问题,那就是回退栈的问题。从第一个tab依次点第二个、第三个,此时再按返回键,先返回到第二个tab再到第一个tab,怎么进来就怎么回去。而Navigation框架是直接回到第一个tab,再退出界面。但我觉得这也是一个坑,从产品角度来看,应该是直接退出界面,而不是回到第一个tab。那么重写ActivityonBackPressed方法可以达到与原框架一样的效果。

@Override
public void onBackPressed() {
    int curId = navController.getCurrentDestination().getId();
    int startDestination = navController.getGraph().getStartDestination();
    if (curId != startDestination) {
        binding.navView.setSelectedItemId(startDestination);
    } else {
        finish();
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,080评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,422评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,630评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,554评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,662评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,856评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,014评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,752评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,212评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,347评论 4 331
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,973评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2 349

推荐阅读更多精彩内容