欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识！
您现在的位置是： 首页

android:Navigation

程序员文章站 2022-05-28 23:25:04
...

Navigation组件对 Fragment 的原生支持，您可以获得架构组件的所有好处（例如生命周期和
ViewModel），同时让此组件为您处理 FragmentTransaction
的复杂性。此外，Navigation组件还可以让您声明我们为您处理的转场。它可以自动构建正确的“向上”和“返回”行为，包含对深层链接的完整支持，并提供了帮助程序，用于将导航关联到合适的
UI 小部件，例如抽屉式导航栏和底部导航.

让单 Activity 应用成为首选架构

官方文档：
https://developer.android.com/topic/libraries/architecture/navigation/

官方Sample：
项目地址：https://github.com/googlecodelabs/android-navigation
项目教程：https://codelabs.developers.google.com/codelabs/android-navigation/#0

Navigation目前仅AndroidStudio 3.2以上版本支持，如果您的版本不足3.2，请点此下载预览版AndroidStudio

  • 在Module下的build.gradle中添加以下依赖：
dependencies {
    def nav_version = '1.0.0-alpha01'
    implementation "android.arch.navigation:navigation-fragment:$nav_version"
    implementation "android.arch.navigation:navigation-ui:$nav_version"
}
  • 新建三个Fragment：
//3个Fragment，它们除了layout不同，没有其它区别
class MainPage1Fragment : Fragment() {

    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?,
                              savedInstanceState: Bundle?): View {
        return inflater.inflate(R.layout.fragment_main_page1, container, false)
    }
}

class MainPage2Fragment : Fragment() {

    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?,
                              savedInstanceState: Bundle?): View? {
        return inflater.inflate(R.layout.fragment_main_page2, container, false)
    }
}

class MainPage3Fragment : Fragment() {

    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?,
                              savedInstanceState: Bundle?): View? {
        return inflater.inflate(R.layout.fragment_main_page3, container, false)
    }
}
  • 新建导航视图文件（nav_graph）
    在res目录下新建navigation文件夹，然后新建一个navigation的resource文件，我叫它 nav_graph_main.xml ：
    android:Navigation
  • 编辑导航视图文件
    我们打开Text标签，进入xml编辑的页面，并这样配置:

《?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”
app:startDestination=”@id/page1Fragment”>

《fragment
    android:id="@+id/page1Fragment"
    android:name="com.qingmei2.samplejetpack.ui.main.MainPage1Fragment"
    android:label="fragment_page1"
    tools:layout="@layout/fragment_main_page1">
    《action
        android:id="@+id/action_page2"
        app:destination="@id/page2Fragment" />
《/fragment>

《fragment
    android:id="@+id/page2Fragment"
    android:name="com.qingmei2.samplejetpack.ui.main.MainPage2Fragment"
    android:label="fragment_page2"
    tools:layout="@layout/fragment_main_page2">
    《action
        android:id="@+id/action_page1"
        app:popUpTo="@id/page1Fragment" />
    《action
        android:id="@+id/action_page3"
        app:destination="@id/nav_graph_page3" />
《/fragment>

《navigation
    android:id="@+id/nav_graph_page3"
    app:startDestination="@id/page3Fragment">
    《fragment
        android:id="@+id/page3Fragment"
        android:name="com.qingmei2.samplejetpack.ui.main.MainPage3Fragment"
        android:label="fragment_page3"
        tools:layout="@layout/fragment_main_page3" />
《/navigation>

《/navigation>

  • 编辑MainActivity
    在Activity中配置 Navigation 非常简单，我们首先编辑Activity的布局文件，并在布局文件中添加一个 NavHostFragment :

《?xml version=”1.0” encoding=”utf-8”?>
《android.support.constraint.ConstraintLayout 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/container”
android:layout_width=”match_parent”
android:layout_height=”match_parent”
tools:context=”.MainActivity”>

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

《/android.support.constraint.ConstraintLayout>

这是一个宽和高都 match_parent 的Fragment，它的作用就是 导航界面的容器。

这并不难以理解，我们需要在Activity中通过 Navigation 展示一系列的Fragment，但是我们需要告诉Navigation 和Activity，这一系列的 Fragment 展示在哪——NavHostFragment应运而生，我把它的作用归纳为 导航界面的容器。

这之后，在Activity中添加如下代码：

class MainActivity : AppCompatActivity() {

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)
}

override fun onSupportNavigateUp() =
        findNavController(this, R.id.my_nav_host_fragment).navigateUp() }

onSupportNavigateUp()方法的重写，意味着Activity将它的 back键点击事件的委托出去，如果当前并非栈中顶部的Fragment, 那么点击back键，返回上一个Fragment。

  • 最后，配置不同Fragment对应的跳转事件

class MainPage1Fragment : Fragment() {
//隐藏了onCreateView()方法的实现，下同
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
btn.setOnClickListener {
//点击跳转page2
Navigation.findNavController(it).navigate(R.id.action_page2)
}
} }

class MainPage2Fragment : Fragment() {

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    super.onViewCreated(view, savedInstanceState)
    btn.setOnClickListener {
       //点击返回page1
        Navigation.findNavController(it).navigateUp()
    }
    btn2.setOnClickListener {
        //点击跳转page3
        Navigation.findNavController(it).navigate(R.id.action_page3)
    }
} }

class MainPage3Fragment : Fragment() {

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    super.onViewCreated(view, savedInstanceState)
    //点击返回page2
    btn.setOnClickListener { Navigation.findNavController(it).navigateUp() }
} }

可以看到，我们对于Fragment 并非是通过原生的 FragmentManager 和 FragmentTransaction 进行控制的。而是通过以下API进行的控制：

Navigation.findNavController(params).navigateUp()

Navigation.findNavController(params).navigate(actionId)

1.NavGraphFragment：导航界面的容器

即使我们使用原生的API，想展示一个Fragment，我们首先也需要 定义一个容器承载它。以往，它可能是一个 RelativeLayout 或者 FrameLayout，而现在，它被替换成了 NavGraphFragment。

这也就说明了，我们为什么要往Activity的layout文件中提前扔进去一个NavGraphFragment，因为我们需要导航的这些Fragment都展示在NavGraphFragment上面。

实际上它做了什么呢？来看一下NavGraphFragment的onCreateView()方法：

public View onCreateView(@NonNull LayoutInflater inflater, @Nullable
ViewGroup container,
@Nullable Bundle savedInstanceState) {
FrameLayout frameLayout = new FrameLayout(inflater.getContext());
frameLayout.setId(getId());
return frameLayout;
}

NavGraphFragment内部实例化了一个FrameLayout, 作为ViewGroup的载体，导航并展示其它Fragment。

除此之外，你 应当注意 到在layout文件中，它还声明了另外两个属性：

app:defaultNavHost=”true”
app:navGraph=”@navigation/nav_graph_main”

app:defaultNavHost=”true”这个属性意味着你的NavGraphFragment将会 拦截系统Back键的点击事件（因为系统的back键会直接关闭Activity而非切换Fragment），你同时 必须重写 Activity的 onSupportNavigateUp() 方法，类似这样：

override fun onSupportNavigateUp()
= findNavController(R.id.nav_host_fragment).navigateUp()

app:navGraph=”@navigation/nav_graph_main”这个属性就很好理解了，它会指向一个navigation_graph的xml文件,这之后，NavGraphFragment就会 导航并展示对应的Fragment。

在我们使用Navigation的第一步，我们需要：

在Activity的布局文件中显示声明NavGraphFragment，并配置 app:defaultNavHost 和
app:navGraph属性。

2.nav_graph.xml：声明导航结构图

NavGraphFragment作为Activity导航的 容器 ，然后，其 app:navGraph 属性指向一个navigation_graph的xml文件，以声明其 导航的结构。

NavGraphFragment在 获取 并 解析 完这个xml资源文件后，它首先需要知道的是：
类似APP的home界面，NavGraphFragment首先要导航到哪里？

《?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”
app:startDestination=”@id/page1Fragment”>

《fragment
    android:id="@+id/page1Fragment"
    android:name="com.qingmei2.samplejetpack.ui.main.MainPage1Fragment"
    android:label="fragment_page1"
    tools:layout="@layout/fragment_main_page1">
    《action
        android:id="@+id/action_page2"
        app:destination="@id/page2Fragment" />
《/fragment>
//省略... 《/navigation>

在navigation的根节点下，我们需要处理这样一个属性：

app:startDestination=”@id/page1Fragment”

Destination 是一个很关键的单词，它的直译是 目的地。app:startDestination属性便是声明这个id对应的 Destination 会被作为 默认布局 加载到Activity中。这也就说明了，为什么我们的sample，默认会显示 MainPage1Fragment。

现在，我们的app默认展示了MainPage1Fragment, 那么接下来，我们如何实现跳转逻辑的处理呢？

3.Action标签：声明导航的行为

我们声明了这样一个Action标签，这是一个 导航的行为：

《action
android:id=”@+id/action_page2”
app:destination=”@id/page2Fragment” />

app:destination的属性，声明了这个行为导航的 destination（目的地），我们可以看到，它会指印跳转到 id 为 page2Fragment 的Fragment（也就是 MainPage2Fragment）。

android:id 这个id作为Action唯一的 标识，在Fragment的某个点击事件中，我们通过id指向对应的行为，就像这样：

btn.setOnClickListener {
//点击跳转page2Fragment
Navigation.findNavController(it).navigate(R.id.action_page2) }

此外，Navigation还提供了一个 app:popUpTo 属性，它的作用是声明导航行为 将 返回到 id对应的Fragment，比如，直接从Page3 返回到 Page1。

此外，Navigation 对导航行为还提供了 转场动画 的支持，它可以通过代码这样实现：

《action
android:id=”@+id/confirmationAction”
app:destination=”@id/confirmationFragment”
app:enterAnim=”@anim/slide_in_right”
app:exitAnim=”@anim/slide_out_left”
app:popEnterAnim=”@anim/slide_in_left”
app:popExitAnim=”@anim/slide_out_right” />

4.Fragment：通过代码声明导航

其实在3中我们已经讲解了导航代码的使用,我们以Page2为例，它包含了2个按钮，分别对应 返回Page1 和 进入Page3 两个事件：

btn.setOnClickListener {
Navigation.findNavController(it).navigateUp() } btn2.setOnClickListener {
Navigation.findNavController(it).navigate(R.id.action_page3) }

Navigation.findNavController(View) 返回了一个 NavController ,它是整个 Navigation 架构中 最重要的核心类，我们所有的导航行为都由 NavController 处理，这个我们后面再讲。

我们通过获取 NavController，然后调用 NavController.navigate()方法进行导航。

我们更多情况下通过传入ActionId，指定对应的 导航行为 ；同时可以通过传入Bundle以 数据传递；或者是再传入一个 NavOptions配置更多（比如 转场动画，它也可以通过这种方式进行代码的动态配置）。

NavController.navigate()方法更多时候应用在 向下导航 或者 指定向上导航（比如Page3 直接返回 Page1，跳过返回Page2的这一步）；如果我们处理back事件，我们应该使用 NavController. navigateUp()。

android:Navigation

设计 NavHostFragment

NavHostFragment 应当有两个作用：

  • 作为Activity导航界面的载体
  • 管理并控制导航的行为

前者的作用我们已经说过了，我们通过在NavHostFragment的创建时，为它创建一个对应的FrameLayout作为 导航界面的载体：

public View onCreateView(@NonNull LayoutInflater inflater, @Nullable
ViewGroup container,
@Nullable Bundle savedInstanceState) {
FrameLayout frameLayout = new FrameLayout(inflater.getContext());
frameLayout.setId(getId());
return frameLayout;
}

我们都知道代码设计应该遵循 单一职责原则，因此，我们应该将 管理并控制导航的行为交给另外一个类，这个类的作用应该仅是 控制导航行为，因此我们命名为 NavController。

Fragment理应持有这个NavController的实例，并将导航行为 委托 给它，这里我们将 NavController 的持有者抽象为一个 接口，以便于以后的拓展。

于是我们创造了 NavHost 接口，并让NavHostFragment实现了这个接口：

public interface NavHost {

NavController getNavController(); }

为了保证导航的 安全，NavHostFragment 在其 作用域 内，理应 有且仅有一个NavController 的实例。

这里我们驻足一下，请注意API的设计，似乎 Navigation.findNavController(View)，参数中传递任意一个 view的引用似乎都可以获取 NavController——如何保证 NavController 的局部单例呢？

事实上，findNavController(View)内部实现是通过 遍历 View树，直到找到最底部 NavHostFragment 中的NavController对象，并将其返回的：

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; }

设计 NavController
站在 设计者 的角度，NavController 的职责是：

  • 1.对navigation资源文件夹下nav_graph.xml的 解析
  • 2.通过解析xml，获取所有 Destination（目标点）的 引用 或者 Class的引用
  • 3.记录当前栈中 Fragment的顺序
  • 4.管理控制 导航行为

NavController 持有了一个 NavInflater ,并通过 NavInflater 解析xml文件。

这之后，获取了所有 Destination（在本文中即Page1Fragment , Page2Fragment , Page3Fragment ） 的 Class对象，并通过反射的方式，实例化对应的 Destination，通过一个队列保存：

private NavInflater mInflater; //NavInflater
private NavGraph mGraph; //解析xml，得到NavGraph
private int mGraphId; //xml对应的id，比如 nav_graph_main
//所有Destination的队列,用来处理回退栈
private final Deque mBackStack = new ArrayDeque<>();

这看起来没有任何问题，但是站在 设计者 的角度上，还略有不足，那就是，Navigation并非只为Fragment服务。

先不去吐槽Google工程师的野心，因为现在我们就是他，从拓展性的角度考虑，Navigation是一个导航框架，今后可能 并非只为Fragment导航。

我们应该为要将导航的 Destination 抽象出来，这个类叫做 NavDestination ——无论 Fragment 也好，Activity 也罢，只要实现了这个接口，对于NavController 来讲，他们都是 Destination（目标点）而已。

对于不同的 NavDestination 来讲，它们之间的导航方式是不同的，这完全有可能（比如Activity 和 Fragment），如何根据不同的 NavDestination 进行不同的 导航处理 呢？

NavDestination 和 Navigator

有同学说，我可以这样设计，通过 instanceof 关键字，对 NavDestination 的类型进行判断，并分别做出处理，比如这样：

if (destination instanceof Fragment) { //对应Fragment的导航 } else if
(destination instanceof Activity) { //对应Activity的导航 }

这是OK的，但是不够优雅，Google的方式是通过抽象出一个类，这个类叫做 Navigator：

public abstract class Navigator {
//省略很多代码,包括部分抽象方法，这里仅阐述设计的思路！
//导航
public abstract void navigate(@NonNull D destination, @Nullable Bundle args,
@Nullable NavOptions navOptions);
//实例化NavDestination（就是Fragment）
public abstract D createDestination();
//后退导航
public abstract boolean popBackStack(); }

Navigator(导航者) 的职责很单纯：

  • 1.能够实例化对应的 NavDestination
  • 2.能够指定导航
  • 3.能够后退导航

你看，我的 NavController 获取了所有 NavDestination 的Class对象，但是我不负责它 如何实例化 ，也不负责 如何导航 ，也不负责
如何后退 ——我仅仅持有向上的引用，然后调用它的接口方法，它的实现我不关心。

以 FragmentNavigator为例，我们来看看它是如何执行的职责：

public class FragmentNavigator extends
Navigator

相关标签： android navigation

上一篇： python3进阶学习总结——简单爬虫实现

下一篇： React Navigation5.x 第九章 全面屏model

推荐阅读