-
使用startup库将在Application中初始化移至到KotlinMvvmInitializer中,从而不用封装BaseApplication
plugins {
id 'org.jetbrains.kotlin.jvm' version "1.8.0" apply false
id 'org.jetbrains.kotlin.multiplatform' version '1.8.0' apply false
id 'org.jetbrains.kotlin.plugin.serialization' version '1.8.0' apply false
id 'com.google.devtools.ksp' version '1.8.21-1.0.11' apply false
}plugins {
id 'kotlinx-serialization'
id 'com.google.devtools.ksp'
}- 停用ksp增量编译
ksp.incremental=falsebuildFeatures {
viewBinding = true
}implementation "com.github.catchpig.kmvvm:mvvm:last_version"
ksp "com.github.catchpig.kmvvm:compiler:last_version"需要使用下载功能,请单独添加如下依赖
implementation "com.github.catchpig.kmvvm:download:last_version"interface IGlobalConfig {
/**
* 标题栏高度
* @return Int
*/
@DimenRes
fun getTitleHeight(): Int
/**
* 标题栏的返回按钮资源
* @return Int
*/
@DrawableRes
fun getTitleBackIcon(): Int
/**
* 标题栏背景颜色
* @return Int
*/
@ColorRes
fun getTitleBackground(): Int
/**
* 标题栏文本颜色
* @return Int
*/
@ColorRes
fun getTitleTextColor(): Int
/**
* 标题字体样式
* @return Int
*/
@TextStyle
fun getTitleTextStyle(): Int
/**
* 标题栏下方是否需要横线
* @return Boolean
*/
fun isShowTitleLine(): Boolean
/**
* 标题栏下方横线颜色
* @return Int
*/
@ColorRes
fun getTitleLineColor(): Int
/**
* loading的颜色
* @return Int
*/
@ColorRes
fun getLoadingColor(): Int
/**
* loading的背景颜色
* @return Int
*/
@ColorRes
fun getLoadingBackground(): Int
/**
* RecyclerView的空页面ViewBinding
* @param parent ViewGroup
* @return ViewBinding
*/
fun getRecyclerEmptyBanding(parent: ViewGroup): ViewBinding
/**
* 网络请求失败的显示页面
* @param layoutInflater LayoutInflater
* @param any Any BaseActivity or BaseFragment
* @return ViewBinding
*/
fun getFailedBinding(layoutInflater: LayoutInflater, any: Any): ViewBinding?
/**
* 失败页面,需要重新加载的点击事件的id
* @return Int
*/
@IdRes
fun onFailedReloadClickId(): Int
/**
* 刷新每页加载个数
* @return Int
*/
fun getPageSize(): Int
/**
* 刷新起始页的index(有些后台设置的0,有些后台设置1)
*/
fun getStartPageIndex(): Int
}- 实现IGlobalConfig 接口,并在实现类上加上注解GlobalConfig
使用示例:
@GlobalConfig
class MvvmGlobalConfig : IGlobalConfig {
override fun getTitleHeight(): Int {
return R.dimen.title_bar_height
}
override fun getTitleBackIcon(): Int {
return R.drawable.back_black
}
override fun getTitleBackground(): Int {
return R.color.colorPrimary
}
override fun getTitleTextColor(): Int {
return R.color.white
}
override fun getTitleTextStyle(): Int {
return TextStyle.BOLD
}
override fun isShowTitleLine(): Boolean {
return true
}
override fun getTitleLineColor(): Int {
return R.color.color_black
}
override fun getLoadingColor(): Int {
return R.color.color_black
}
override fun getLoadingBackground(): Int {
return R.color.white
}
override fun getRecyclerEmptyBanding(parent: ViewGroup): ViewBinding {
return LayoutEmptyBinding.inflate(LayoutInflater.from(parent.context), parent, false)
}
override fun getFailedBinding(layoutInflater: LayoutInflater, any: Any): ViewBinding? {
return when (any) {
is BaseActivity<*> -> {
LayoutActivityErrorBinding.inflate(layoutInflater)
}
is BaseFragment<*> -> {
LayoutFragmentErrorBinding.inflate(layoutInflater)
}
else -> {
null
}
}
}
override fun onFailedReloadClickId(): Int {
return R.id.failed_reload
}
override fun getPageSize(): Int {
return 16
}
override fun getStartPageIndex(): Int {
return 1
}
}- 使用MVVM的继承BaseVMActivity
- 不使用MVVM的继承BaseActivity
使用示例
Title其他注解参数,请看下方注解详情
//设置标题的文字
@Title(R.string.child_title)
class ChildActivity : BaseVMActivity<ActivityChildBinding, ChildViewModel>() 如果标题栏文字要根据接口显示不同的文字,也有接口设置
class ChildActivity : BaseVMActivity<ActivityChildBinding, ChildViewModel>() {
@OnClickFirstDrawable(R.drawable.more)
fun clickFirstDrawable(v: View) {
updateTitle("更改标题")
}
}使用示例
StatusBar其他注解参数,请看下方注解详情
//弃用注解
@StatusBar(hide = true)
class FullScreenActivity : BaseActivity<ActivityFullScreenBinding>()使用示例
注解修饰的方法只能可以带View参数,也可以不带View参数,看自身的需求
@Title(R.string.child_title)
class ChildActivity : BaseVMActivity<ActivityChildBinding, ChildViewModel>() {
@OnClickFirstDrawable(R.drawable.more)
fun clickFirstDrawable(v: View) {
SnackbarManager.show(bodyBinding.root, "第一个图标按钮点击生效")
updateTitle("nihao")
}
@OnClickFirstText(R.string.more)
fun clickFirstText() {
SnackbarManager.show(bodyBinding.root, "第一个文字按钮点击生效")
updateTitle("12354")
}
@OnClickSecondDrawable(R.drawable.more)
fun clickSecondDrawable(v: View) {
SnackbarManager.show(bodyBinding.root, "第二个图标按钮点击生效")
updateTitle("nihao")
}
@OnClickSecondText(R.string.more)
fun clickSecondText() {
SnackbarManager.show(bodyBinding.root, "第二个文字按钮点击生效")
updateTitle("12354")
}
}- Android 11 之后,Toast已经不支持自定义Toast,原生的Toast是很难看的
- 本框架使用SnackBar做提示框
使用示例
@OnClickSecondDrawable(R.drawable.more)
fun clickSecondDrawable(v: View) {
snackBar("第二个图标按钮点击生效")
}
- 网络请求失败可展示失败页面,并有刷新按钮可以重新加载数据
- 在lifecycleLoadingView扩展函数中将showFailedView设置为true,数据请求失败了,就会显示失败页面
- 在onFailedReload的闭包中再次调用网络请求的接口,就可以重新再加载数据了
/**
* 加载失败后展示失败页面,点击自定义失败页面的刷新按钮,重新请求数据
* @param autoFirstLoad Boolean 第一次是否自动加载
* @param block [@kotlin.ExtensionFunctionType] Function1<View, Unit>
*/
fun onFailedReload(autoFirstLoad: Boolean = true, block: View.() -> Unit){
.....
}override fun initFlow() {
onFailedReload {
loadingViewError(bodyBinding.root)
}
}
fun loadingViewError(v: View) {
viewModel.loadingViewError().lifecycleLoadingView(this, showFailedView = true) {
snackBar(this)
}
}- 使用MVVM的继承BaseVMFragment
- 不使用MVVM的继承BaseFragment
- Android 11 之后,Toast已经不支持自定义Toast,原生的Toast是很难看的
- 本框架使用SnackBar做提示框
使用示例
snackbar.setOnClickListener {
snackBar("提示框")
}- 网络请求失败可展示失败页面,并有刷新按钮可以重新加载数据
- 在lifecycleLoadingView扩展函数中将showFailedView设置为true,数据请求失败了,就会显示失败页面
- 在onFailedReload的闭包中再次调用网络请求的接口,就可以重新再加载数据了
/**
* 加载失败后展示失败页面,点击自定义失败页面的刷新按钮,重新请求数据
* @param autoFirstLoad Boolean 第一次是否自动加载
* @param block [@kotlin.ExtensionFunctionType] Function1<View, Unit>
*/
fun onFailedReload(autoFirstLoad: Boolean = true, block: View.() -> Unit){
.....
}override fun initFlow() {
onFailedReload {
loadBanners()
}
}
private fun loadBanners(){
viewModel.queryBanners().lifecycleLoadingDialog(this, true) {
val images = mutableListOf<String>()
this.forEach {
images.add(it.imagePath)
}
bodyBinding.banner.run {
setImages(images)
start()
}
}
}
- Adapter可以继承RecycleAdapter来使用,RecycleAdapter使用了ViewBanding,只需要实现以下两个个方法
- RecyclerAdapter可以调用setShowEmptyEnabled()方法来设置全局的空页面是否可用
使用示例
class UserAdapter(iPageControl: IPageControl) :
RecyclerAdapter<User, ItemUserBinding>(iPageControl) {
override fun viewBinding(parent: ViewGroup): ItemUserBinding {
return ItemUserBinding.inflate(LayoutInflater.from(parent.context), parent, false)
}
override fun bindViewHolder(holder: CommonViewHolder<ItemUserBinding>, m: User, position: Int) {
holder.viewBanding {
name.text = m.name
}
}
}5.刷新分页控件(RefreshRecyclerView)
- RefreshRecyclerView集成了RefreshLayoutWrapper+RecyclerView
- 不用关心分页的逻辑,分页的刷新逻辑实现都在RefreshLayoutWrapper
- 只需要设置LayoutManager和RecyclerAdapter,提供了setLayoutManager和setAdapter方法
- 在获取到数据的时候调用updateData方法
- 获取数据失败的时候调用updateError方法
- 如果使用了lifecycleRefresh方法,updateData方法和updateError方法都不用关心
- 提供自定义属性recycler_background(设置RecyclerView的背景色)
<declare-styleable name="RefreshRecyclerView">
<attr name="recycler_background" format="color" />
</declare-styleable>
使用示例
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto" android:layout_width="match_parent"
android:layout_height="match_parent" android:orientation="vertical">
<TextView android:layout_width="match_parent" android:layout_height="50dp"
android:background="@color/colorPrimary" android:gravity="center" android:text="文章"
android:textColor="@color/color_white"/>
<com.catchpig.mvvm.widget.refresh.RefreshRecyclerView android:id="@+id/refresh"
android:layout_width="match_parent"
android:layout_height="match_parent"
app:recycler_background="#445467">
</com.catchpig.mvvm.widget.refresh.RefreshRecyclerView>
</LinearLayout>bodyBinding.refresh.run {
setOnRefreshLoadMoreListener { nextPageIndex ->
viewModel.queryArticles(nextPageIndex).lifecycleRefresh(this@ArticleFragment,this)
}
}6.1只需要是接口类上加上注解ServiceApi,并使用NetManager.getService()获取对应的接口类
-
如果rxJava为true,必须要引入RxJava的依赖包和adapter-rxjava3依赖包
implementation("com.squareup.retrofit2:adapter-rxjava3:$retrofit2_version") //rxjava3 implementation "io.reactivex.rxjava3:rxjava:$rxjava_version" implementation "io.reactivex.rxjava3:rxandroid:$rxandroid_version"
使用示例
@ServiceApi(
baseUrl = "https://www.wanandroid.com/",
responseConverter = ResponseBodyConverter::class,
interceptors = [RequestInterceptor::class],
debugInterceptors = [OkHttpProfilerInterceptor::class],
rxJava = true
)
interface WanAndroidService {
@GET("banner/json")
suspend fun banner(): List<Banner>
}object WanAndroidRepository {
private val wanAndroidService = NetManager.getService(WanAndroidService::class.java)
fun getBanners(): Flow<MutableList<Banner>> {
//这里如果用flowOf的话,方法上面必须加上suspend关键字
return flow {
emit(wanAndroidService.queryBanner())
}
}
}class IndexViewModel : BaseViewModel() {
fun queryBanners(): Flow<MutableList<Banner>> {
return WanAndroidRepository.getBanners()
}
}//Activity或者Fragment
viewModel.queryBanners().lifecycle(this) {
val images = mutableListOf<String>()
this.forEach {
images.add(it.imagePath)
}
bodyBinding.banner.run {
setImages(images)
start()
}
}{
code: "SUCCESS",
errorMsg: "成功",
data: ...
}6.2.2 在code返回SUCEESSD的时候, 我们在Retrofit的Api接口里面只想拿到data的数据做返回,我们想在Converter里面处理掉code返回错误码的逻辑,就可以继承BaseResponseBodyConverter,内部已经实现了将response转化为data的逻辑
代码示例
class ResponseBodyConverter :
BaseResponseBodyConverter() {
override fun getResultClass(): KClass<out BaseResponseData<JsonElement>> {
return Result::class
}
override fun handlerErrorCode(errorCode: String, msg: String): Exception {
return NullPointerException()
}
}6.2.4 如果想直接拿response的结果作为网络请求的返回值,可以直接将SerializationResponseBodyConverter加到ServiceApi注解的responseConverter属性上
- 刷新+RecycleView的网络请求封装
- lifecycleRefresh( base: BaseView, refreshLayoutWrapper: RefreshRecyclerView )
- 不带loading的网络请求封装
- lifecycle( base: BaseView, showFailedView: Boolean = false, errorCallback: ((t: Throwable) -> Unit)? = null, callback: T.() -> Unit )
- lifecycle( baseViewModel: BaseViewModel, showFailedView: Boolean = false, errorCallback: ((t: Throwable) -> Unit)? = null, callback: T.() -> Unit )
- 带loadingView的网络请求封装
- lifecycleLoadingDialog( base: BaseView, showFailedView: Boolean = false, errorCallback: ((t: Throwable) -> Unit)? = null, callback: T.() -> Unit )
- lifecycleLoadingDialog( baseViewModel: BaseViewModel, showFailedView: Boolean = false, errorCallback: ((t: Throwable) -> Unit)? = null, callback: T.() -> Unit )
- 带loadingDialog的网络请求封装
- lifecycleLoadingView( base: BaseView, showFailedView: Boolean = false, errorCallback: ((t: Throwable) -> Unit)? = null, callback: T.() -> Unit )
- lifecycleLoadingView( baseViewModel: BaseViewModel, showFailedView: Boolean = false, errorCallback: ((t: Throwable) -> Unit)? = null, callback: T.() -> Unit )
- 不需要在Application中初始化,因为LogUtils已经在KotlinMvvmInitializer中初始化了
- 可以使用LogUtils.getInstance().i,LogUtils.getInstance().d等打印日志(不建议)
- 也可以使用LogExt的扩展方法打印日志(建议)
8. 注解使用
9. 文件下载器
10. 工具库
-keep class com.catchpig.annotation.enums.**
-keep class com.google.android.material.snackbar.Snackbar {*;}
-keep @com.catchpig.annotation.ServiceApi class * {*;}
-keep public class **.databinding.*Binding {*;}
-keep class **.*_Compiler {*;}
#序列化混淆
-if @kotlinx.serialization.Serializable class **
-keepclassmembers class <1> {
static <1>$Companion Companion;
}
# Keep `serializer()` on companion objects (both default and named) of serializable classes.
-if @kotlinx.serialization.Serializable class ** {
static **$* *;
}
-keepclassmembers class <1>$<3> {
kotlinx.serialization.KSerializer serializer(...);
}
# Keep `INSTANCE.serializer()` of serializable objects.
-if @kotlinx.serialization.Serializable class ** {
public static ** INSTANCE;
}
-keepclassmembers class <1> {
public static <1> INSTANCE;
kotlinx.serialization.KSerializer serializer(...);
}
# @Serializable and @Polymorphic are used at runtime for polymorphic serialization.
-keepattributes RuntimeVisibleAnnotations,AnnotationDefaultSmartRefreshLayout-刷新控件
Immersionbar-状态栏
kotlinpoet - kt代码生成工具
AndroidUtilKTX - 工具类
LoadingView - Loading动画
coroutines - 协程
serialization-序列化
