阅读 989

Android MVVM 架构应用实现

以前项目中虽然也使用MVVM架构,但由于整体框架不是我自己搭建的,导致我对于MVVM架构的整体还是很不熟悉,所以这次就自己搭建并实现一次MVVM架构。

MVVM架构使用的组件有ViewModel、LiveData、ViewBinding/DataBinding等,这些组件都是Jetpack库中的组件。在使用ViewModel之前要先建立四个类别的概念:

  • ViewModelProcider.Factory:Factory用来生成ViewModel
  • ViewModel:持有LiveData,从Repository获取数据,并向View提供数据
  • Repository:获取和处理数据,可以从网络、数据库或其他API获取并处理数据
  • LiveData:具有生命周期感知能力的可观察的数据存储器,通知View展示数据

下图展示了MVVM架构示意图,以及相关组件在其中的作用。

MVVM架构图

了解了MVVM的基本架构和其中各个组件的作用,可以开始代码实现了。我做这个项目的初衷是因为最近在整理收集Android常用的开源库,为了更方便的展示所实现的一个应用。本项目使用Bmob直接作为后台数据库,接入Bmob SDK后调用API可以直接获取数据,以此来模拟后台接口。同时本项目使用Koin作为依赖注入的框架,省去初始化ViewModel、Repository、ViewModelProcider.Factory的过程。

先贴上项目目录,需要关注的是高亮显示的文件(使用Koin省去了Factory类的实现):

iShot2021-04-11 19.45.41
  1. ViewModel类:

    实现HomeViewModel类,需要继承继承自ViewModel(),作为HomeFragment的ViewModel。HomeViewModel类的构造参数是BmobRepository,类中有一个LiveData变量用来承载数据,一个函数getAllRecommendLibrary()获取开源库数据,函数实现是repository在协程中获取云数据库中的数据:

    class HomeViewModel(private val repository: BmobRepository) : ViewModel() {
        var libraryRecommendData = MutableLiveData<MutableList<AndroidLibrary>>()
    
        fun getAllRecommendLibrary() {
            viewModelScope.launch {
                repository.getAllRecommendLibrary(libraryRecommendData)
            }
        }
    }
    复制代码
  2. Repository类:

    实现BmobRepository类,作为HomeViewModel的数据提供方。BmobRepository类中有一个挂起函数getAllRecommendLibrary(libraryRecommendData: MutableLiveData<MutableList>)用来获取云数据库中的数据,函数的参数是LiveData,在获取数据后,利用setValue通知View展示数据。

    class BmobRepository {
        /**
         * 获取Bmob中所有推荐开源项目
         */
        suspend fun getAllRecommendLibrary(libraryRecommendData: MutableLiveData<MutableList<AndroidLibrary>>) {
            return withContext(Dispatchers.IO) {
                val bombQuery: BmobQuery<AndroidLibrary> = BmobQuery()
                bombQuery.findObjects(object : FindListener<AndroidLibrary>() {
                    override fun done(data: MutableList<AndroidLibrary>?, ex: BmobException?) {
                        if (ex == null) {
                            Timber.d("Bmob find success")
                            libraryRecommendData.value = data!!
                        } else {
                            Timber.d("Bmob exception $ex")
                        }
                    }
                })
            }
        }
    }
    复制代码
  3. Koin初始化:

    Koin的初始化分为两步:

    • 定义ViewModel,告诉Kioin从哪里找到ViewModel和Repository并自动生成,这里我选择直接写在BaseApplication中,需要注意的是需要定义在最外层,即和Classt同级:

    • 在Application的onCreate()函数中初始化Koin:

      class BaseApplication : Application() {
          override fun onCreate() {
              super.onCreate()
              //初始化Bmob
              Bmob.initialize(this, Constant.BMOB_APP_ID)
              //初始化Timber
              if (BuildConfig.DEBUG) {
                  Timber.plant(Timber.DebugTree())
              }
      
      		//第二步:
              startKoin {
                  //Android context
                  androidContext(this@BaseApplication)
                  //modules
                  val list = listOf(myModule, repoModel)
                  modules(list)
              }
          }
      }
      //第一步:
      //定义一个myModule作为Viewmodel
      val myModule = module {
          viewModel { HomeViewModel(get()) }
      }
      //定义一个repoModule
      val repoModel = module {
          single { BmobRepository() }
      }
      复制代码
  4. Fragment类实现:

实现HomeFragment类作为视图层,其中分为两步:

  • 变量homeViewModel作为ViewModel获取数据,使用Koin后的初始化方式十分简单

    private val homeViewModel: HomeViewModel by viewModel()//懒加载初始化
    复制代码
  • LiveData注册监听ViewModel中的数据改变,并实现获取数据后的操作

        private fun initRegister() {
            //LiveData在视图层中注册监听后,在ViewModel中的数据改变时可以持续收到数据
            homeViewModel.libraryRecommendData.observe(viewLifecycleOwner, {
                Timber.d("t $it")
                (binding.rvAndroidLibrary.adapter as AndroidLibraryAdapter).apply {
                    data = it
                    notifyDataSetChanged()
                }
            })
        }
    复制代码
  • ViewModel调用函数通知Repository去查询数据:

        override fun onResume() {
            super.onResume()
            homeViewModel.getAllRecommendLibrary()
        }
    复制代码

自此,一个MVVM架构的应用搭建完成,第一次独立的搭建MVVM架构之后,对于MVVM架构的理解加深了不少,对于JetPack库中的组件和其它开源库也有了新的认识,此外MVVM架构还经常和Retrofit、RxJava等开源库配合使用,希望以后有机会可以再进行实践操作!!

本项目源代码android_all_star_app

本项目使用开源组件库:koin、timber、permissionx、BaseRecyclerViewAdapterHelper

参考文章:Android MVVM 架構-使用 ViewModel、LiveData、Factory 以及 Repository

文章分类
Android
文章标签