Android Navigation组件（二）

Safe Args

Safe Args是官方提供的一个gradle插件来生成一些代码帮助在fragment之间传值，顾名思义就是要保证值传递的安全性，因为bundle传值时是通过key-value的形式，在两个页面之间传值很难形式固定的约束，下个页面接受值的时候总需要做各种判断，防止值不存在或没传递。使用Safe Args之后就不会存在该问题了。但是Safe Args还是基于bundle传值，所以还是建议一次传递小量的数据。

Safe Args的使用方式

在navigation graph文件中声明action和argument
例如, 在第一个fragment中创建action

<action
     android:id="@+id/next_action"
     app:destination="@id/navigation_detail"
/>

在第二个fragment创建argument

   <argument
            android:name="testString"
            app:argType="string"
            app:nullable="true"
            android:defaultValue="@null"
            />

android:defaultValue为必须声明，否则编译时会报错
跳转页面时使用：

val directions = HomeFragmentDirections.nextAction("testString")
findNavController().navigate(directions)

接受值：

val safeArgs: DetailFragmentArgs by navArgs()
text_home.text = safeArgs.testString

Safe Arg原理

在项目中添加了Safe Arg插件之后，在navigation graph添加了action和argument之后，下次编译的时候就会生成对应的辅助类。先看下Directions:

class HomeFragmentDirections private constructor() {
  private data class NextAction(
    val testString: String? = null
  ) : NavDirections {
    override fun getActionId(): Int = R.id.next_action

    override fun getArguments(): Bundle {
      val result = Bundle()
      result.putString("testString", this.testString)
      return result
    }
  }

  companion object {
    fun nextAction(testString: String? = null): NavDirections = NextAction(testString)
  }
}

Directions中定义了一个对应action名字的类名，绑定了对应的action Id, 赋值了声明的Argument，然后通过静态方法将NavDirections实例化返回了出去。结构比较简单，一看就懂。

Args

data class DetailFragmentArgs(
  val testString: String? = null
) : NavArgs {
  fun toBundle(): Bundle {
    val result = Bundle()
    result.putString("testString", this.testString)
    return result
  }

  companion object {
    @JvmStatic
    fun fromBundle(bundle: Bundle): DetailFragmentArgs {
      bundle.setClassLoader(DetailFragmentArgs::class.java.classLoader)
      val __testString : String?
      if (bundle.containsKey("testString")) {
        __testString = bundle.getString("testString")
      } else {
        __testString = null
      }
      return DetailFragmentArgs(__testString)
    }
  }
}

Args辅助类就更加简单了，提供了fromBundle和toBundle两个方法，最终还是通过Bundle传递过去的。
在fromBundle中调用了setClassLoader的方法，这个是什么时候用的呢？
看下接受值的时候获取args的地方：

val safeArgs: DetailFragmentArgs by navArgs()

是通过navArgs方法获取到的，看下navArg方法的源码：

@MainThread
inline fun <reified Args : NavArgs> Fragment.navArgs() = NavArgsLazy(Args::class) {
    arguments ?: throw IllegalStateException("Fragment $this has null arguments")
}

一个Fragment的内联扩展方法，最终获取到了NavArgsLazy类中的value, NavArgsLazy是Kotlin的lazy的一个子类,里面的泛型是NavArgs。DetailFragmentArgs的父类就是NavArgs. NavArgsLazy类的实现：

internal val methodSignature = arrayOf(Bundle::class.java)
internal val methodMap = ArrayMap<KClass<out NavArgs>, Method>()

class NavArgsLazy<Args : NavArgs>(
    private val navArgsClass: KClass<Args>,
    private val argumentProducer: () -> Bundle
) : Lazy<Args> {
    private var cached: Args? = null

    override val value: Args
        get() {
            var args = cached
            if (args == null) {
                val arguments = argumentProducer()
                val method: Method = methodMap[navArgsClass]
                    ?: navArgsClass.java.getMethod("fromBundle", *methodSignature).also { method ->
                        // Save a reference to the method
                        methodMap[navArgsClass] = method
                    }

                @Suppress("UNCHECKED_CAST")
                args = method.invoke(null, arguments) as Args
                cached = args
            }
            return args
        }

    override fun isInitialized() = cached != null
}

可以看到是在Lazy懒加载的基础上添加了一层缓存，使用cached缓存了一次，如果缓存有则直接返回。
如果没有缓存则从arguments中生成。先从argumentProducer获取fragment的arguments对象，然后通过反射fromBundle方法，生成对应的实例。又缓存了一次NavArgs的Method，为了提高性能。