Navigation导航到目的地(Safe Args 数据传递)
1. 导航到目的地的几种方式
导航到目的地是使用 NavController
完成的,每个 NavHost
均有自己的相应 NavController
。NavController
提供了几种导航到目的地的不同方式。
1.1 使用 Safe Args 实现类型安全的导航(官方推荐使用方式传递数据)
要将 Safe Args 添加到您的项目,请在顶级 build.gradle
文件中包含以下 classpath
:
buildscript {
repositories {
google()
}
dependencies {
def nav_version = "2.3.0-alpha01"
classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"
}
}
image-20200926205625459
要生成适用于 Java 或 Java 和 Kotlin 混合模块的 Java 语言代码,请将以下行添加到应用或模块的 build.gradle
文件中:
apply plugin: "androidx.navigation.safeargs"
此外,要生成适用于 Kotlin 独有的模块的 Kotlin 代码,请添加以下行:
apply plugin: "androidx.navigation.safeargs.kotlin"
image-20200926205750599
启用 Safe Args 后,生成的代码会包含已定义的每个操作的类和方法,以及与每个发送目的地和接收目的地相对应的类。
Safe Args 为生成操作的每个目的地生成一个类。生成的类名称会在源目的地类名称的基础上添加“Directions”。例如,如果源目的地的名称为 SpecifyAmountFragment
,则生成的类的名称为 SpecifyAmountFragmentDirections
。
如果找不到Directions类
1. 请先在Navigation xml中创建目的地action
2. 重新build项目
生成的类为源目的地中定义的每个操作提供了一个静态方法。该方法接受任何定义的操作参数为参数,并返回可直接传递到 navigate()
的 NavDirections
对象。
Safe Args 示例
例如,假设我们的两个目的地 SpecifyAmountFragment
和 ConfirmationFragment
从SpecifyAmountFragment
跳转至 ConfirmationFragment
并携带一个 float
参数 location
。
1. 在起始目的地设置参数(bundle方式传递)
首先,在Navigation的xml中添加参数,注意,是在起始目的地specifyAmountFragment中设置
<fragment
android:id="@+id/specifyAmountFragment"
android:name="com.bosma.navigationdemo.safeargs.SpecifyAmountFragment"
tools:layout="@layout/fragment_specify_amount" >
<argument
android:name="location"
app:argType="float" />
<action
android:id="@+id/action_specifyAmountFragment_to_confirmationFragment"
app:destination="@id/confirmationFragment" />
</fragment>
<fragment
android:id="@+id/confirmationFragment"
android:name="com.bosma.navigationdemo.safeargs.ConfirmationFragment"
tools:layout="@layout/fragment_confirmation" />
image-20200926211330481
重新build项目之后,会生成相应的参数
image-20200926211457635SpecifyAmountFragment
中点击按钮跳转代码如下:
//点击按钮进行跳转
navToButton.setOnClickListener {
val float = 21.1234f //要传递的值
val bundle = SpecifyAmountFragmentArgs(float).toBundle()
findNavController().navigate(R.id.action_specifyAmountFragment_to_confirmationFragment, bundle)
}
ConfirmationFragment
中接受参数代码如下
if (arguments != null) {
//接收location参数
val location = SpecifyAmountFragmentArgs.fromBundle(arguments!!).location
tvText.text = location.toString()
}
2. 在终点目的地设置参数(bundle方式传递)
在Navigation的xml中添加参数,注意,是在终点目的地confirmationFragment中设置
<fragment
android:id="@+id/specifyAmountFragment"
android:name="com.bosma.navigationdemo.safeargs.SpecifyAmountFragment"
tools:layout="@layout/fragment_specify_amount" >
<action
android:id="@+id/action_specifyAmountFragment_to_confirmationFragment"
app:destination="@id/confirmationFragment" />
</fragment>
<fragment
android:id="@+id/confirmationFragment"
android:name="com.bosma.navigationdemo.safeargs.ConfirmationFragment"
tools:layout="@layout/fragment_confirmation">
<argument
android:name="location"
app:argType="float" />
</fragment>
设置完毕,重新build一下项目
SpecifyAmountFragment
中点击按钮跳转代码如下:
//点击按钮进行跳转
navToButton.setOnClickListener {
val float = 21.1234f //要传递的值
//通过action快捷设置参数
val action = SpecifyAmountFragmentDirections.actionSpecifyAmountFragmentToConfirmationFragment(float)
findNavController().navigate(action)
}
ConfirmationFragment
中接受参数代码如下
//ConfirmationFragment的变量
val args: ConfirmationFragmentArgs by navArgs()
//接收location参数
val location = args.location
tvText.text = location.toString()
如果出现 Cannot inline bytecode built with JVM target 1.8 into bytecode that is being built with JVM target 1.6. Please specify proper '-jvm-target' option
错误,请在 app module的build.gradle中设置
android {
....//忽略
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
kotlinOptions {
jvmTarget = "1.8"
}
}
3. 通过Navigation面板设置 Safe args 参数
- 在 Navigation Editor 中,点击接收参数的目的地。
- 在 Attributes 面板中,点击 Add (+)。
- 在显示的 Add Argument Link 窗口中,输入参数名称、参数类型、参数是否可为 null,以及默认值(若需要)。
- 点击 Add。请注意,该参数现在会显示在 Attributes 面板的 Arguments 列表中。
- 接下来,点击会将您转到此目的地的相应操作。在 Attributes 面板中,您现在应该会在 Argument Default Values 部分中看到新添加的参数。
- 您还可以看到该参数已添加到 XML 中。点击 Text 标签切换到 XML 视图,就会发现您的参数已添加到接收该参数的目的地中。相关示例如下所示:
<fragment
android:id="@+id/confirmationFragment"
android:name="com.bosma.navigationdemo.safeargs.ConfirmationFragment"
tools:layout="@layout/fragment_confirmation">
<argument
android:name="location"
app:argType="float" />
</fragment>
image-20200926222152134