MVVMSmart 基于谷歌最新 AAC 架构,MVVM 设计模式的一套快速开发库,整合 V @codeKK AndroidOpen Source Website

MVVMSmart

Introduction: 基于谷歌最新 AAC 架构,MVVM 设计模式的一套快速开发库,整合 ViewModel+Lifecycles+Navigation+DataBinding+LiveData+Okhttp+Retrofit+RxJava+Glide 等主流模块，满足日常开发需求。使用该框架可以快速开发高质量、易维护的 Android 应用。项目组会持续维护,请放心使用.欢迎 Start 并 Fork 交流.

More: Author ReportBugs

Tags:

目前，android 基于 MVVM 模式开发框架比较少。MVVMSmart-kotlin 是以谷歌 Jetpack 架构组件 ViewModel+Lifecycles+Navigation+DataBinding+LiveData+Okhttp+Retrofit+RxJava+Glide 等，加上各种原生控件自定义的 BindingAdapter，让事件与数据源完美绑定的一款容易上瘾的实用性 MVVM 快速开发框架。告别 findViewById()，告别 setText()，告别 setOnClickListener()...

技术讨 QQ 群：531944409

最新日志 v2.0：2020 年 6 月 9 日

重构优化网络框架

全局的 Loading 封装,loading 包含动画功能,rxjava 封装调用

修改开源稳定的测试网络接口

添加 TestNetFragment,方便开发者调试自己喜欢的任何接口

开发环境动态切换(dev,qa,release)+渠道管理+动态配置 BaseUrl+企业级签名配置规范.
最新日志 v2.0：2020 年 4 月 28 日

上线 kotlin 稳定版

增加 recyclerview 无数据的默认页,同时支持其他任何布局层次无数据的默认页,一行代码显示默认页

优化任何页面一行代码退出程序, AppManagerMVVM 堆栈管理(2020.04.29)
中文文档
建议大家用 clone 的方式下载开源框架,方便及时更新,建议大家使用 kotlin 项目,毕竟是 Android 的第一语言,越用约开心。

MVVMsmart 地址: https://github.com/wzqjava/MVVMSmart (包含 kotlin 分支和 java 分支)

分支名称:MVVMSmart-kotlin(切换分支,readme 会自动切换成对应语言)

分支名称:MVVMSmart-java(切换分支,readme 会自动切换成对应语言)

AndroidStudio 从 github 下载代码的正确姿势:https://juejin.im/post/5e09dd306fb9a01648718430

MVVMSmart 系列解读文章: https://juejin.im/user/574e36b179bc440062693484/posts

框架特点

快速开发 只需要写项目的业务逻辑，不用去关心网络请求、权限申请、View 的生命周期等问题，撸起袖子就是干，高效开发。
维护方便 MVVM 开发模式，低耦合，逻辑分明。Model 层负责将请求的数据交给 ViewModel；ViewModel 层负责将请求到的数据做业务逻辑处理，最后交给 View 层去展示，与 View 一一对应；View 层只负责界面绘制刷新，不处理业务逻辑，非常适合分配独立模块开发。
本项目使用流行框架 google AAC(Android Architecture Components:安卓架构组件): ViewModel:负责管理 UI 的逻辑好数据, Lifecycles:负责处理数据和 UI 生命周期的自动管理 Navigation:google 推荐的轻 Activity 方案,一个大的功能只用一个 Activity,内部导航多个 Fragment. DataBinding:负责 ViewModel 中数据和 UI 控件的自动绑定

retrofit+okhttp rxJava负责网络请求 gson负责解析 json 数据 glide负责加载图片； BaseRecyclerViewAdapterHelper负责管理 RecyclerView 的适配器 rxpermissions负责 Android 6.0 权限申请 material-dialogs一个漂亮的、流畅的、可定制的 material design 风格的对话框。

数据绑定

满足 google 目前控件支持的 databinding 双向绑定，并扩展原控件一些不支持的数据绑定。例如将图片的 url 路径绑定到 ImageView 控件中，在 BindingAdapter 方法里面则使用 Glide 加载图片；View 的 OnClick 事件在 BindingAdapter 中方法使用 RxView 防重复点击，再把事件回调到 ViewModel 层，实现 xml 与 ViewModel 之间数据和事件的绑定(框架里面部分扩展控件和回调命令使用的是@kelin 原创的)。UI 的事件儿绑定请在 UI 中处理,否则不好维护,可以在 UI 中触发,UI 中持有 viewmodel,调用 viewmodel 中的业务即可.
基类封装

专门针对 MVVM 模式打造的 BaseActivityMVVM、BaseFragmentMVVM、BaseViewModelMVVM，在 View 层中不再需要定义 ViewDataBinding 和 ViewModel，直接在 BaseActivityMVVM、BaseFragmentMVVM 上限定泛型即可使用.支持 navigation 导航 Fragment 的管理,导航返回时候回调用 OnCreateView,BaseFragmentMVVM 已经封装,标题使用 include 导入布局, Base 层预留的有 initToolbar(),标题的返回、文字设置、右侧更多等在这个方法初始化即可,普通界面只需要编写 Fragment，然后使用 navigation 导航,不用在 manifest 注册,性能也更好.
全局操作
google 的 AAC 架构，ViewModel+Lifecycles+Navigation+DataBinding+LiveData。
LoggingInterceptor 全局拦截网络请求日志，打印 Request 和 Response，格式化 json、xml 数据显示，方便与后台调试接口。
全局 Cookie，支持 SharedPreferences 和内存两种管理模式。
通用的网络请求异常监听，根据不同的状态码或异常设置相应的 message。
全局的异常捕获，程序发生异常时不会崩溃，可跳入异常界面重启应用。
全局唯一可信事件源处理，提供 LiveEventBus 回调方式。
全局任意位置一行代码实现文件下载进度监听（暂不支持多文件进度监听）。
任何布局层次无数据时候的默认页(主要用来: 列表无数据的默认页,接口 error 的默认页,无网络的默认页等,动态传入文字和图片的 id 即可)
app 崩溃重启功能(任意指定重启 Activity 即可,一般是欢迎页),debug 模式崩溃后测试人员可以直接截屏崩溃日志给开发,再也不会听到测试说"又崩啦.."
AppManagerMVVM 管理类用两个栈管理 Activity 和 Fragment,能动态获取栈顶 UI,任何页面一行代码安全退出程序.
全局的 Loading 封装,loading 包含动画功能,rxjava 封装调用
gradle 企业级:签名配置+渠道配置+BaseUrl 管理+ 打包 apk 命名区分环境管理
支持 Arouter 组件化
支持 Post 请求多参数封装成 json 提交
全局任何位置 Toast 功能,ViewModel 中有许多 toast 需求使用很方便.
全局 Tasks 任务类管理,里面封装全局 Handler,可以发送 runnable 到 UIThread 或普通 Thread,都支持延迟发送,这个工具很实用.
生产环境都有 token,封装自动请求 token 更新 token,app 长期不用 token 过期跳转登录页面(拦截器功能).
添加最小宽度适配方案, 目前全球主流适配方案.几乎适配所有手机.适配方案技术细节https://www.jianshu.com/p/1302ad5a4b04

1、准备工作

网上有很多 MVVM 入门资料，在此就不再阐述什么是 MVVM 了，不清楚的朋友可以先去了解一下。

architecture-components-samples

todo-mvvm-live

MVVMHabit

1.1、启用 databinding

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

dataBinding {
    enabled true
}

1.2、依赖 Library

从远程依赖：

在根目录的 build.gradle 中加入

allprojects {
    repositories {
        ...
        google()
        jcenter()
        maven { url 'https://jitpack.io' }
    }
}

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

下载例子程序，在主项目 app 的 build.gradle 中依赖例子程序中的mvvmsmart：

dependencies {    
    ...
    api project(':mvvmsmart')// 这样导入方便看源码,也方便根据自己项目改造
}

1.3、配置 config.gradle

下载例子程序，例子程序中的 config.gradle 放入你的主项目根目录中，然后在根目录 build.gradle 的第一行加入：

apply from: "config.gradle"

注意： config.gradle 中的

android = [] 是你的开发相关版本配置，可自行修改，比如 compileSdkVersion，buildToolsVersion，versionCode 等等。

dependencies = [] 是依赖第三方库的配置，可以加新库，用户也可以自己修改版本号,目前都是 androidx 依赖.

1.4、配置 AndroidManifest

添加权限：

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

配置 Application：

自己的 Application 继承mvvmsmart中的 BaseApplicationMVVM，或者调用

BaseApplication.setApplication(this);

来初始化你的 Application

你可以在你的自己 AppApplication 中配置

//是否开启日志打印
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、第一个 Fragment

为啥是第一 Fragment,因为目前 google IO 大会已经推荐在 Activity 中使用 navigation 来导航 Fargment。目前 sample 中用 Activity 导航了所有功能 Fragment,一个功能是一个 Fargment.同时你想继续用一个个 Activity 也是可以的,ActivityBase 层都已经处理好了. 以大家都熟悉的 Recyclerview 加载多条目为例：

三个文件MultiRecycleViewFragment.java、MultiRecycleViewModel.java、fragment_multi_rv.xml.xml

2.1.1、关联 ViewModel

fragment_multi_rv.xml 中关联 LinearLayoutManager 和 MyMultiAdapter。

<layout>
    <data>
        <variable
            name="layoutManager"
            type="androidx.recyclerview.widget.LinearLayoutManager" />
        <variable
            name="adapter"
            type="com.wzq.sample.ui.recycler_multi.MyMultiAdapter" />
    </data>
    .....

</layout>

variable - type：类的全路径
variable - name：变量名

2.1.2、继承 BaseFragmentMVVM

MultiRecycleViewFragment 继承 BaseFragmentMVVM


class MultiRecycleViewFragment : BaseFragment<FragmentMultiRvBinding, MultiRecycleViewModel>() {
    private lateinit var mAdapter: MyMultiAdapter
    override fun initContentView(inflater: LayoutInflater?, container: ViewGroup?, savedInstanceState: Bundle?): Int {
        return R.layout.fragment_multi_rv
    }

    override fun initVariableId(): Int {
        return BR.viewModel
    }

    override fun initData() {
        super.initData()
        viewModel.data
        initRecyclerView()
    }

    override fun initViewObservable() {
        super.initViewObservable()
        viewModel.itemsEntityLiveData.observe(this, Observer { itemsEntities: ArrayList<ItemsEntity>? ->                           mAdapter.setNewData(itemsEntities) })
    }
    ....

fragment_multi_rv.xml 后 databinding 会生成一个 FragmentMultiRvBinding 类。（如果没有生成，试着点击 Build->Clean Project）

BaseFragmentMVVM 是一个抽象类(专门在 Sample 中独立与框架处理,方便大家使用自己项目中的 Base,不用修改自己项目中的 base 名称,框架中的 Base 都有 MVVM 后缀), base 中有两个泛型参数，一个是 ViewDataBinding，另一个是 BaseViewModelMVVM，上面的 ActivityLoginBinding 则是继承的 ViewDataBinding 作为第一个泛型约束，MultiRecycleViewModel 继承 BaseFragmentMVVM 作为第二个泛型约束。

重写 BaseFragmentMVVM 的两个抽象方法

initContentView() 返回界面 layout 的 id
initVariableId() 返回 viewModel 变量的 id，就像一个控件的 id，可以使用 R.id.xxx，这里的 BR 跟 R 文件一样，由系统生成，使用 BR.xxx 找到这个 ViewModel 的 id。

大家可以选择性重写 initViewModel()方法，比如 LoginViewModel 中的重写.

@Override
public LoginViewModel initViewModel() {
    //View 持有 ViewModel 的引用，如果没有特殊业务处理，这个方法可以不重写
    return ViewModelProviders.of(this).get(LoginViewModel.class);
}

注意： 一般都不用重写 initViewModel()，默认会创建 MultiRecycleViewFragment 中第二个泛型约束的 MultiRecycleViewModel，如果没有指定第二个泛型，则会创建 BaseViewModelMVVM

2.1.3、继承 BaseViewModelMVVM

MultiRecycleViewModel 继承 BaseViewModelMVVM

class MultiRecycleViewModel(application: Application) : BaseViewModel(application) {
    //给 RecyclerView 添加 ObservableList
    var itemsEntityLiveData: MutableLiveData<ArrayList<ItemsEntity>> = MutableLiveData()
    fun getData() {
        val datas = ArrayList<ItemsEntity>()
        for (i in 0..49) {
            val itemBean = ItemsEntity(i, "MVVMSmart", TestUtils.getGirlImgUrl())
            if (i % 2 == 0) {
                itemBean.itemType = 0
            } else {
                itemBean.itemType = 1
            }
            datas.add(itemBean)
        }
        itemsEntityLiveData.value = datas

    }
}
    .....

BaseViewModelMVVM 与 BaseFragmentMVVM 通过 StateLiveData 来处理常用 UI 逻辑，即可在 ViewModel 中使用父类的 showDialog()、startActivity()等方法。在这个 MultiRecycleViewModel 中就可以尽情的写你的逻辑了！

BaseActivityMVVM 的使用和 BaseFragmentMVVM 几乎一样(BaseFragmentMVVM 中单独处理的配合 navigation)，详情参考 Sample。

2.2、数据绑定

拥有 databinding 框架自带的双向绑定，配合 LiveData 使用,逻辑特别清晰

2.2.1、自定义 ImageView 图片加载

绑定图片路径：

在 ViewModel 中定义

public String imgUrl = "http://img0.imgtn.bdimg.com/it/u=2183314203,562241301&fm=26&gp=0.jpg";

在 ImageView 标签中

binding:url="@{viewModel.imgUrl}"

url 是图片路径，这样绑定后，这个 ImageView 就会去显示这张图片，不限网络图片还是本地图片。

如果需要给一个默认加载中的图片，可以加这一句

binding:placeholderRes="@{R.mipmap.ic_launcher_round}"

R 文件需要在 data 标签中导入使用，如：<import type=com.wzq.mvvmsmart.R" />

BindingAdapter 中的实现

@BindingAdapter(value = {"url", "placeholderRes"}, requireAll = false)
public static void setImageUri(ImageView imageView, String url, int placeholderRes) {
    if (!TextUtils.isEmpty(url)) {
        //使用 Glide 框架加载图片
        Glide.with(imageView.getContext())
            .load(url)
            .placeholder(placeholderRes)
            .into(imageView);
    }
}

很简单就自定义了一个 ImageView 图片加载的绑定，学会这种方式，可自定义扩展。

如果你对这些感兴趣，可以下载源码，在 binding 包中可以看到各类控件的绑定实现方式

2.2.2、RecyclerView 绑定

RecyclerView 是很常用的控件，传统的方式需要针对各种业务要写各种 Adapter，如果你使用了 mvvmsmart，则可大大简化这种工作量，从此告别 setAdapter()。 mvvmsmart 中的 recyclerview 进行了三次大改动,后期又改为了 BaseRecyclerViewAdapterHelper,主要考虑到方便使用和维护,之前用 Databinding 和 ItemViewModel 都太难维护,学习成本高,与高质快速开发思想相违背,这就类似于部队的技术更重视成功,稳定,而不是一味立马上新技术. BaseRecyclerViewAdapterHelper负责管理 RecyclerView 的适配器；

在 ViewModel 中定义：

在 xml 中绑定

<androidx.recyclerview.widget.RecyclerView
            android:id="@+id/rv"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            app:adapter="@{adapter}"
            app:layoutManager="@{layoutManager}"/>

layoutManager 控制是线性(包含水平和垂直)排列还是网格排列，lineManager 是设置分割线

网格布局的写法：binding:layoutManager="@{LayoutManagers.grid(3)}
水平布局的写法：binding:layoutManager="@{LayoutManagers.linear(LinearLayoutManager.HORIZONTAL,Boolean.FALSE)}"

使用到相关类，则需要导入该类才能使用，和导入 Java 类相似

<variable name="layoutManager" type="androidx.recyclerview.widget.LinearLayoutManager" />
<variable name="adapter" type="com.wzq.sample.ui.recycler_multi.MyMultiAdapter" />
绑定后,界面自动出现 recyclerView;

更多 RecyclerView、ListView、ViewPager 等绑定方式，请参考 https://github.com/evant/binding-collection-adapter

2.3、网络请求

网络请求一直都是一个项目的核心，现在的项目基本都离不开网络，一个好用网络请求框架可以让开发事半功倍。

2.3.1、Retrofit+Okhttp+RxJava

现今，这三个组合基本是网络请求的标配，如果你对这三个框架不了解，建议先去查阅相关资料。

square 出品的框架，用起来确实非常方便。MVVMSmart中引入了

api "com.squareup.okhttp3:okhttp:3.10.0"
api "com.squareup.retrofit2:retrofit:2.4.0"
api "com.squareup.retrofit2:converter-gson:2.4.0"
api "com.squareup.retrofit2:adapter-rxjava2:2.4.0"

构建 Retrofit 时加入

 retrofit = Retrofit.Builder()
                .client(okHttpClient)
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) //  支持返回一个 Observable 泛型的接收对象:
                .baseUrl(url)
                .build()

或者直接使用例子程序中封装好的 RetrofitClient

2.3.2、网络拦截器

LoggingInterceptor： 全局拦截请求信息，格式化打印 Request、Response，可以清晰的看到与后台接口对接的数据，

LoggingInterceptor mLoggingInterceptor = new LoggingInterceptor
    .Builder()//构建者模式
    .loggable(true) //是否开启日志打印
    .setLevel(Level.BODY) //打印的等级
    .log(Platform.INFO) // 打印类型
    .request("Request") // request 的 Tag
    .response("Response")// Response 的 Tag
    .addHeader("version", BuildConfig.VERSION_NAME)//打印版本
    .build()

构建 okhttp 时加入

okHttpClient = OkHttpClient.Builder()
                .cookieJar(CookieJarImpl(PersistentCookieStore(mContext))) //                .cache(cache)
                .addInterceptor(BaseInterceptor(headers)) // 添加 header 的拦截器
                .addInterceptor(mContext?.let { CacheInterceptor(it) }) //无网络状态智能读取缓存
                .sslSocketFactory(sslParams!!.sSLSocketFactory, sslParams.trustManager) // https 的证书校验
                .addInterceptor(LoggingInterceptor.Builder() //构建者模式
                        .loggable(BuildConfig.DEBUG) //是否开启日志打印
                        .setLevel(Level.BASIC) //打印的等级
                        .log(Platform.INFO) // 打印类型
                        .request("Request") // request 的 Tag
                        .response("Response") // Response 的 Tag
                        .addHeader("log-header", "I am the log request header.") // 添加打印头, 注意 key 和 value 都不能是中文
                        .build()
                )
                .connectTimeout(DEFAULT_TIMEOUT.toLong(), TimeUnit.SECONDS)
                .writeTimeout(DEFAULT_TIMEOUT.toLong(), TimeUnit.SECONDS) // 这里你可以根据自己的机型设置同时连接的个数和时间，我这里 8 个，和每个保持时间为 15s
                .connectionPool(ConnectionPool(8, 15, TimeUnit.SECONDS))
                .build()

CacheInterceptor： 缓存拦截器，当没有网络连接的时候自动读取缓存中的数据，缓存存放时间默认为 3 天。
创建缓存对象

//缓存时间
int CACHE_TIMEOUT = 10 * 1024 * 1024
//缓存存放的文件
File httpCacheDirectory = new File(mContext.getCacheDir(), "wzq_cache");
//缓存对象
Cache cache = new Cache(httpCacheDirectory, CACHE_TIMEOUT);

构建 okhttp 时加入

OkHttpClient okHttpClient = new OkHttpClient.Builder()
    .cache(cache)
    .addInterceptor(new CacheInterceptor(mContext))
    .build();

MVVMSmart提供两种 CookieStore：PersistentCookieStore (SharedPreferences 管理)和MemoryCookieStore (内存管理)，可以根据自己的业务需求，在构建 okhttp 时加入相应的 cookieJar

  okHttpClient = OkHttpClient.Builder()
                .cookieJar(CookieJarImpl(PersistentCookieStore(mContext))) //                .cache(cache)
                .addInterceptor(BaseInterceptor(headers)) // 添加 header 的拦截器
    .build();

2.3.4、绑定生命周期

请求在 ViewModel 层。默认在 BaseActivityMVVM 和 BaseFragmentMVVM 中加入了 Lifecycle，用于感知 View 的生命周期。

RetrofitClient.getInstance().create(DemoApiService.class)
    .demoGet()
    .compose(RxUtils.bindToLifecycle(getLifecycleProvider())) // 请求与 View 周期同步
    .compose(RxUtils.schedulersTransformer())  // 线程调度
    .compose(RxUtils.exceptionTransformer())   // 网络错误的异常转换
    .subscribe(new Consumer<BaseResponse<DemoEntity>>() {
        @Override
        public void accept(BaseResponse<DemoEntity> response) throws Exception {

        }
    }, new Consumer<ResponseThrowable>() {
        @Override
        public void accept(ResponseThrowable throwable) throws Exception {

        }
    });

在请求时关键需要加入组合操作符.compose(RxUtils.bindToLifecycle(getLifecycleProvider()))
注意： 由于 BaseActivityMVVM/BaseFragmentMVVM 都实现了 LifecycleProvider 接口，并且默认注入到 ViewModel 中，所以在调用请求方法时可以直接调用 getLifecycleProvider()拿到生命周期接口。如果你没有使用 mvvmabit 里面的 BaseActivityMVVM 或 BaseFragmentMVVM，使用自己定义的 Base，那么需要让你自己的 Activity 继承 RxAppCompatActivity、Fragment 继承 RxFragment 才能用RxUtils.bindToLifecycle(lifecycle)方法。

2.3.5、网络异常处理

网络异常在网络请求中非常常见，比如请求超时、解析错误、资源不存在、服务器内部错误等，在客户端则需要做相应的处理(当然，你可以把一部分异常甩锅给网络，比如当出现 code 500 时，提示：请求超时，请检查网络连接，此时偷偷将异常信息发送至后台(手动滑稽))。

在使用 Retrofit 请求时，加入组合操作符.compose(RxUtils.exceptionTransformer())，当发生网络异常时，回调 onError(ResponseThrowable)方法，可以拿到异常的 code 和 message，做相应处理。

mvvmsmart 中自定义了一个ExceptionHandle，已为你完成了大部分网络异常的判断，也可自行根据项目的具体需求调整逻辑。

注意： 这里的网络异常 code，并非是与服务端协议约定的 code。网络异常可以分为两部分，一部分是协议异常，即出现 code = 404、500 等，属于 HttpException，另一部分为请求异常，即出现：连接超时、解析错误、证书验证失等。而与服务端约定的 code 规则，它不属于网络异常，它是属于一种业务异常。在请求中可以使用 RxJava 的 filter(过滤器)，也可以自定义 BaseSubscriber 统一处理网络请求的业务逻辑异常。由于每个公司的业务协议不一样，所以具体需要你自己来处理该类异常。

3、辅助功能

一个完整的快速开发框架，当然也少不了常用的辅助类。下面来介绍一下MVVMSmart中有哪些辅助功能。

3.1、事件总线

事件总线存在的优点想必大家都很清楚了，android 自带的广播机制对于组件间的通信而言，使用非常繁琐，通信组件彼此之间的订阅和发布的耦合也比较严重，特别是对于事件的定义，广播机制局限于序列化的类（通过 Intent 传递），不够灵活。

3.3.2、LiveEventBus

LiveEventBus 是一个轻量级全局的消息通信工具，在我们的复杂业务中，难免会出现一些交叉的业务，比如 ViewModel 与 ViewModel 之间需要有数据交换，这时候可以轻松地使用 LiveEventBusr 发送一个实体或一个空消息，将事件从一个 ViewModel 回调到另一个 ViewModel 中。

使用方法：

已经介入,文档待续

3.2、文件下载

文件下载几乎是每个 app 必备的功能，图文的下载，软件的升级等都要用到，mvvmsmart 使用 Retrofit+Okhttp+RxJava+RxBus 实现一行代码监听带进度的文件下载。

下载文件

String loadUrl = "你的文件下载路径";
String destFileDir = context.getCacheDir().getPath();  //文件存放的路径
String destFileName = System.currentTimeMillis() + ".apk";//文件存放的名称
DownLoadManager.instance?.load(url, object : ProgressCallBack<ResponseBody?>(this@MainFragment, destFileDir, destFileName) {
            override fun onStart() {
                super.onStart()
                KLog.e("下载--onStart")
            }

            override fun onSuccess(responseBody: Any?) {
                KLog.e("下载--onSuccess")

                ToastUtils.showShort("文件下载完成！")
            }

            override fun progress(progress: Long, total: Long) {
                KLog.e("下载--progress")
                progressDialog.max = total.toInt()
                progressDialog.progress = progress.toInt()
            }

            override fun onError(e: Throwable?) {
                e?.printStackTrace()
                ToastUtils.showShort("文件下载失败！")
                progressDialog.dismiss()
            }

            override fun onCompleted() {
                progressDialog.dismiss()
                KLog.e("下载--onCompleted")
            }
        })

在 ProgressResponseBody 中使用了 RxBus，发送下载进度信息到 ProgressCallBack 中，继承 ProgressCallBack 就可以监听到下载状态。回调方法全部执行在主线程，方便 UI 的更新，详情请参考例子程序。

3.3、ContainerActivity(用户可以自己封装,目前推荐 navigation)

一个盛装 Fragment 的一个容器(代理)Activity，普通界面只需要编写 Fragment，使用此 Activity 盛装，这样就不需要每个界面都在 AndroidManifest 中注册一遍

使用方法：

在 ViewModel 中调用 BaseViewModelMVVM 的方法开一个 Fragment

startContainerActivity(你的 Fragment 类名.class.getCanonicalName())

在 ViewModel 中调用 BaseViewModelMVVM 的方法，携带一个序列化实体打开一个 Fragment

Bundle mBundle = new Bundle();
mBundle.putParcelable("entity", entity);
startContainerActivity(你的 Fragment 类名.class.getCanonicalName(), mBundle);

在你的 Fragment 中取出实体

Bundle mBundle = getArguments();
if (mBundle != null) {
    entity = mBundle.getParcelable("entity");
}

3.4、6.0 权限申请

对 RxPermissions 已经熟悉的朋友可以跳过。

使用方法：

例如请求相机权限，在 ViewModel 中调用

//请求打开相机权限
RxPermissions rxPermissions = new RxPermissions((Activity) context);
rxPermissions.request(Manifest.permission.CAMERA)
    .subscribe(new Consumer<Boolean>() {
        @Override
        public void accept(Boolean aBoolean) throws Exception {
            if (aBoolean) {
                ToastUtils.showShort("权限已经打开，直接跳入相机");
            } else {
                ToastUtils.showShort("权限被拒绝");
            }
        }
    });

更多权限申请方式请参考RxPermissions 原项目地址

3.5、图片压缩

为了节约用户流量和加快图片上传的速度，某些场景将图片在本地压缩后再传给后台，所以特此提供一个图片压缩的辅助功能。

使用方法：

RxJava 的方式压缩单张图片，得到一个压缩后的图片文件对象

String filePath = "mnt/sdcard/1.png";
ImageUtils.compressWithRx(filePath, new Consumer<File>() {
    @Override
    public void accept(File file) throws Exception {
        //将文件放入 RequestBody
        ...
    }
});

RxJava 的方式压缩多张图片，按集合顺序每压缩成功一张，都将在 onNext 方法中得到一个压缩后的图片文件对象

List<String> filePaths = new ArrayList<>();
filePaths.add("mnt/sdcard/1.png");
filePaths.add("mnt/sdcard/2.png");
ImageUtils.compressWithRx(filePaths, new Subscriber() {
    @Override
    public void onCompleted() {

    }

    @Override
    public void onError(Throwable e) {

    }

    @Override
    public void onNext(File file) {

    }
});

3.6、其他辅助类

ToastUtils： 吐司工具类

MaterialDialogUtils： Material 风格对话框工具类

SPUtils： SharedPreferences 工具类

SDCardUtils： SD 卡相关工具类

ConvertUtils： 转换相关工具类

StringUtils： 字符串相关工具类

RegexUtils： 正则相关工具类

KLog： 日志打印，含 json 格式打印

4、附加

4.1、编译错误解决方法

使用 databinding 其实有个缺点，就是会遇到一些编译错误，而 AS 不能很好的定位到错误的位置，这对于刚开始使用 databinding 的开发者来说是一个比较郁闷的事。那么我在此把我自己在开发中遇到的各种编译问题的解决方法分享给大家，希望这对你会有所帮助。

4.1.1、绑定错误

绑定错误是一个很常见的错误，基本都会犯。比如 TextView 的 android:text="" ，本来要绑定的是一个 String 类型，结果你不小心，可能绑了一个 Boolean 上去，或者变量名写错了，这时候编辑器不会报红错，而是在点编译运行的时候，在 AS 的 Messages 中会出现错误提示.

解决方法：把错误提示拉到最下面 (上面的提示找不到 BR 类这个不要管它)，看最后一个错误，这里会提示是哪个 xml 出了错，并且会定位到行数，按照提示找到对应位置，即可解决该编译错误的问题。

注意： 行数要+1，意思是上面报出第 33 行错误，实际是第 34 行错误，AS 定位的不准确 (这可能是它的一个 bug)

4.1.2、xml 导包错误

在 xml 中需要导入 ViewModel 或者一些业务相关的类，假如在 xml 中导错了类，那一行则会报红，但是 res/layout 却没有错误提示，有一种场景，非常特殊，不容易找出错误位置。就是你写了一个 xml，导入了一个类，比如 XXXUtils，后来因为业务需求，把那个 XXXUtils 删了，这时候 res/layout 下不会出现任何错误，而你在编译运行的时候，才会出现错误日志。苦逼的是，不会像上面那样提示哪一个 xml 文件，哪一行出错了，最后一个错误只是一大片的报错报告

解决方法：同样找到最后一个错误提示，找到 Cannot resolve type for xxx这一句 (xxx 是类名)，然后使用全局搜索 (Ctrl+H) ，搜索哪个 xml 引用了这个类，跟踪点击进去，在 xml 就会出现一个红错，看到错误你就会明白了，这样就可解决该编译错误的问题。

4.1.3、build 错误

构建多 module 工程时，如出现【4.1.1、绑定错误】，且你能确定这个绑定是没有问题的，经过修改后出现下图错误：

解决方法：这种是 databinding 比较大的坑，清理、重构和删 build 都不起作用，网上很难找到方法。经过试验，解决办法是手动创建异常中提到的文件夹，或者拷贝上一个没有报错的版本中对应的文件夹，可以解决这个异常

4.1.4、自动生成类错误

有时候在写完 xml 时，databinding 没有自动生成对应的 Binding 类及属性。比如新建了一个 activity_login.xml，按照 databinding 的写法加入<layout> <variable>后，理论上会自动对应生成 ActivityLoginBinding.java 类和 variable 的属性，可能是 as 对 databding 的支持还不够吧，有时候偏偏就不生成，导致 BR.xxx 报红等一些莫名的错误。

解决方法：其实确保自己的写法没有问题，是可以直接运行的，报红不一定是你写的有问题，也有可能是编译器抽风了。或者使用下面的办法
第一招：Build->Clean Project；
第二招：Build->Rebuild Project；
第三招：重启大法。

混淆

例子程序中给出了最新的【MVVMSmart 混淆规则】，包含 MVVMSmart 中依赖的所有第三方 library，可以将规则直接拷贝到自己 app 的混淆规则中。在此基础上你只需要关注自己业务代码以及自己引入第三方的混淆，【MVVMSmart 混淆规则】请参考 app 目录下的proguard-rules.pro文件。

About

wzqjava： 一直开发了这么多 app,也经历了不少公司,每个公司在基础框架上功能都大同小异,但技术选型和代码质量参差不齐不好维护,对我个人和大部分中高级 Android 开发者来说如果有一套质量稳定方便维护的框架(不一定是 Android 黑科技,但稳定好维护)能节省许多时间和精力,所以我和我们网易项目组耗费许多精力多次改版才有 MVVMSmart,目前已知有 6 个公司的商用项目使用这个框架,我们项目组会一直维护 MVVMSmart，谢谢各位朋友的支持。如果觉得这套框架不错的话，麻烦点个 star，你的支持则是我们前进的动力！

QQ 群：531944409

License

Copyright 2019 (王志强)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Apps

Android Developer Tools

Android Developer Tools Pro

About Me

Tools: TimeShining

GitHub: Trinea

Facebook: Dev Tools

JSON Format, Support error correction

MD5/SHA Encode, Support batch

Text Process

CSS Format and Compress

MVVMSmart

技术讨 QQ 群：531944409

最新日志 v2.0：2020 年 6 月 9 日

最新日志 v2.0：2020 年 4 月 28 日

中文文档

框架特点

1、准备工作

1.1、启用 databinding

1.2、依赖 Library

1.3、配置 config.gradle

1.4、配置 AndroidManifest

2、快速上手

2.1、第一个 Fragment

2.1.1、关联 ViewModel

2.1.2、继承 BaseFragmentMVVM

2.1.3、继承 BaseViewModelMVVM

2.2、数据绑定

2.2.1、自定义 ImageView 图片加载

2.2.2、RecyclerView 绑定

2.3、网络请求

2.3.1、Retrofit+Okhttp+RxJava

2.3.2、网络拦截器

2.3.3、Cookie 管理

2.3.4、绑定生命周期

2.3.5、网络异常处理

3、辅助功能

3.1、事件总线

3.3.2、LiveEventBus

3.2、文件下载

3.3、ContainerActivity(用户可以自己封装,目前推荐 navigation)

3.4、6.0 权限申请

3.5、图片压缩

3.6、其他辅助类

4、附加

4.1、编译错误解决方法

4.1.1、绑定错误

4.1.2、xml 导包错误

4.1.3、build 错误

4.1.4、自动生成类错误

混淆

About

License