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<NoViewModel, ViewDataBinding>() {
    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<HomeViewModel, ViewDataBinding>() {
        override fun layoutId() = R.layout.home_fragment
        override fun initView(savedInstanceState: Bundle?) {  }
        override fun lazyLoadData() { 
            ....
        }
}

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

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

2,使用DataBinding,布局文件:

<layout>
    <data>
    .....
    </data>
    .....
</layout>

泛型传对应生成Binding类:

class ProjectFragment : BaseFragment<ProjectViewModel, ProjectFragmentBinding>() {
        .........
}
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<List<BannerBean>>()
    fun getBanner() {
        //只返回结果,其他全抛自定义异常
        launchOnlyresult({ homeRepository.getBannerData() }, {
            mBanners.value = it
        })
    }
}

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

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

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

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

class MeViewModel : BaseViewModel() {
    private val homeRepository by lazy { InjectorUtil.getHomeRepository() }
    var popularWeb = MutableLiveData<List<UsedWeb>>()
    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。哈哈~~~~~~

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

推荐阅读更多精彩内容