本文正在参与「金石计划」

前语

不知道小伙伴们是否留意到,用AS创立一个默许的新项目后,MainActivity现已有了很大的不同,最大的差异便是新增加了两个Fragment,一起咱们留意到这两个Fragment之间跳转的时分并没有运用之前FragmentTransaction这种形式,而是运用了NavController和NavHostFragment,这便是新一代导航管理————Navigation。

项目中依靠Navigation:

implementation 'androidx.navigation:navigation-fragment-ktx:2.3.5'
implementation 'androidx.navigation:navigation-ui-ktx:2.3.5'

创立导航视图

新建一个Android Resource File,类型挑选Navigation即可,输入称号后咱们就创立了一个导航视图。

在导航试图中,咱们能够经过增加activity/fragment等标签手动增加页面,也支撑在Design页面中经过界面增加,如下:

Jetpack:Android新一代导航管理Navigation

留意:这样增加后手动修改一下label。假如咱们将Navigation与ToolBar衔接,会在标题栏这个label。

示例中增加了两个页面,增加后代码如下:

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">
    <fragment
        android:id="@+id/FirstFragment"
        android:name="com.xxx.xxx.FirstFragment"
        android:label="@string/first_fragment_label"
        tools:layout="@layout/fragment_first">
    </fragment>
    <fragment
        android:id="@+id/SecondFragment"
        android:name="com.xxx.xxx.SecondFragment"
        android:label="@string/second_fragment_label"
        tools:layout="@layout/fragment_second">
    </fragment>
</navigation>

除了增加Fragment和Activity,Google还供给了一个占位符placeholder,增加加完代码如下:

<fragment android:id="@+id/placeholder" />

用于暂时占位以便后边能够替换为Fragment和Activity

增加完页面后,咱们还需要增加页面之间的导航,能够手动增加action标签,当然也能够经过拖拽来完成,如下:

Jetpack:Android新一代导航管理Navigation

这样咱们就增加了一个从FirstFragment导航到SecondFragment的动作,咱们再增加一个逆向的动作,终究的代码如下:

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">
    <fragment
        android:id="@+id/FirstFragment"
        android:name="com.xxx.xxx.FirstFragment"
        android:label="@string/first_fragment_label"
        tools:layout="@layout/fragment_first">
        <action
            android:id="@+id/action_FirstFragment_to_SecondFragment"
            app:destination="@id/SecondFragment" />
    </fragment>
    <fragment
        android:id="@+id/SecondFragment"
        android:name="com.xxx.xxx.SecondFragment"
        android:label="@string/second_fragment_label"
        tools:layout="@layout/fragment_second">
        <action
            android:id="@+id/action_SecondFragment_to_FirstFragment"
            app:destination="@id/FirstFragment" />
    </fragment>
</navigation>

留意占位符placeholder同样支撑增加导航。

这样就完成了两个页面间的导航,最后还需要为这个navigation设置id和默许页面startDestination,如下:

<navigation xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/nav_graph"
    app:startDestination="@id/FirstFragment">

这样导航视图就创立完成了。能够看到Google力求经过可视化工具来简化开发作业,这对咱们开发者来说非常有用,能够省去许多编写同质化代码的时刻。

增加NavHost

下一步咱们需要向Activity中增加导航宿主,导航宿主是一个空页面,有必要完成NavHost接口,咱们运用Navigation供给的默许NavHost————NavHostFragment即可。如下:

<fragment
    android:id="@+id/nav_host_fragment_content_main"
    android:name="androidx.navigation.fragment.NavHostFragment"
    android:layout_width="0dp"
    android:layout_height="0dp"
    app:defaultNavHost="true"
    app:layout_constraintBottom_toBottomOf="parent"
    app:layout_constraintLeft_toLeftOf="parent"
    app:layout_constraintRight_toRightOf="parent"
    app:layout_constraintTop_toTopOf="parent"
    app:navGraph="@navigation/nav_graph" />

在Activity的视图中增加一个fragment标签,android:name设置为完成类,即NavHostFragment;app:navGraph设置为刚才新建的导航视图。

留意app:defaultNavHost="true",设置为true后表明将这个NavHostFragment设置为默许导航宿主,这样就会拦截系统的返回按钮事件。同一布局中假如有多个导航宿主(比方双窗口)则有必要制定一个为默许的导航宿主。

这时分咱们运转应用,就能够发现Activity中现已能够展示FirstFragment了。

导航

咱们还需要为两个fragment增加按钮,是其点击跳转到另外一个页面,代码如下:

binding.buttonFirst.setOnClickListener {
    findNavController().navigate(R.id.action_FirstFragment_to_SecondFragment)
}

示例中是FirstFragment中的一个按钮,点击时履行了id为action_FirstFragment_to_SecondFragment的动作,这个是咱们之前在导航视图中配置好的,会导航到SecondFragment。

留意首先经过findNavController()来获取一个NavController目标,然后调用它的navigate函数即可,当然这个函数有多种重载,比方能够传递参数,如下:

public void navigate(@IdRes int resId, @Nullable Bundle args) {

这儿不一一列举了,咱们自行检查源码即可。

能够看到运用Navigation代码精简了许多,只需要一行代码履行一个函数即可。

findNavController

咱们重点来看看findNavController(),它是一个扩展函数,如下:

fun Fragment.findNavController(): NavController =
        NavHostFragment.findNavController(this)

实际上是NavHostFragment的一个静态函数findNavController:

@NonNull
public static NavController findNavController(@NonNull Fragment fragment) {
    ...
    View view = fragment.getView();
    if (view != null) {
        return Navigation.findNavController(view);
    }
    // For DialogFragments, look at the dialog's decor view
    Dialog dialog = fragment instanceof DialogFragment
            ? ((DialogFragment) fragment).getDialog()
            : null;
    if (dialog != null && dialog.getWindow() != null) {
        return Navigation.findNavController(dialog.getWindow().getDecorView());
    }
    throw new IllegalStateException("Fragment " + fragment
            + " does not have a NavController set");
}

经过源码能够看到终究是履行了Navigation的findNavController函数,它的代码如下:

@NonNull
public static NavController findNavController(@NonNull View view) {
    NavController navController = findViewNavController(view);
    ...
    return navController;
}

这儿是经过findViewNavController函数来获取NavController的,它的代码如下:

@Nullable
private static NavController findViewNavController(@NonNull View view) {
    while (view != null) {
        NavController controller = getViewNavController(view);
        if (controller != null) {
            return controller;
        }
        ViewParent parent = view.getParent();
        view = parent instanceof View ? (View) parent : null;
    }
    return null;
}

这儿能够看到经过view来获取NavController,假如没有则向上层查找(父view)直到找到或到根结点。getViewNavController代码如下:

@Nullable
private static NavController getViewNavController(@NonNull View view) {
    Object tag = view.getTag(R.id.nav_controller_view_tag);
    NavController controller = null;
    if (tag instanceof WeakReference) {
        controller = ((WeakReference<NavController>) tag).get();
    } else if (tag instanceof NavController) {
        controller = (NavController) tag;
    }
    return controller;
}

看到这儿获取view中key为R.id.nav_controller_view_tag的tag,这个tag便是NavController,那么这个tag又从哪来的?

其实便是上面咱们说到导航宿主————NavHostFragment,在他的onViewCreated中能够看到如下代码:

@Override
public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
    super.onViewCreated(view, savedInstanceState);
    if (!(view instanceof ViewGroup)) {
        throw new IllegalStateException("created host view " + view + " is not a ViewGroup");
    }
    Navigation.setViewNavController(view, mNavController);
    // When added programmatically, we need to set the NavController on the parent - i.e.,
    // the View that has the ID matching this NavHostFragment.
    if (view.getParent() != null) {
        mViewParent = (View) view.getParent();
        if (mViewParent.getId() == getId()) {
            Navigation.setViewNavController(mViewParent, mNavController);
        }
    }
}

这儿的mNavController是在NavHostFragment的onCreate中创立出来的,是一个NavHostController目标,它承继NavController,所以便是NavController。

能够看到onViewCreated中调用了Navigation的setViewNavController函数,它的代码如下:

public static void setViewNavController(@NonNull View view,
        @Nullable NavController controller) {
    view.setTag(R.id.nav_controller_view_tag, controller);
}

这样就将NavController加入tag中了,经过findNavController()就能够得到这个NavController来履行导航了。

留意在onViewCreated中不仅为Fragment的View增加了tag,一起还为其父View也增加了,这样做的意图是在Activity中也能够获取到NavController,这点下面就会遇到。

ToolBar

Google供给了Navigation与ToolBar衔接的功用,代码如下:

val navController = findNavController(R.id.nav_host_fragment_content_main)
appBarConfiguration = AppBarConfiguration(navController.graph)
setupActionBarWithNavController(navController, appBarConfiguration)

上面咱们说到,假如Navigation与ToolBar衔接,标题栏会主动显现在导航视图中设定好的label。

留意这儿的findNavController是Activity的扩展函数,它终究相同会调用Navigation的对应函数,所以与Fragment的流程是相同的。而上面咱们说到了,在NavHostFragment中给上层View也设置了tag,所以在这儿才能获取到NavController。

除了这个,咱们还能够发现当在切换页面的时分,标题栏的返回按钮也会主动显现和躲藏。当导航到第二个页面SecondFragment,返回按钮显现;当回退到首页时,返回按钮躲藏。

但是此时返回按钮点击无效,因为咱们还需要重写一个函数:

override fun onSupportNavigateUp(): Boolean {
    val navController = findNavController(R.id.nav_host_fragment_content_main)
    return navController.navigateUp(appBarConfiguration)
            || super.onSupportNavigateUp()
}

这样当点击标题栏的返回按钮时,会履行NavController的navigateUp函数,就会退回到上一页面。

总结

能够看出经过Google推出的这个Navigation,能够让开发者更加优雅管理导航,一起也简化了这部分的开发作业,可视化功用能够让开发者更直观的进行管理。除此之外,Google还供给了Safe Args Gradle插件,该插件能够生成简略的目标和构建器类,这些类支撑在意图地之间进行类型安全的导航和参数传递。关于这个咱们能够参考官方文档developer.android.google.cn/guide/navig… 即可。