Android-ViewModel源码分析

简介

ViewModel是JetPack生命周期管理库中的一个组件。它可以提供并且管理数据，可感知生命周期，同时不会随着配置（eg：屏幕旋转导致的Activity重新创建）变更而改变。 使用它可以方便的将UI界面和数据逻辑剥离开来，从而达到 UI只负责显示数据和处理用户操作，ViewModel负责提供、管理数据以及通讯。 典型使用场景：

• 作为数据持有和管理者（eg：处理网络请求）；
• Fragment之间的通信；
• ViewModel代替加载器（eg：CursorLoader）。

生命周期

官方对其生命周期的描述如下：

ViewModel 对象存在的时间范围是获取 ViewModel 时传递给 ViewModelProvider 的 Lifecycle。ViewModel 将一直留在内存中，直到限定其存在时间范围的 Lifecycle 永久消失：对于 activity，是在 activity 完成时；而对于 fragment，是在 fragment 分离时。

生命周期概括起来就是：从Activity第一次创建ViewModel，直至Activity销毁，ViewModel都一直存在。

基本使用

定义ViewModel：

class CustomModel() : ViewModel() {
    var data = 0
}

初始化和使用：

val customModel = ViewModelProvider(this).get(CustomModel::class.java)
customModel.data = 100;
findViewById<TextView>(R.id.tv).text = "${customModel.data}"

注意：务必不要直接（使用New）创建ViewModel，因为ViewModelProvider是确保ViewModel实例唯一性（同Activity内）和生命周期的关键。

那么如何创建需要初始化参数的ViewModel呢？答案是使用ViewModelProvider.Factory，一个工厂模式：

class CustomModel(data: Int) : ViewModel() {
    
    var data = 0
    init {
        this.data = data
    }
}

class CustomModelFactory(data: Int) : ViewModelProvider.Factory {
    var data = 0
    init {
        this.data = data
    }
    override fun <T : ViewModel?> create(modelClass: Class<T>): T {
        return CustomModel(data) as T
    }
}

使用：

val customModel = ViewModelProvider(this, CustomModelFactory(1000)).get(CustomModel::class.java)
findViewById<TextView>(R.id.tv).text = "${customModel.data}"

源码分析

接下来我们从ViewModel的源码进行分析：

ViewModel的创建

上文中我们说过，必须使用ViewModelProvider去创建ViewModel。这是确保ViewModel实例唯一性和生命周期的关键。那么我们就看一看ViewModelProvider是如何创建ViewModel的。

ViewModelProvider提供了三个构造函数：

• ViewModelProvider(ViewModelStoreOwner);
• ViewModelProvider(ViewModelStoreOwner, Factory);
• ViewModelProvider(ViewModelStore, Factory);

在代码中最终都是通过ViewModelProvider(ViewModelStore, Factory)创建实例：

///构造方法一
public ViewModelProvider(@NonNull ViewModelStoreOwner owner) {
    this(owner.getViewModelStore(), owner instanceof HasDefaultViewModelProviderFactory
            ? ((HasDefaultViewModelProviderFactory) owner).get