Jetpack学习(一) Navigation

Navigation 组件旨在用于具有一个主 Activity 和多个 Fragment 目的地的应用。

添加Navigation的依赖(在app的build.gradle)

def nav_version = "2.3.3"
implementation "androidx.navigation:navigation-fragment-ktx:$nav_version"
implementation "androidx.navigation:navigation-ui-ktx:$nav_version"

Navigation 组件具有一个名为 Safe Args 的 Gradle 插件，该插件可以生成简单的 object 和 builder 类，以便以类型安全的方式浏览和访问任何关联的参数。我们强烈建议您将 Safe Args 用于导航和数据传递，因为它可以确保类型安全。

1、建立导航配置

a、在“Project”窗口中，右键点击 res 目录，然后依次选择 New > Android Resource File。此时系统会显示 New Resource File 对话框。

b、在 File name 字段中输入名称，例如“nav_graph”。

c、从 Resource type 下拉列表中选择 Navigation，然后点击 OK。

2、向Activity添加NavHost

主 Activity 与导航图相关联，且包含一个负责根据需要交换目的地的 NavHostFragment。在具有多个 Activity 目的地的应用中，每个 Activity 均拥有其自己的导航图。

使用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=".MainActivity">

    <androidx.fragment.app.FragmentContainerView
        android:id="@+id/nav_host_fragment"
        android:name="androidx.navigation.fragment.NavHostFragment"
        android:layout_width="0dp"
        android:layout_height="0dp"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintBottom_toBottomOf="parent"

        app:defaultNavHost="true"
        app:navGraph="@navigation/nav_graph" />


</androidx.constraintlayout.widget.ConstraintLayout>

1、android:name 属性包含 NavHost 实现的类名称。

2、app:navGraph 属性将 NavHostFragment 与导航图相关联。导航图会在此 NavHostFragment 中指定用户可以导航到的所有目的地。

3、app:defaultNavHost="true" 属性确保您的 NavHostFragment 会拦截系统返回按钮。请注意，只能有一个默认 NavHost。如果同一布局（例如，双窗格布局）中有多个宿主，请务必仅指定一个默认 NavHost。

3、添加页面（fragment）和页面跳转

在nav_graph配置

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


    <fragment
        android:id="@+id/onefragment"
        android:name="com.example.myapplication.fragment.OneFragment"
      >


        <action
            android:id="@+id/action_onefragment_to_twofragment"
            app:destination="@id/twofragment" />
    </fragment>

    <fragment
        android:id="@+id/twofragment"
        android:name="com.example.myapplication.fragment.TwoFragment"
         />


</navigation>

<fragment>标签里面id是当前fragment的标识，name是该标签对应的实际的fragment的类。

<fragment>标签里面的<action>标签，定义导航栏跳转的动作，id代表该动作的命名，用于在代码中引用该动作，destination代表跳转的目的地，对应跳转到的<fragment>里面的id。

跳转也很简单，获取到当前的NavController，直接调用navigate，填写<action>标签的id即可，如下：

      val navController = findNavController()
      navController.navigate(R.id.action_onefragment_to_twofragment)

4、使用safeArgs传参

在项目的build.gradle添加

    def nav_version = "2.3.4"
    classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"

在app的build.gradle里面添加

apply plugin: "androidx.navigation.safeargs.kotlin"

使用该插件，比如我当前页面为OneFragment，跳转到TwoFragment
配置好xml后，点击Build->Make Project会自动生成当前页面的Directions类，我当前页面是OneFragment，则生成OneFragmentDirections。
会在OneFragmentDirections类，并且生成一个方法，方法名字对应OneFragment的action标签里面的id，比如我的action的id叫action_onefragment_to_twofragment，会生成一个方法actionOnefragmentToTwofragment

然后在需要跳转到目的地TwoFragment的标签里面添加<argument>标签，用于标注需要从OneFragment传递的参数，<argument>的name，类似bundle传参里面的key， argType指定参数类型，支持的类型跟bundle一样，如下图。

TwoFragment的<argument>标签配置，会在OneFragmentDirections的actionOnefragmentToTwofragment方法生成待传入参数的方法，有几个<argument>标签，该方法就会变成有几个参数的方法。内部实际上还是bundle传递。在生成一个根据该Fragment名字后加Args的类，比如跳转目的地TwoFragment会生成TwoFragmentArgs，这个类和<argument>标签是对应的。用于目的地TwoFragment取参数。

  <fragment
        android:id="@+id/onefragment"
        android:name="com.example.myapplication.fragment.OneFragment"
        >
        <action
            android:id="@+id/action_onefragment_to_twofragment"
            app:destination="@id/twofragment" />
    </fragment>

    <fragment
        android:id="@+id/twofragment"
        android:name="com.example.myapplication.fragment.TwoFragment"
        >

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

    </fragment>

跳转时

   val navController = findNavController()
   val amount = 123;

  val action = OneFragmentDirections.actionOnefragmentToTwofragment(amount);
            navController.navigate(action)

actionOnefragmentToTwofragment这个方法在自动生成的代码里实际上是：

public class OneFragmentDirections private constructor() {
  private data class ActionOnefragmentToTwofragment(
    public val amount: Int = 0
  ) : NavDirections {
    public override fun getActionId(): Int = R.id.action_onefragment_to_twofragment

    public override fun getArguments(): Bundle {
      val result = Bundle()
      result.putInt("amount", this.amount)
      return result
    }
  }

  public companion object {
    public fun actionOnefragmentToTwofragment(amount: Int = 0): NavDirections =
        ActionOnefragmentToTwofragment(amount)
  }
}

image.png

5、在目的地TwoFragment取参

在跳转后的TwoFragment中，直接使用by navArgs()即可取到参数，在<fragment>标签中配置的 <argument>参数

class TwoFragment : Fragment() {

    val args: TwoFragmentArgs by navArgs()

    override fun onCreateView(
        inflater: LayoutInflater,
        container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {

        val view = inflater.inflate(R.layout.fragment_two, container, false)
        return view;
    }

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

        textview.text = args.amount.toString() ;

    }
}

6、ProGuard 注意事项

-keepnames class com.path.to.your.ParcelableArg
-keepnames class com.path.to.your.SerializableArg
-keepnames class com.path.to.your.EnumArg