使用Kotlin构建MVVM应用程序—提高篇：ViewModel

写在前面

大家好，这里是使用Kotlin构建MVVM应用程序—提高篇：ViewModel。

本篇文章将介绍google推荐的架构组件ViewModel的使用方法及实现原理。

为什么要有ViewModel?

为什么？看到ViewModel这个名字相信都会联系到MVVM架构中的VM。

但是在我看来，这两者并非是一个意思。如果你想实现MVVM架构的APP，按照

使用Kotlin构建MVVM应用程序基础篇的内容就已经足够了。

而我推测google把它称为ViewModel的原因可能有两点：

ViewModel架构组件是为VM层服务的。
容易联想到MVVM架构，代表着google更推荐Android工程师们应用MVVM架构，而并非冗杂繁复的MVP。

当然这些是题外话。既然不使用ViewModel也能构建MVVM应用，那么ViewModel是来做什么的呢？

The ViewModel class is designed to store and manage UI-related data in a lifecycle conscious way. The ViewModel class allows data to survive configuration changes such as screen rotations.

简单说来，ViewModel是用来存储和管理UI相关的数据，将一个Activity或Fragment组件相关的数据逻辑抽象出来，并能适配组件的生命周期，如当屏幕旋转Activity重建后，ViewModel中的数据依然有效。它还可以帮助开发者轻易实现 Fragment 与 Fragment 之间, Activity 与 Fragment 之间的通讯以及共享数据。

其中最具有吸引力的功能就是屏幕旋转Activity重建后，ViewModel中的数据依然有效。遥想当年，屏幕旋转当真是开发者不得不迈过的槛。而现在很多应用都只要求竖屏或者强制竖屏，不得横屏，所以对于这样的应用，我的建议是可以不用ViewModel组件，按照普通的VM开发就可以了。当然适当了解一下还是可以的。

ViewModel快速开始

首先我们需要在app/build.gradle加入相应的依赖

//ViewModel
implementation "android.arch.lifecycle:extensions:1.1.1"
implementation "android.arch.lifecycle:viewmodel:1.1.1"
kapt "android.arch.lifecycle:compiler:1.1.1"

然后，让你的VM层继承ViewModel组件提供的ViewModel类，如果需要用到Application的context，那么就继承AndroidViewModel类。

class PaoViewModel @Inject constructor(private val repo: PaoRepo) :ViewModel(){
    //...
}

在View层的PaoActivity之中，以前的mViewModel是通过Dagger2注入的，而现在需要进行一下修改

class PaoActivity : RxAppCompatActivity() {

    lateinit var mBinding : PaoActivityBinding

    lateinit var mViewModel : PaoViewModel

    @Inject
    lateinit var factory: ViewModelProvider.Factory
    
     override fun onCreate(savedInstanceState: Bundle?) {
        //....
        mViewModel=ViewModelProviders.of(this,factory).get(PaoViewModel::class.java)
        //...
     }
    
}

这里有两个概念ViewModelProvider.Factory和ViewModelProviders。再继续之前，我们需要先了解如何打造自己的ViewModelProvider.Factory。

ViewModelProvider.Factory

看到这个名字，自然就联想到工厂模式，这里提供我们需要的mViewModel实例。当然ViewModel没有Dagger2那么神奇，不会帮我们自动生成，所以需要我们自己来实现需要的ViewModelProvider.Factory。

class PaoViewModelFactory : ViewModelProvider.Factory{
    //需要实现create方法，返回具体的viewmodel
    override fun  create(modelClass: Class): T {
        //return T
    }
}

那怎么创建具体的实例呢？可以在这里一个个new出相应的依赖，但既然已经有Dagger2这么棒的依赖管理工具，当然是使用Dagger2了。

@Singleton
class PaoViewModelFactory @Inject constructor(private val viewModel:PaoViewModel): ViewModelProvider.Factory{
    override fun  create(modelClass: Class): T {
        if (modelClass.isInstance(viewModel)){
            return viewModel as T
        }else{
            throw IllegalArgumentException("unknown model class $modelClass")
        }
    }

}

到此，当然还没有结束。这样的写法只针对单个ViewModel，如果有多个呢？我们自然不希望出现如下的代码

@Singleton
class PaoViewModelFactory @Inject constructor(private val viewModel:PaoViewModel,private val viewModelOne:OneViewModel,private val viewModelOther:OtherViewModel): ViewModelProvider.Factory{
    override fun  create(modelClass: Class): T {
        return when{
            modelClass.isInstance(viewModel) -> viewModel as T
            modelClass.isInstance(viewModelOne) -> viewModelOne as T
            modelClass.isInstance(viewModelOther) -> viewModelOther as T
            //...
            else -> throw IllegalArgumentException("unknown model class $modelClass")
        }
    }

}

这样费力不太好并且没有效率的事当然不是有(想)效(偷)率(懒)的程序员喜欢做的事。

简单的做法是注入一个map，value是我们需要的ViewModel实例，key值为相应的Class。

幸运的是通过Dagger2的@IntoMap可以为我们自动构造所需的map对象，是不是对Dagger2开始爱不释手了^_

@Module
abstract class ViewModelModule{

    @Binds
    @IntoMap
    @ViewModelKey(PaoViewModel::class)//自定义的mapKey
    abstract fun bindPaoViewModel(viewModel: PaoViewModel):ViewModel
    
//    @Binds
//    @IntoMap
//    @ViewModelKey(OtherViewModel::class)
//    abstract fun bindOtherViewModel(viewModel: OtherViewModel):ViewModel 
//    ...
   
    @Binds
    abstract fun bindViewModelFactory(factory:PaoViewModelFactory):ViewModelProvider.Factory
}

然后它放到AppComponent中

@Singleton
@Component(modules = arrayOf(
        AndroidInjectionModule::class,
        AppModule::class,
        ViewModelModule::class,
        ActivityModule::class)
)
interface AppComponent {}

最后修改PaoViewModelFactory，代码参考自android-architecture-components/GitHubBrowserSample

@Singleton
class PaoViewModelFactory @Inject constructor(private val creators:Map, @JvmSuppressWildcards 
 Provider>): ViewModelProvider.Factory{
    override fun  create(modelClass: Class): T {
        val creator = creators[modelClass]?:creators.entries.firstOrNull{
            modelClass.isAssignableFrom(it.key)
        }?.value?:throw IllegalArgumentException("unknown model class $modelClass")
        try {
            @Suppress("UNCHECKED_CAST")
            return creator.get() as T
        } catch (e: Exception) {
            throw RuntimeException(e)
        }
    }

}

大功告成，现在我们的ViewModel已经具备了屏幕旋转Activity重建后，ViewModel中的数据依然有效的能力。

rotate

写在最后

和Dagger-Android一样，这里只是简单介绍了ViewModel的使用方法，详细的原理分析放在了小专栏里，希望深入了解ViewModel的欢迎订阅一哈> --.>
使用Kotlin构建MVVM应用程序—提高篇：ViewModel(原理剖析)

github地址：https://github.com/ditclear/MVVM-Android/tree/viewmodel

参考文档：
viewmodel组件
Android架构组件——ViewModel（推荐）