Jetpack中Navigation的简单使用

效果图

添加引用

1. 在gradle文件夹下的libs.versions.toml中添加如下代码

[versions]
...
navigation = "2.7.7"

[libraries]
...
androidx-navigation-ui-ktx = { module = "androidx.navigation:navigation-ui-ktx", version.ref = "navigation" }
androidx-navigation-fragment-ktx = { module = "androidx.navigation:navigation-fragment-ktx", version.ref = "navigation" }

2. 在 app 下的build.gradle中添加如下代码

dependencies {
    ...
    // Kotlin
    implementation(libs.androidx.navigation.fragment.ktx)
    implementation(libs.androidx.navigation.ui.ktx)
}

3. 如果需要用到传参，就需要一下步骤，否则跳过

   1. 在gradle文件夹下的libs.versions.toml中添加如下代码

   [versions]
   ...
   navigation = "2.7.7"
   
   [libraries]
   # 选如果需要传参，就添加
   androidx-navigation-safe-args-gradle-plugin = { module = "androidx.navigation:navigation-safe-args-gradle-plugin", version.ref = "navigation" }
   

   2. 在项目的build.gradle文件中添加如下代码

   // Top-level build file where you can add configuration options common to all sub-projects/modules.
   buildscript {
       dependencies {
           classpath(libs.androidx.navigation.safe.args.gradle.plugin)
       }
   }
   plugins {
       ...
   }
   

   3. 在 app 的 build.gradle 文件中添加引用

   plugins {
       ...
       id("androidx.navigation.safeargs.kotlin")
   }
   

准备好fragment

这个自己准备

创建导航图 Navigation Graph

1. 在res目录下创建navigation文件夹
2. 在 navigation文件夹下新建 navigation_phone.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"
    android:id="@+id/navigation_phone"
    app:startDestination="@id/fragmentHome">

    <!--
    id: 给fragment起的名字，后续是用来跳转用的
    name:是具体fragment的路径
    layout:是用来预览用的
    -->
    <fragment
        android:id="@+id/fragmentHome"
        android:name="com.test.navigationdemo.fragment.HomeFragment"
        tools:layout="@layout/fragment_home" />

    ...

    <fragment
        android:id="@+id/fragmentMine"
        android:name="com.test.navigationdemo.fragment.MineFragment"
        tools:layout="@layout/fragment_mine">

        <!--
        id: 也是后续用来跳转用的
        destination：跳转的目的地，也是 fragment 标签的id
        enterAnim ，exitAnim，popEnterAnim，popExitAnim 
        是用来设置进入和退出动画的
        -->
        <action
            android:id="@+id/action_fragmentMine_to_fragmentPrivacy"
            app:destination="@id/fragmentPrivacy"
            app:enterAnim="@anim/slide_in_right"
            app:exitAnim="@anim/slide_out_left"
            app:popEnterAnim="@anim/slide_in_left"
            app:popExitAnim="@anim/slide_out_right" />
    </fragment>

</navigation>

在 xml 中引入NavHostFragment

<!-- app:defaultNavHost="true"设置为true，代表回退栈由navController管理
     如果想自己管理，就不设置
 -->
<!-- 注意：这里我用的是FragmentContainerView，如果使用的是 fragment 标签，
     在 MainActivity代码中获取controller有区别
-->
<androidx.fragment.app.FragmentContainerView
    android:id="@+id/fragmentStart"
    android:name="androidx.navigation.fragment.NavHostFragment"
    android:layout_width="0dp"
    android:layout_height="0dp"
    app:layout_constraintBottom_toTopOf="@id/rbGroup"
    app:layout_constraintLeft_toLeftOf="parent"
    app:layout_constraintRight_toRightOf="parent"
    app:layout_constraintTop_toTopOf="parent"
    app:navGraph="@navigation/navigation_phone" />

在代码中获取controller并写跳转逻辑

val hostFragment = supportFragmentManager.findFragmentById(R.id.fragmentStart) as NavHostFragment
val navController = hostFragment.navController
// 添加动画
val options = NavOptions.Builder()
    .setEnterAnim(R.anim.fade_in)
    .setExitAnim(R.anim.fade_out)
    .build()
bind.rbGroup.setOnCheckedChangeListener { _, checkedId ->
    when (checkedId) {
        bind.rbHome.id -> navController.navigate(R.id.fragmentHome, null, options)
        bind.rbNews.id -> navController.navigate(R.id.fragmentNews, null, options)
        bind.rbHots.id -> navController.navigate(R.id.fragmentHots, null, options)
        bind.rbMine.id -> navController.navigate(R.id.fragmentMine, null, options)
    }
}

带参数的页面跳转

1. 在 navigation graph中 需要接收参数的fragment下面添加argument标签

<?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/navigation_phone"
    app:startDestination="@id/fragmentHome">
    ...
    <fragment
        android:id="@+id/fragmentParam"
        android:name="com.test.navigationdemo.fragment.ParamsFragment"
        tools:layout="@layout/fragment_parmas">
        <!--
        name：参数名
        argType：参数类型
        defaultValue：默认值
        -->
        <argument
            android:name="name"
            android:defaultValue="nobody"
            app:argType="string" />

        <argument
            android:name="age"
            android:defaultValue="0"
            app:argType="integer" />
    </fragment>

</navigation>

2. kotlin 代码如下

val navDirections =
    MineFragmentDirections.actionFragmentMineToFragmentParam(
        bind.edtName.text.toString().trim(),
        bind.edtAge.text.toString().toIntOrNull() ?: 0
    )
findNavController().navigate(navDirections)

demo下载地址

demo下载地址

参考文献

1. Navigation | Android Developers