fate:拆分基类

aleyn97 · Jul 31, 2022 · ce4277c · ce4277c
1 parent 21e7ec5
commit ce4277c
Show file tree

Hide file tree

Showing 16 changed files with 308 additions and 252 deletions.
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/README.md b/README.md
@@ -1,51 +1,76 @@
 # MVVMLin
+
 一个基于MVVM用Kotlin+Retrofit+协程+Databinding(ViewBinding)+LiveData来封装的快速开发框架：
 项目地址：[MVVMLin](https://github.com/AleynP/MVVMLin)
 
-### 框架简介
- - **使用技术**
- 基于MVVM模式用了 kotlin+协程+retrofit+livedata+DataBinding
- - **基本封装**
- 封装了BaseActivity、BaseFragment、BaseViewModel基于协和的网络请方式更加方便，考虑到有些小伙伴不太喜欢用DataBinding在xml中绑定数据的方式，也提供了相应的适配，两种方式自行选择。Retrofit2.6及以上版本提供了对协程的支持，使用起来更加方便，不用考虑类型的转换了。
-- **特点**
-使用Rxjava 处理不好的话会有内存泄露的风险，我们会用使用**AutoDispose、RxLifecycle**等方式来处理，但是使用协程来请求数据，完全不用担心这个问题，所有请求都是在**viewModelScope**中启动，当页面销毁的时候，会统一取消，不用关心这个问题了。用Kotlin封装，大量语法糖可心使用。
-- 	**引入第三方库**
+## 框架简介
+
+- **使用技术**
+  基于MVVM模式用了 kotlin+协程+retrofit+livedata+DataBinding
+- **基本封装**
+  封装了BaseActivity、BaseFragment、BaseViewModel基于协和的网络请方式更加方便，考虑到有些小伙伴不太喜欢用DataBinding在xml中绑定数据的方式，也提供了相应的适配，两种方式自行选择。Retrofit2.6及以上版本提供了对协程的支持，使用起来更加方便.
+  增加了 Flow 的转换
+- **引入第三方库**
 
 [AndroidUtilCode](https://github.com/Blankj/AndroidUtilCode)：包含了大量的常用工具类，简直是必备神器啊。
 
 [material-dialogs](https://github.com/afollestad/material-dialogs)：弹窗
 
-~~[glide](https://github.com/bumptech/glide)：图片加载(弃用1.0.5)~~
-
 [coil](https://github.com/coil-kt/coil)：图片加载(更适合KT的图片加载)
 
 [Retrofit](https://github.com/bumptech/glide)：网络请求
-### 1，如何使用
-##### 1.1 启用databinding
+
+## 使用方式
+
+### 启用dataBinding
+
 在主工程app的build.gradle的android {}中加入：
+
+``` groovy
+    buildFeatures {
+        //dataBinding = true
+        viewBinding = true
+    }
 ```
-dataBinding {
-    enabled true
-}
-```
-#### 1.2 依赖
+
+### 依赖
+
 在主项目app的build.gradle中依赖
-```
+
+``` groovy
 dependencies {
     ...
-   implementation 'me.aleyn:MVVMLin:1.0.6'
+   implementation 'com.github.AleynP:MVVMLin:2.0.0'
 }
 ```
+
 或者 下载到本地导入Module
-#### 1.3 配置 buildSrc (1.0.6 版本改为 butkdSrc 方式构建)
+
+#### 配置 buildSrc (1.0.6 版本改为 butkdSrc 方式构建)
+
 复制Demo的 buildSrc 到根目录,用Gradle 同步。AS会自动识别 buildSrc目录 (远程依赖可以忽略)
 
-### 2，快速开始
-#### 2.1Activity
-继承BaseActivity
+#### 添加 FlowAdapter
+
+```kotlin
+    Retrofit.Builder()
+    .addCallAdapterFactory(FlowAdapterFactory.create(true))
+    //...
+    .build()
 ```
-class DetailActivity : BaseActivity<NoViewModel, ViewBinding>() {
-	override fun layoutId() = R.layout.activity_detail
+
+如上添加 `FlowAdapter`后， Retrofit 可直接返回 Flow 类型。
+
+## 快速开始
+
+### Activity
+
+继承BaseVMActivity
+
+``` kotlin
+class DetailActivity : 继承BaseVMActivity<NoViewModel, ViewBinding>() {
+
+	override val layoutId() = R.layout.activity_detail
 
 	override fun initView(savedInstanceState: Bundle?) {
        ....
@@ -56,141 +81,109 @@ class DetailActivity : BaseActivity<NoViewModel, ViewBinding>() {
     }
 }
 ```
-第一个泛型是ViewModel,如果页面很简单不需要ViewModel，直接传入NoViewModel即可。
-第二个泛型是Databinding 或者 ViewBinding 的生成类，如果页面使用Databinding或者ViewBinding的话，就要传对应的Binding生成类，如果不使用DataBinding或者ViewBinding，传 ViewBinding 。基类不用初始化mBinding而会使用常规方式。
- **layoutId()** 方法返回对应布局。当使用ViewBinding时 不用重写此方法，其余都要重写 返回布局 Id
- **initView()** 和 **initData()** 为默认实现，做初始化UI等操作
-##### 2.2 Fragment
-继承BaseFragment
-```
-class HomeFragment : BaseFragment<HomeViewModel, ViewBinding>() {
+
+第一个泛型是ViewModel,如果页面很简单不需要ViewModel，可以继承BaseActivity。 第二个泛型是Databinding 或者 ViewBinding
+的生成类，如果页面使用Databinding或者ViewBinding的话，就要传对应的Binding生成类，如果不使用DataBinding或者ViewBinding，传 ViewBinding
+。基类不用初始化mBinding而会使用常规方式。
+** layoutId ** 方法返回对应布局。当使用ViewBinding时 不用重写此方法，其余都要重写 返回布局 Id
+**initView()** 和 **initData()** 为默认实现，做初始化UI等操作
+
+### Fragment
+
+继承BaseVMFragment
+
+``` kotlin
+class HomeFragment : 继承BaseVMFragment<HomeViewModel, ViewBinding>() {
+
 		override fun layoutId() = R.layout.home_fragment
+
 		override fun initView(savedInstanceState: Bundle?) {  }
+
 		override fun lazyLoadData() {
 			....
 		}
 }
 ```
-实现方法同Activity一样，Fragment多了懒加载方法**lazyLoadData()** 可选择性重写。
- **setUserVisibleHint()** 方法已经被弃用，懒加载使用新的方式实现。
-
-同样Fragment中如果想不使用Databinding或者ViewBinding，泛型传**ViewBinding**：
 
-2，使用DataBinding,布局文件：
-```
-<layout>
-    <data>
-    .....
-    </data>
-    .....
-</layout>
-```
+实现方法同Activity一样，Fragment多了懒加载方法**lazyLoadData()** 可选择性重写。
 
+### ViewModel
 
-泛型传对应生成Binding类：
-```
-class ProjectFragment : BaseFragment<ProjectViewModel, ProjectFragmentBinding>() {
-		.........
-}
-```
-##### 2.3 ViewModel
 继承BaseViewModel
-```
+
+``` kotlin
 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
-        })
-    }
-}
-```
-那如果我们想自己处理错误怎么办？
+
+在Application 中设置全局网络异常处理(可选)
+
+```kotlin
+
+MVVMLin.setNetException(CoroutineExceptionHandler { context, e ->
+    //...
+})
+
 ```
+
+**ViewModel** 中所有网络请求都写要 BaseViewModel 的 `launch` 作用域中，如下：
+
+#### Flow 方式(同 RxJava 相似)
+
+``` kotlin
 class HomeViewModel : BaseViewModel() {
     private val homeRepository by lazy { InjectorUtil.getHomeRepository() }
-    val mBanners = MutableLiveData<List<BannerBean>>()
-    fun getBanner() {
-        launchOnlyresult({ homeRepository.getBannerData() }, {
-            mBanners.value = it
-        },{
-         // 这里是Error 返回   ()
-        })
+    private val _banners = MutableSharedFlow<List<BannerBean>>()
+    val mBanners: SharedFlow<List<BannerBean>> = _banners
+    fun getBanner(refresh: Boolean = false) {
+        //只返回结果，其他全抛自定义异常
+        launch {
+            homeRepository.getBannerData(refresh)
+                .asResponse()
+                .bindLoading(this@HomeViewModel)//绑定Lodaing
+                .collect(_banners)
+        }
     }
 }
 ```
-只需要加一个方法参数就行了。
 
-另一种不过滤返回结果的方式：
+##### 操作符
+
+以下几个是用 Flow 时用到的操作符：
+
+- asResponse: 只取成功结果其他全抛异常
+- asSuccess:只做成功处理，不关心结果
+- bindLoading: 绑定Loading
+- netCache: 自定义错误处理,返回的是 ResponseThrowable
+
+#### 普通方式
+
 ```
-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
+class ProjectViewModel : BaseViewModel() {
+    fun getProjectList(cid: Int) {
+        launch {
+            homeRepository.getProjectList(page, cid).getOrThrow()
+            .let {
+                items.clear()
+                items.addAll(it.datas)
             }
-        })
+        }
     }
 }
 ```
-要自己处理Error 跟上面一样，加一个方法参数就行了。
 
-每个网络请求都会加等待框，如果我们不想要等待框：
-```
- fun getProjectType() {
-        launchOnlyresult({
-            homeRepository.getNaviJson()
-        }, {
-            navData.addAll(it)
-            it.forEach { item ->
-                navTitle.add(item.name)
-            }
-        }, isShowDialog = false)
- }
-```
-isShowDialog 传false，默认是true
+##### 转换符
 
-用Flow流的方式：
-```
-fun getFirstData() {
-        launchUI {
-            launchFlow { homeRepository.getNaviJson() }
-                .flatMapConcat {
-                    return@flatMapConcat if (it.isSuccess()) {
-                        navData.addAll(it.data)
-                        it.data.forEach { item -> navTitle.add(item.name) }
-                        launchFlow { homeRepository.getProjectList(page, it.data[0].id) }
-                    } else throw ResponseThrowable(it.errorCode, it.errorMsg)
-                }
-                .onStart { defUI.showDialog.postValue(null) }
-                .flowOn(Dispatchers.IO)
-                .onCompletion { defUI.dismissDialog.call() }
-                .catch {
-                    // 错误处理
-                    val err = ExceptionHandle.handleException(it)
-                    LogUtils.d("${err.code}: ${err.errMsg}")
-                }
-                .collect {
-                    if (it.isSuccess()) items.addAll(it.data.datas)
-                }
-        }
+以下几个是不使用 Flow 时用到的转换符：
+
+- getOrThrow: 只取成功结果其他全抛异常
+- check:检测是否成功
+
+#### IBaseResponse
+
+由于请求中依赖了数据基类，我们每个项目的基类字段都不相同，所以我们根据后台的字段定义完基类以后，要实现IBaseResponde接口,如下：
 
-    }
-```
-##### 2.4 IBaseResponse
-由于请求中依赖了基类，我们每个项目的基类字段都不相同，所以我们根据后台的字段定义完基类以后，要实现IBaseResponde接口,如下：
 ```
 data class BaseResult<T>(
     val errorMsg: String,
@@ -207,19 +200,26 @@ data class BaseResult<T>(
     override fun isSuccess() = errorCode == 0
 }
 ```
+
 来保证过滤请求结果的正常使用
 
-### 3，例子
+### 例子
+
 Demo中只展示了三种列表使用方式
-##### 3.1 不使用Databinging,结合[BRVAH](https://github.com/CymChad/BaseRecyclerViewAdapterHelper)
+
+#### 不使用Databinging,结合[BRVAH](https://github.com/CymChad/BaseRecyclerViewAdapterHelper)
+
 详见Demo的 **HomeFragment**
-##### 3.2 使用Databinging,结合[bindingcollectionadapter](https://github.com/evant/binding-collection-adapter)
+
+#### 使用Databinging,结合[bindingcollectionadapter](https://github.com/evant/binding-collection-adapter)
+
 结合bindingcollectionadapter不用写Adapter适配器了，详见Demo的 **ProjectFragment**
 
-##### 3.2 使用Databinging,结合[BRVAH](https://github.com/evant/binding-collection-adapter)
-[BRVAH](https://github.com/CymChad/BaseRecyclerViewAdapterHelper) 对DataBinding也做了支持，详见Demo的 **MeFragment**
+#### 使用Databinging,结合[BRVAH](https://github.com/evant/binding-collection-adapter)
+
+[BRVAH](https://github.com/CymChad/BaseRecyclerViewAdapterHelper) 对DataBinding也做了支持，详见Demo的 **
+MeFragment**
 
-### 4，关于框架
-后续会进一步完善，大家多提意见
+## 最后
 
 QQ群：(791382057)
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -46,9 +46,9 @@ android {
 }
 
 dependencies {
-    implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.jar"))))
     implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.jar"))))
     AndroidX.values.forEach { implementation(it) }
+    implementation(AndroidX.recyclerview)
     testImplementation(Depend.junit)
     androidTestImplementation(Depend.androidTestJunit)
     androidTestImplementation(Depend.espressoCore)
@@ -62,6 +62,5 @@ dependencies {
     implementation(Depend.bdclta)
     implementation(Depend.bdcltaRv)
     implementation(Depend.netCache)
-    implementation(Depend.netCache)
     Retrofit.values.forEach { implementation(it) }
 }
diff --git a/app/src/main/java/com/pcl/mvvm/ui/MainActivity.kt b/app/src/main/java/com/pcl/mvvm/ui/MainActivity.kt
@@ -2,7 +2,7 @@ package com.pcl.mvvm.ui
 
 import android.os.Bundle
 import androidx.fragment.app.Fragment
-import com.aleyn.mvvm.base.BaseActivity
+import com.aleyn.mvvm.base.BaseVMActivity
 import com.aleyn.mvvm.base.NoViewModel
 import com.blankj.utilcode.util.BarUtils
 import com.blankj.utilcode.util.ColorUtils
@@ -13,7 +13,7 @@ import com.pcl.mvvm.ui.home.HomeFragment
 import com.pcl.mvvm.ui.me.MeFragment
 import com.pcl.mvvm.ui.project.ProjectFragment
 
-class MainActivity : BaseActivity<NoViewModel, ActivityMainBinding>() {
+class MainActivity : BaseVMActivity<NoViewModel, ActivityMainBinding>() {
 
     private val fragments = ArrayList<Fragment>()