MVVMLin一个基于Jetpack+Kotlin+协程+Retrofit的快速开发框架

MVVMLin

一个基于MVVM用Kotlin+Retrofit+协程+Databinding+LiveData来封装的快速开发框架:
项目地址:MVVMLin

Github上关于MVVM的框架也不少,之前一直在用RxJava +Retrofit 用MVP模式来做项目,现在AndroidX 是大势所趋,Kotlin已经成官方语言两年了,今年GoogleIO大会又出了新东西,哎~~~~学不动了呀。近期项目不太忙,把这几个新东西结合起来,封装了一个MVVM的框架,分享出来给大家献丑了。
抛弃了强大的RxJava,心里还是有点虚的。

框架简介

  • 使用技术
    基于MVVM模式用了 kotlin+协程+retrofit+livedata+DataBinding,默认使用了AndroidX
  • 基本封装
    封装了BaseActivity、BaseFragment、BaseViewModel基于协和的网络请方式更加方便,考虑到有些小伙伴不太喜欢用DataBinding在xml中绑定数据的方式,也提供了相应的适配,两种方式自行选择。Retrofit2.6提供了对协程的支持,使用起来更加方便,不用考虑类型的转换了。
  • 特点
    使用Rxjava 处理不好的话会有内存泄露的风险,我们会用使用AutoDispose、RxLifecycle等方式来处理,但是使用协程来请求数据,完全不用担心这个问题,所有请求都是在viewModelScope中启动,当页面销毁的时候,会统一取消,不用关心这个问题了。用Kotlin封装,大量语法糖可使用。
  • 引入第三方库
    AndroidUtilCode:包含了大量的常用工具类,简直是必备神器啊。
    material-dialogs:弹窗
    glide:图片加载
    Retrofit:网络请求

1,如何使用

1.1 启用databinding

在主工程app的build.gradle的android {}中加入:

dataBinding {
    enabled true
}

1.2 依赖

在主项目app的build.gradle中依赖

dependencies {
    ...
   implementation 'me.aleyn:MVVMLin:1.0'
}

或者 下载到本地导入Module

1.3 配置依赖版本文件 config.gradle

复制Demo的 config,gradle 到要目录,在项目的build.gradle 中加入:

apply from: "config.gradle"

2,快速开始

2.1Activity

继承BaseActivity

class DetailActivity : BaseActivity() {
    override fun layoutId() = R.layout.activity_detail
    
    override fun initView(savedInstanceState: Bundle?) {
       ....
    }

    override fun initData() {
      ....
    }
}

第一个泛型是VIewModel,如果页面很简单不需要ViewModel,直接传入NoViewModel即可。
第二个泛型是Databinding,如果页面使用Databinding的话,就要传对应生成的Binding类,如果这个页面不使用DataBinding,传ViewDataBinding,基类不会初始化mBinding而会使用setContentView(l)方式。
layoutId() 方法返回对应布局
initView()initData() 为默认实现,做初始化UI等操作

2.2 Fragment

继承BaseFragment

class HomeFragment : BaseFragment() {
        override fun layoutId() = R.layout.home_fragment
        override fun initView(savedInstanceState: Bundle?) {  }
        override fun lazyLoadData() { 
            ....
        }
}

实现方法同Activity一样,Fragment多了懒加载方法lazyLoadData() 可选择性重写。
setUserVisibleHint() 方法已经被弃用,懒加载使用新的方式实现。

同样Fragment中如果想不使用Databinding,泛型传ViewDataBinding

2,使用DataBinding,布局文件:


    
    .....
    
    .....

泛型传对应生成Binding类:

class ProjectFragment : BaseFragment() {
        .........
}
2.3 ViewModel

继承BaseViewModel

class HomeViewModel : BaseViewModel() {
        .........
}

如果一个页面内容很少,不需要ViewModel,我们可能不想再建一个ViewModel类,泛型传NoViewModel即可。
BaseVIewModel 中对协程进行了简单封装,BaseViewMode 已经做了对网络请求异常的统一处理。比如我们的网络请求可以这样写:

class HomeViewModel : BaseViewModel() {
    private val homeRepository by lazy { InjectorUtil.getHomeRepository() }
    val mBanners = MutableLiveData>()
    fun getBanner() {
        //只返回结果,其他全抛自定义异常
        launchOnlyresult({ homeRepository.getBannerData() }, {
            mBanners.value = it
        })
    }
}

那如果我们想自己处理错误怎么办?

class HomeViewModel : BaseViewModel() {
    private val homeRepository by lazy { InjectorUtil.getHomeRepository() }
    val mBanners = MutableLiveData>()
    fun getBanner() {
        launchOnlyresult({ homeRepository.getBannerData() }, {
            mBanners.value = it
        },{
         // 这里是Error 返回   ()
        })
    }
}

只需要加一个方法参数就行了。

另一种不过滤返回结果的方式:

class MeViewModel : BaseViewModel() {
    private val homeRepository by lazy { InjectorUtil.getHomeRepository() }
    var popularWeb = MutableLiveData>()
    fun getPopularWeb() {
        launch({
            val result = homeRepository.getPopularWeb()  //
            if (result.isSuccess()) {
                popularWeb.value = result.data
            }
        })
    }
}

要自己处理Error 跟上面一样,加一个方法参数就行了。

每个网络请求都会加等待框,如果我们不想要等待框:

 fun getProjectType() {
        launchOnlyresult({
            homeRepository.getNaviJson()
        }, {
            navData.addAll(it)
            it.forEach { item ->
                navTitle.add(item.name)
            }
        }, isShowDialog = false)
 }

isShowDialog 传false,默认是true

3,例子

Demo中只展示了三种列表使用方式

3.1 不使用Databinging,结合BRVAH

详见Demo的 HomeFragment

3.2 使用Databinging,结合bindingcollectionadapter

结合bindingcollectionadapter不用写Adapter适配器了,详见Demo的 ProjectFragment

3.2 使用Databinging,结合BRVAH

BRVAH 对DataBinding也做了支持,详见Demo的 MeFragment

4,关于框架

刚刚完成1.0版,也算是我对新东西的一个学习过程,问题应该还是挺多的,后续会进一步完善,下一步会考虑把Eventbus加进去,也欢迎大家多提意见。顺手给个Stat。哈哈~~~~~~

你可能感兴趣的:(MVVMLin一个基于Jetpack+Kotlin+协程+Retrofit的快速开发框架)