# MvvmLazy
**Repository Path**: JY2020/MvvmLazy
## Basic Information
- **Project Name**: MvvmLazy
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 1
- **Created**: 2021-11-10
- **Last Updated**: 2024-11-29
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# MvvmLazy Android懒人框架
目前,android流行的MVC、MVP模式的开发框架很多,然而一款基于MVVM模式开发框架却很少。
个人搜寻了市面上大量的开源框架,秉承减少重复造轮子的原则,汲取了各位大神的框架优点,集成了大量常用的开源框架和工具类,进行了部分公用模块封装,丰富了BindingAdapter自定义数据绑定,创建了这套Android懒人开发框架,已在多个商业项目中经过检验,可靠性值得信赖
**MvvmLazy是以谷歌DataBinding+LiveData+ViewModel框架为基础,整合Okhttp+RxJava+Retrofit+Glide等流行模块,加上各种原生控件自定义的BindingAdapter,让事件与数据源完美绑定的一款容易上瘾的实用性MVVM快速开发框架**。从此告别findViewById(),告别setText(),告别setOnClickListener()...
[**kotlin版本**](https://github.com/jirywell/MvvmLazy-kotlin) 建议使用kotlin版本,真的香,节省了大量代码和复杂逻辑处理
## 框架特点
- **快速开发**
只需要写项目的业务逻辑,不用再去关心网络请求、权限申请、View的生命周期等问题,撸起袖子就是干。
- **维护方便**
MVVM开发模式,低耦合,逻辑分明。Model层负责将请求的数据交给ViewModel;ViewModel层负责将请求到的数据做业务逻辑处理,最后交给View层去展示,与View一一对应;View层只负责界面绘制刷新,不处理业务逻辑,非常适合分配独立模块开发。
- **流行框架**
[retrofit](https://github.com/square/retrofit)+ [okhttp](https://github.com/square/okhttp)+ [rxJava](https://github.com/ReactiveX/RxJava)负责网络请求;
[gson](https://github.com/google/gson) 负责解析json数据;
[glide](https://github.com/bumptech/glide) 负责加载图片;
[rxlifecycle](https://github.com/trello/RxLifecycle) 负责管理view的生命周期;与网络请求共存亡;
[rxbinding](https://github.com/JakeWharton/RxBinding) 结合databinding扩展UI事件;
[rxpermissions](https://github.com/tbruyelle/RxPermissions) 负责Android 6.0权限申请;
[xpopup](https://github.com/li-xiaojun/XPopup) 多种样式Dialog框架
[LiveEventBus](https://github.com/JeremyLiao/LiveEventBus) LiveEventBus是一款Android消息总线,基于LiveData,具有生命周期感知能力,支持Sticky,支持AndroidX,支持跨进程,支持跨APP。
[BaseRecyclerViewAdapterHelper](https://github.com/CymChad/BaseRecyclerViewAdapterHelper) 大名鼎鼎的BaseRecyclerViewAdapterHelper RecyclerView适配器管理框架
[TabLayout](https://gitee.com/kissyourface/DslTabLayout) 一个功能强大的TabLayout框架
[youth.banner](https://github.com/youth5201314/banner) 一个功能强大的banner框架
[immersionbar](https://github.com/dz-android/ImmersionBar) 一个沉浸式管理框架
[TitleBar](https://github.com/getActivity/TitleBar) 公用标题栏框架
[SmartRefreshLayout](https://github.com/scwang90/SmartRefreshLayout) 下拉刷新框架
[RWidgetHelper](https://github.com/RuffianZhong/RWidgetHelper) 代替selector,各个state状态背景/边框/文字变色,不用再写大量的shape文件了
[ARouter](https://github.com/alibaba/ARouter) 阿里路由框架
- **数据绑定**
满足google目前控件支持的databinding双向绑定,并扩展原控件一些不支持的数据绑定。例如将图片的url路径绑定到ImageView控件中,在BindingAdapter方法里面则使用Glide加载图片;View的OnClick事件在BindingAdapter中方法使用RxView防重复点击,再把事件回调到ViewModel层,实现xml与ViewModel之间数据和事件的绑定(框架里面部分扩展控件和回调命令使用的是@kelin原创的)。
- **基类封装**
专门针对MVVM模式打造的BaseActivity、BaseFragment、BaseViewModel,在View层中不再需要定义ViewDataBinding和ViewModel,直接在BaseActivity、BaseFragment上限定泛型即可使用。普通界面只需要编写Fragment,然后使用ContainerActivity盛装(代理),这样就不需要每个界面都在AndroidManifest中注册一遍。
- **全局操作**
1. 全局的Activity堆栈式管理,在程序任何地方可以打开、结束指定的Activity,一键退出应用程序。
2. LoggingInterceptor全局拦截网络请求日志,打印Request和Response,格式化json、xml数据显示,方便与后台调试接口。
3. 全局Cookie,支持SharedPreferences和内存两种管理模式。
4. 通用的网络请求异常监听,根据不同的状态码或异常设置相应的message。
5. 全局的异常捕获,程序发生异常时不会崩溃,可跳入异常界面重启应用。
6. 全局事件回调,提供LiveEventBus回调方式。
7. 全局任意位置一行代码实现文件下载进度监听(暂不支持多文件进度监听)。
8. 全局点击事件防抖动处理,防止点击过快。
## 1、准备工作
> 网上的很多有关MVVM的资料,在此就不再阐述什么是MVVM了,不清楚的朋友可以先去了解一下。[todo-mvvm-live](https://github.com/googlesamples/android-architecture/tree/todo-mvvm-live)
### 1.1、启用databinding
在主工程app的build.gradle的android {}中加入:
```gradle
dataBinding {
enabled true
}
```
### 1.2、依赖Library
从远程依赖:
在根目录的build.gradle中加入
```gradle
allprojects {
repositories {
...
google()
jcenter()
maven { url 'https://jitpack.io' }
}
}
```
在主项目app的build.gradle中依赖
```gradle
dependencies {
...
api project(':mvvmlazy')
}
```
### 1.3、配置config.gradle
如果不是远程依赖,而是下载的例子程序,那么还需要将例子程序中的config.gradle放入你的主项目根目录中,然后在根目录build.gradle的第一行加入:
```gradle
apply from: "config.gradle"
```
**注意:** config.gradle中的
android = [] 是你的开发相关版本配置,可自行修改
android_x = [] 是android_x相关配置,可自行修改
dependencies = [] 是依赖第三方库的配置,可以加新库,但不要去修改原有第三方库的版本号,不然可能会编译不过
### 1.4、配置AndroidManifest
添加权限:
```xml
```
配置Application:
继承**MvvmLazy**中的BaseApplication,或者调用
```java
BaseApplication.setApplication(this);
```
来初始化你的Application
可以在你的自己AppApplication中配置
```java
//是否开启日志打印
KLog.init(true);
//配置全局异常崩溃操作
CaocConfig.Builder.create()
.backgroundMode(CaocConfig.BACKGROUND_MODE_SILENT) //背景模式,开启沉浸式
.enabled(true) //是否启动全局异常捕获
.showErrorDetails(true) //是否显示错误详细信息
.showRestartButton(true) //是否显示重启按钮
.trackActivities(true) //是否跟踪Activity
.minTimeBetweenCrashesMs(2000) //崩溃的间隔时间(毫秒)
.errorDrawable(R.mipmap.ic_launcher) //错误图标
.restartActivity(LoginActivity.class) //重新启动后的activity
//.errorActivity(YourCustomErrorActivity.class) //崩溃后的错误activity
//.eventListener(new YourCustomEventListener()) //崩溃后的错误监听
.apply();
```
## 2、快速上手
### 2.1、第一个Activity
> 以大家都熟悉的登录操作为例:三个文件**LoginActivty.java**、**LoginViewModel.java**、**activity_login.xml**
##### 2.1.1、关联ViewModel
在activity_login.xml中关联LoginViewModel。
```xml
.....
```
> variable - type:类的全路径
variable - name:变量名
##### 2.1.2、继承BaseActivity
LoginActivty
```java
public class LoginActivty extends BaseActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
}
@Override
public int initContentView() {
return R.layout.activity_login;
}
@Override
public int initVariableId() {
return BR.viewModel;
}
@Override
public void initData() {
super.initData();
}
}
```
> 保存activity_login.xml后databinding会生成一个ActivityloginBinding类。(如果没有生成,试着点击Build->Clean Project)
BaseActivity是一个抽象类,有两个泛型参数,一个是ViewDataBinding,另一个是BaseViewModel,上面的ActivityLoginBinding则是继承的ViewDataBinding作为第一个泛型约束,LoginViewModel继承BaseViewModel作为第二个泛型约束。
重写BaseActivity的二个抽象方法
initContentView() 返回界面layout的id
initVariableId() 返回变量的id,对应activity_login中name="viewModel",就像一个控件的id,可以使用R.id.xxx,这里的BR跟R文件一样,由系统生成,使用BR.xxx找到这个ViewModel的id。
##### 2.1.3、继承BaseViewModel
LoginViewModel继承BaseViewModel
```java
public class LoginViewModel extends BaseViewModel {
public MainViewModel(@NonNull Application application) {
super(application);
}
@Override
public void initData() {
super.initData();
}
}
```
BaseViewModel与BaseActivity通过LiveData来处理常用UI逻辑,即可在ViewModel中使用父类的showDialog()、startActivity()等方法。在这个MainViewModel中就可以尽情的写你的逻辑了!
> BaseFragment的使用和BaseActivity一样,详情参考Demo。
### 2.2、数据绑定
> 拥有databinding框架自带的双向绑定,也有扩展
##### 2.2.1、传统绑定
绑定用户名:
在ViewModel中定义
```java
//用户名的绑定
public MutableLiveData userName = new MutableLiveData<>("");
```
在用户名EditText标签中绑定
```xml
android:text="@={viewModel.userName}"
```
这样一来,输入框中输入了什么,userName.get()的内容就是什么,userName.set("")设置什么,输入框中就显示什么。
**注意:** @符号后面需要加=号才能达到双向绑定效果;userName需要是public的,不然viewModel无法找到它。
点击事件绑定:
在在ViewModel中定义
```java
//登录按钮的点击事件
public View.OnClickListener loginOnClick = new View.OnClickListener() {
@Override
public void onClick(View v) {
}
};
```
在登录按钮标签中绑定
```xml
android:onClick="@{viewModel.loginOnClick}"
```
这样一来,用户的点击事件直接被回调到ViewModel层了,更好的维护了业务逻辑
这就是强大的databinding框架双向绑定的特性,不用再给控件定义id,setText(),setOnClickListener()。
**但是,光有这些,完全满足不了我们复杂业务的需求啊!MvvmLazy闪亮登场:它有一套自定义的绑定规则,可以满足大部分的场景需求,请继续往下看。**
##### 2.2.2、自定义绑定
还拿点击事件说吧,不用传统的绑定方式,使用自定义的点击事件绑定。
在LoginViewModel中定义
```java
//登录按钮的点击事件
public BindingCommand loginOnClickCommand = new BindingCommand(new BindingAction() {
@Override
public void call() {
}
});
```
在activity_login中定义命名空间
```xml
xmlns:binding="http://schemas.android.com/apk/res-auto"
```
在登录按钮标签中绑定
```xml
binding:onClickCommand="@{viewModel.loginOnClickCommand}"
```
这和原本传统的绑定不是一样吗?不,这其实是有差别的。使用这种形式的绑定,在原本事件绑定的基础之上,带有防重复点击的功能,1秒内多次点击也只会执行一次操作。如果不需要防重复点击,可以加入这条属性
```xml
binding:isThrottleFirst="@{Boolean.TRUE}"
```
那这功能是在哪里做的呢?答案在下面的代码中。
```java
//防重复点击间隔(秒)
public static final int CLICK_INTERVAL = 1;
/**
* requireAll 是意思是是否需要绑定全部参数, false为否
* View的onClick事件绑定
* onClickCommand 绑定的命令,
* isThrottleFirst 是否开启防止过快点击
*/
@BindingAdapter(value = {"onClickCommand", "isThrottleFirst"}, requireAll = false)
public static void onClickCommand(View view, final BindingCommand clickCommand, final boolean isThrottleFirst) {
if (isThrottleFirst) {
RxView.clicks(view)
.subscribe(new Consumer