Android开发 navigation入门详解

版权声明

本文来自博客园，作者：观心静 ，转载请注明原文链接：https://www.cnblogs.com/guanxinjing/p/11555217.html

本文版权归作者和博客园共有，欢迎转载，但必须给出原文链接，并保留此段声明，否则保留追究法律责任的权利。

前言

　　Google 在2018年推出了 Android Jetpack,在Jetpack里有一种管理fragment的新架构模式,那就是navigation. 字面意思是导航,但是除了做APP引导页面以外.也可以使用在App主页分tab的情况.. 甚至可以一个功能模块就一个activity大部分页面UI都使用fragment来实现,而navigation就成了管理fragment至关重要的架构.

　　但是,它不单单只能管理fragment也可以管理activity.这点你格外注意.

使用条件

　　你的Android studio 必需升级到3.2版本以上,此博客正在写的时候Android studio已经到达3.5,所以升级到最新版本即可.

依赖

最新版本可以通过 https://developer.android.google.cn/jetpack/androidx/releases/navigation?hl=zh_cn 查看 

dependencies {
  val nav_version = "2.5.3"

  // Java language implementation
  implementation("androidx.navigation:navigation-fragment:$nav_version")
  implementation("androidx.navigation:navigation-ui:$nav_version")

  // Kotlin
  implementation("androidx.navigation:navigation-fragment-ktx:$nav_version")
  implementation("androidx.navigation:navigation-ui-ktx:$nav_version")

  // Feature module Support
  implementation("androidx.navigation:navigation-dynamic-features-fragment:$nav_version")

  // Testing Navigation
  androidTestImplementation("androidx.navigation:navigation-testing:$nav_version")

  // Jetpack Compose Integration
  implementation("androidx.navigation:navigation-compose:$nav_version")
}

另外还需要在根目录gradle.properties 文件中添加

android.enableJetifier=true

基本使用流程

创建navigation目录

1.选中项目资源文件夹 res 右击 >> New >> New Resource Directory

2.选中navigation 点击创建 (注意这个目录只有在Android studio3.2版本以上才能出现)

创建navigation目录下的xml文件

1.选中项目资源文件夹 res 右击 >> New >> New Resource File

2.选择navigation ,输入xml文件名称,点击ok创建

配置创建的xml文件

 上面我们创建了一个叫demo_nav.xml的navigation文件,现在我们需要来设配它来管理fragment

 1.打开这个文件选择,模式使用视图手动配置.

2.切换到Design模式后,我们可以看到下面这个界面(恩,一片空白). 我们可以在左上角点击添加图标,进入添加内容的操作.

3.点击后,可以看到下面这个弹窗,这里解释一下:

第一个 Create new destinattion,字面意思创建一个新目标(其实就是创建fragment,当然你也可以手动另外创建fragment不一定需要在这里创建)

第二个 placeholder,这个就是重点了. 这是一个管理fragment跳转的节点,我们点击后可以创建它.为了了解它的使用方式,点击3次创建三个节点

4.节点创建后可以看到三个节点(看下面图片,这些节点都是我已经导入fragment了.不要急后面会讲解如何导入).这里有一个重点! 你可以点击这些页面(会有一个蓝点),点击蓝点按住向右分配它需要跳转的另外一个页面.(它会自动生成一些我们跳转的代码)

6.然后点击左下角的Text模式,在Text模式下,可以看到如下代码,在上面的图片中你可以很清楚的看到创建了3个节点,并且是一个跳转一个的.从第一个fragment跳转到第二个fragment,再从第二个fragment跳转到第三个fragment

下面我们来重点讲解下下面的这些代码的关键点了:

在navigation里的属性:

1.android:id="@+id/demo_nav" 这个属性是你这个xml文件navigation的id,很重要,我们需要在activity的xml布局里引用,记得写上不要忘记

2.app:startDestination="@id/one" 这个属性是你首次加载的第一个页面,很重要,一般就是第一个fragment

在fragment 里的属性:

其实就是一个节点你也可以理解成一个fragment

1.android:id="@+id/one"  每一个fragment节点都需要有自己的id,很重要. 我们需要在后面的节点上使用这些id指定跳转目标

2.android:name="demo.yt.com.demo.fragment.BlankFragment"   这个属性是你这个节点所对应的fragment(需要你导入指定的fragment文件路径),这个很重要

3.android:label="BlankFragment" 一个标签名称,用于记录这个节点的标签信息(大概可能是在代码里的Intent里获取来知晓此次是那个fragment节点在跳转,没深究了)

4.tools:layout="@layout/fragment_blank" 这个属性不是重要的,设置它后你可以在切换到Design模式后看到,视图页面的fragment的预览图(就在上面的图片里,可以直接看到fragment效果)

在action 里的属性:

action 负责编写跳转动作

1. android:id="@+id/action_one_to_two" 这个很重要,它是这个跳转动作的id, 这个id我们将在后面的代码中调用,用于执行fragment的跳转

2. app:destination="@id/two" 跳转的目标fragment,这个很重要

<?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"
    android:id="@+id/demo_nav"
    app:startDestination="@id/one">


    <fragment android:id="@+id/one"
        android:name="demo.yt.com.demo.fragment.BlankFragment"
        android:label="BlankFragment"
        tools:layout="@layout/fragment_blank">
        <action
            android:id="@+id/action_one_to_two"
            app:destination="@id/two" />
    </fragment>

    <fragment android:id="@+id/two"
        android:name="demo.yt.com.demo.fragment.Blank2Fragment"
        android:label="BlankFragment"
        tools:layout="@layout/fragment_blank2">
        <action
            android:id="@+id/action_two_to_three"
            app:destination="@id/three" />
    </fragment>

    <fragment android:id="@+id/three"
        android:name="demo.yt.com.demo.fragment.Blank3Fragment"
        android:label="BlankFragment"
        tools:layout="@layout/fragment_blank3"/>

</navigation>

让navigation与Activity关联起来

 　　现在我们已经创建了navigation,但是使用它还需要一个根Activity,它毕竟还是需要依托Activity的.

 1.创建了一个叫DemoActivity的Activity.这个没啥,下面来看这个Activity的布局xml怎么配(如下xml代码)

我们就关注fragment的一些属性

1.android:name="androidx.navigation.fragment.NavHostFragment"  这个非常重要,这是你告知fragment需要使用navigation模式的关键属性,另外它是固定死的.你必需写.

2. app:defaultNavHost="true"  这是你实现物理按键(比如返回键),是按一下退出一个fragment 还是直接退出这个Activity的关键属性

3.app:navGraph="@navigation/demo_nav"  很重要,这就是我们前面创建的navigation的xml文件

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.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:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".fragment.DemoActivity">

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

</androidx.constraintlayout.widget.ConstraintLayout>

navigate跳转与popBackStack返回

 进入到DemoActivity后,首先会自动加载到第一个fragment. 然后我们看看如何跳转到其他fragment中

 1.从第一个碎片跳转到第二个碎片,关键代码  Navigation.findNavController(getView()).navigate(R.id.action_one_to_two);

public class BlankFragment extends Fragment {
    private Button mBtnInputFragment2;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        final View view = inflater.inflate(R.layout.fragment_blank, container, false);;
        mBtnInputFragment2 = view.findViewById(R.id.btn_input_fragment2);
        mBtnInputFragment2.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Navigation.findNavController(getView()).navigate(R.id.action_one_to_two);//这个id就是navigation里的action的id

            }
        });
        return view;
    }

    @Override
    public void onDestroy() {
        super.onDestroy();
    }

    @Override
    public void onDetach() {
        super.onDetach();
    }

}

2.从第二个碎片返回到第一个碎片,关键代码 Navigation.findNavController(getView()).popBackStack();

public class Blank2Fragment extends Fragment {
    private Button mBtnInputFragment3, mBtnBack;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment_blank2, container, false);
        mBtnInputFragment3 = view.findViewById(R.id.btn_input_fragment3);
        mBtnBack = view.findViewById(R.id.back);
        mBtnInputFragment3.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Navigation.findNavController(getView()).navigate(R.id.action_two_to_three); //进入第三个碎片
            }
        });

        mBtnBack.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Navigation.findNavController(getView()).popBackStack(); //返回上一个碎片
            }
        });
        return view;
    }

}

popUpTo返回到指定位置

有时候在跳转了多个fragment目标后需要返回指定位置，例如A -> B -> C   ，现在我们要返回A这个fragment，就可以使用app:popUpTo这个属性，返回到指定位置并且会将B这个中间栈清理。但是实际开发上这种返回的方式，可能就是在navigation上表现很直观。并没有用NavController来返回指定位置来的方便。所以，我建议你还需要了解我另一篇博客 Android开发 Navigation—NavController的使用详解

代码如下：

<?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"
    android:id="@+id/demo_nav"
    app:startDestination="@id/AFragment">

    <fragment
        android:id="@+id/AFragment"
        android:name="com.xx.ui.workrest.fragment.AFragment"
        android:label="AFragment"
        tools:layout="@layout/main_fragment_a" >
        <action
            android:id="@+id/action_AFragment_to_BFragment"
            app:destination="@id/BFragment" />
    </fragment>
    <fragment
        android:id="@+id/BFragment"
        android:name="com.xx.ui.workrest.fragment.BFragment"
        android:label="BFragment"
        tools:layout="@layout/main_fragment_b">
        <action
            android:id="@+id/action_BFragment_to_CFragment"
            app:destination="@id/CFragment" />
    </fragment>
    <fragment
        android:id="@+id/CFragment"
        android:name="com.xx.ui.workrest.fragment.CFragment"
        android:label="CFragment"
        tools:layout="@layout/main_fragment_c" >
        <!--    注意这里的返回是使用的popUpTo        -->
        <action
            android:id="@+id/action_CFragment_to_AFragment"
            app:popUpTo="@id/AFragment" />
    </fragment>
</navigation>

在代码中调用，从C返回到A

Navigation.findNavController(it).navigate(R.id.action_CFragment_to_AFragment)

popUpToInclusive 

popUpToInclusive是用处是配合popUpTo使用的，在下面的代码里，A -> B -> C 进行导航，但是我们在B的action里设置了popUpTo与popUpToInclusive，这个时候B导航C的同时会将B清理出栈。 栈里只会剩下 A -> C 的上下关系。

<?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"
    android:id="@+id/demo_nav"
    app:startDestination="@id/AFragment">

    <fragment
        android:id="@+id/AFragment"
        android:name="com.xx.ui.workrest.fragment.AFragment"
        android:label="AFragment"
        tools:layout="@layout/main_fragment_a" >
        <action
            android:id="@+id/action_AFragment_to_BFragment"
            app:destination="@id/BFragment" />
    </fragment>
    <fragment
        android:id="@+id/BFragment"
        android:name="com.xx.ui.workrest.fragment.BFragment"
        android:label="BFragment"
        tools:layout="@layout/main_fragment_b">
        <!--      请注意这里的popUpTo与popUpToInclusive    -->
        <action
            android:id="@+id/action_BFragment_to_CFragment"
            app:destination="@id/CFragment"
            app:popUpTo="@id/BFragment"
            app:popUpToInclusive="true"/>
    </fragment>
    <fragment
        android:id="@+id/CFragment"
        android:name="com.xx.ui.workrest.fragment.CFragment"
        android:label="CFragment"
        tools:layout="@layout/main_fragment_c" >
    </fragment>
</navigation>

launchSingleTop 栈顶复用模式

当栈中已经包含了要跳转的指定页面，如果我们想在跳转到这个它将不会会再次创建这个页面，而是复用这个页面。这属性一般在TabBar与navigation配合使用的时候很有用。

    <fragment
        android:id="@+id/AFragment"
        android:name="com.xx.ui.workrest.fragment.AFragment"
        android:label="AFragment"
        tools:layout="@layout/main_fragment_a" >
        <action
            android:id="@+id/action_AFragment_to_BFragment"
            app:launchSingleTop="@id/BFragment" />
    </fragment>

跳转动画

一共有四种动画如下：

app:enterAnim 进入动画

app:exitAnim  退出动画

app:popEnterAnim  弹进动画(可能是给Dialog的)

app:popExitAnim 弹出动画

代码

    <fragment
        android:id="@+id/AFragment"
        android:name="com.xx.ui.workrest.fragment.AFragment"
        android:label="AFragment"
        tools:layout="@layout/main_fragment_a" >
        <action
            android:id="@+id/action_AFragment_to_BFragment"
            app:destination="@id/BFragment"
            app:enterAnim="@anim/main_show_anim"
            app:exitAnim="@anim/main_hide_anim"
            app:popEnterAnim="@anim/main_hide_anim"
            app:popExitAnim="@anim/main_hide_anim" />
    </fragment>

在navigation中加入Activity

直接在navigation里添加activity即可

<fragment
    android:id="@+id/editRemindFragment"
    android:name="com.xx.ui.workrest.fragment.EditRemindFragment"
    android:label="main_fragment_edit_remind"
    tools:layout="@layout/main_fragment_edit_remind" >
    <action
        android:id="@+id/action_editRemindFragment_to_demoActivity"
        app:destination="@id/demoActivity" />
</fragment>
<!--  注意这里使用的是activity  -->
<activity
    android:id="@+id/demoActivity"
    android:name="com.xx.ui.workrest.DemoActivity"
    android:label="DemoActivity"
    tools:layout="@layout/activity_demo">
</activity>

跳转方式，还是一样的

Navigation.findNavController(it).navigate(R.id.action_editRemindFragment_to_demoActivity)

在navigation中加入Dialog

请注意这里的dialog是DialogFragment，下面代码中创建了DialogFragment的例子。如果你不太了解DialogFragment，请参考博客: Android开发 DialogFragment对话框详解

import android.os.Bundle
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import androidx.fragment.app.DialogFragment
import com.lwlx.ui.main.databinding.MainDialogSelectBinding

class MyDialogFragment: DialogFragment() {

    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
        val binding = MainDialogSelectBinding.inflate(inflater)
        return binding.root
    }

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
    }
}

在navigation中添加这个DialogFragment，请注意标识是使用的dialog

<fragment
    android:id="@+id/remindListFragment"
    android:name="com.xx.ui.workrest.fragment.RemindListFragment"
    android:label="RemindListFragment"
    tools:layout="@layout/main_fragment_remind_list">
    <action
        android:id="@+id/action_remindListFragment_to_myDialogFragment"
        app:destination="@id/myDialogFragment" />
</fragment>
<!--  注意这里是使用的dialog  -->
<dialog
    android:id="@+id/myDialogFragment"
    android:name="com.xx.ui.workrest.fragment.MyDialogFragment"
    android:label="MyDialogFragment"
    tools:layout="@layout/main_dialog_select">
</dialog>

然后，在代码里可以正常跳转

Navigation.findNavController(it).navigate(R.id.action_remindListFragment_to_myDialogFragment)

NavDeepLinkBuilder  深链接导航-配合状态栏通知使用

NavDeepLinkBuilder是配合通知使用的。在通知被点击后执行跳转功能的场景下，但是我们的跳转目标可能是某个nav下的fragment。 这个时候就需要使用NavDeepLinkBuilder，帮助我们跳转到某个nav下的指定fragment下。它的返回值pendingIntent也是配合通知使用的。代码如下：

val pendingIntent = NavDeepLinkBuilder(context)
    .setGraph(R.navigation.nav_graph)
    .setDestination(R.id.android)
    .setArguments(args)
    .setComponentName(DestinationActivity::class.java)
    .createPendingIntent()

 

End