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类的实现):

文件目录
  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)
            }
        }
     }
  1. Repository类:

    实现BmobRepository类,作为HomeViewModel的数据提供方。BmobRepository类中有一个挂起函数getAllRecommendLibrary(libraryRecommendData: MutableLiveData<MutableList<AndroidLibrary>>)用来获取云数据库中的数据,函数的参数是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")
                        }
                    }
                })
            }
        }
     }
  1. 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() }
         }
  1. 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 MVVM 架構-使用 ViewModel、LiveData、Factory 以及 Repository

本项目源代码android_all_star_app

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,290评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,399评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,021评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,034评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,412评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,651评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,902评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,605评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,339评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,586评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,076评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,400评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,060评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,851评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,685评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,595评论 2 270