Android Navigation 组件原理和使用教程

Android Navigation 组件是用于简化导航相关操作的框架，允许你在应用中管理应用内各个部分之间的导航。该组件是Android Jetpack的一部分，主要包含三个部分：导航图（NavGraph）、NavHost和NavController。

一、原理

1. Navigation Graph（导航图）：定义了应用中各个页面及其间的可能路径。它是一个XML文件，包含应用的所有目的地（Destination）和这些目的地之间的连接（Actions）。

2. NavHost：是一个空的容器，用于显示导航图中的每个目的地。最常用的是NavHostFragment，它是一个特殊的Fragment，用于管理导航图。

3. NavController：管理应用的导航和控制导航图中的导航操作。每个NavHost都有一个与之关联的NavController。

二、使用详细教程

1. 添加依赖项

首先，需要在项目的build.gradle文件中添加Navigation组件的依赖项：

dependencies {
    def nav_version = "2.5.3"

    implementation "androidx.navigation:navigation-fragment-ktx:$nav_version"
    implementation "androidx.navigation:navigation-ui-ktx:$nav_version"
}

2. 创建导航图

在res/navigation目录下创建一个新的导航图文件，比如nav_graph.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/homeFragment">

    <fragment
        android:id="@+id/homeFragment"
        android:name="com.example.app.HomeFragment"
        android:label="Home"
        tools:layout="@layout/fragment_home" >
        <action
            android:id="@+id/action_homeFragment_to_detailFragment"
            app:destination="@id/detailFragment" />
    </fragment>

    <fragment
        android:id="@+id/detailFragment"
        android:name="com.example.app.DetailFragment"
        android:label="Detail"
        tools:layout="@layout/fragment_detail" />
</navigation>

3. 设置NavHostFragment

在你的Activity的布局文件中添加NavHostFragment：

<androidx.fragment.app.FragmentContainerView
    android:id="@+id/nav_host_fragment"
    android:name="androidx.navigation.fragment.NavHostFragment"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:navGraph="@navigation/nav_graph"
    app:defaultNavHost="true" />

4. 配置NavController

在你的Activity中配置NavController：

class MainActivity : AppCompatActivity() {

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

        val navHostFragment = supportFragmentManager
            .findFragmentById(R.id.nav_host_fragment) as NavHostFragment
        val navController = navHostFragment.navController
        // 配置ActionBar与NavController联动
        setupActionBarWithNavController(navController)
    }

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

5. 在Fragment中导航

在你的Fragment中使用NavController进行导航：

class HomeFragment : Fragment(R.layout.fragment_home) {

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

        val navController = findNavController()

        view.findViewById<Button>(R.id.button_navigate).setOnClickListener {
            navController.navigate(R.id.action_homeFragment_to_detailFragment)
        }
    }
}

详细语法讲解

1. 导航图：通过定义XML文件来描述应用中的各个目的地和它们之间的关系。

2. NavHostFragment：作为容器展示当前目的地的Fragment。

3. NavController：用于控制导航操作，提供navigate方法进行导航。

4. 导航动作（Actions）：在导航图中定义，用于描述从一个目的地到另一个目的地的路径。

5. 导航参数：可以在导航时传递数据，使用SafeArgs插件生成类型安全的参数。

6. 返回栈管理：NavController会自动管理返回栈，你也可以通过navigateUp等方法进行自定义处理。

示例代码

1. 安装SafeArgs插件

在项目的build.gradle文件中添加：

buildscript {
    dependencies {
        classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"
    }
}

apply plugin: 'androidx.navigation.safeargs'

2. 在导航图中定义参数

<fragment
    android:id="@+id/detailFragment"
    android:name="com.example.app.DetailFragment"
    android:label="Detail"
    tools:layout="@layout/fragment_detail">
    <argument
        android:name="itemId"
        app:argType="integer" />
</fragment>

3. 在代码中传递参数

val action = HomeFragmentDirections.actionHomeFragmentToDetailFragment(itemId = 1)
navController.navigate(action)

4. 在目标Fragment中接收参数

class DetailFragment : Fragment(R.layout.fragment_detail) {

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

        val args: DetailFragmentArgs by navArgs()
        val itemId = args.itemId
        // 使用itemId进行操作
    }
}

通过以上步骤，你可以非常详细地理解和使用Android Navigation组件来管理应用内的导航。
联系我