Android 跨Activity（Fragment）共享ViewModel无反射实现

在 第一版 实现中使用到了基于注解的方式去标记作用域，再通过反射注入对象的方式实现，这种方式不仅效率低使用也不太灵活，有个很大的弊端无法使用自定义ViewModelFactory。

所以在第二版优化中将抛弃注解反射的方式，实现灵感来源于fragment-ktx中的viewModles()扩展方法。由第一版中所讲到的共享原理可知我们只需要保证从同一个Stroe中去获取ViewModel，那么同类型的ViewModel被获取到时始终都会时同一个。

首先我们需要引入扩展包：

implementation 'androidx.fragment:fragment-ktx:1.2.4'

并且在App模块中的Gradle配置虚拟机版本，否则无法使用内连函数

kotlinOptions{
jvmTarget = "1.8"
}

使用扩展方法配合Lazy实现viewModel注入，此种实现方式特点可感知生命周期，如果同一个key标记的viewModel界面都被销毁了则会自动清除ViewModelStore不会导致内存泄漏问题。

复制ShareViewModel.kt文件到项目中

package com.cj.customwidget.page.viewmodelv2

import androidx.lifecycle.*

val vMStores = HashMap()

inline fun  LifecycleOwner.shareViewModels(
    scopeName:String,
    factory: ViewModelProvider.Factory?=null
):Lazy {
    val store: VMStore
    if (vMStores.keys.contains(scopeName)) {
        store = vMStores[scopeName]!!
    } else {
        store = VMStore()
        vMStores[scopeName] = store
    }
    store.register(this)
    return ViewModelLazy(VM::class,{store.viewModelStore},{factory?:ViewModelProvider.NewInstanceFactory()})
}

class VMStore : ViewModelStoreOwner {

    private val bindTargets = ArrayList()
    private var vmStore: ViewModelStore? = null

    fun register(host: LifecycleOwner) {
        if (!bindTargets.contains(host)) {
            bindTargets.add(host)
            host.lifecycle.addObserver(object : LifecycleEventObserver {
                override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {
                    if (event == Lifecycle.Event.ON_DESTROY) {
                        host.lifecycle.removeObserver(this)
                        bindTargets.remove(host)
                        if (bindTargets.isEmpty()) {//如果当前商店没有关联对象，则释放资源
                            vMStores.entries.find { it.value == this@VMStore }?.also {
                                vmStore?.clear()
                                vMStores.remove(it.key)
                            }
                        }
                    }
                }
            })
        }
    }

    override fun getViewModelStore(): ViewModelStore {
        if (vmStore == null)
            vmStore = ViewModelStore()
        return vmStore!!
    }
}

使用方式,使用懒加载的方式并传入分组key即可，相同的key会共享同一个ViewModelStore对象。

class VM1Activity : AppCompatActivity() {
     val vm:ViewModel1 by shareViewModels("Lucas")
}

class VM2Activity : AppCompatActivity() {
     val vm:ViewModel1 by shareViewModels("Lucas")
}

class VMFragment: Fragment() {
     val vm:ViewModel1 by shareViewModels("Lucas")
}

运行查看多个界面间对象地址是否相同

image.png

当然我们可以自己通过定义ViewModelProvider.Fractory的方式来决定创建那些VIewModel以及对ViewModel进行构造穿参。
如果没有传入ViewModelProvider.Fractory内部会使用默认的工厂进行创建ViewModel.

class ViewModel2(val param:String):ViewModel() {

    fun test(){
        "aaaaa".p()
    }
}

class VM1Activity : AppCompatActivity() {
     val vm:ViewModel2 by shareViewModels("lucas",object :ViewModelProvider.Factory{
         override fun  create(modelClass: Class): T {
             return ViewModel2("哈哈") as T
         }
     })
}

项目地址：https://github.com/LucasDevelop/CustomView. 中的View model 案例