2020 在项目中使用 MVVM 的正确打开方式,你没用过的船新版本,还不快学学
// 通过 binding 获取控件 setSupportActionBar(binding.toolbar)}}
假如你不想在项目中使用 Databinding,那么你可以像下面的类这样继承 BaseActivity,然后通过传统的 findViewById 来获取控件并使用:
class ContainerActivity : BaseActivity<EmptyViewModel> {
override fun getLayoutResId(): Int = R.layout.vmlib_activity_container
override fun doCreateView(savedInstanceState: Bundle?) {// 通过 findViewById 来获取控件// 或者,引入 kotlin-android-extensions 之后直接通过 id 使用控件}}
也许你看到了,我在使用 Databinding 的时候更多地将当作 ButterKinfe 来使用。我专门提供了不包含 Databinding 的能力,也是出于另一个考虑——使用 kotlin-android-extensions
之后,可以直接在代码中通过控件的 id 来使用它。如果只是想通过 Databinding 来获取控件的话,那么就没有必要使用 Databinding 的必要了。而对于确实喜欢 Databinding 的数据绑定功能的同学可以在 Android-VMLib 之上个性化封装一层。当然了,我并不是排斥 Databinding。Databinding 是一个很好的设计理念,只是对于将其大范围应用到项目中,我还是持观望态度的。
2.3 统一数据交互格式
有过后端开发经验的同学可能会知道,在后端代码中,我们通常会将代码按照层次分为 DAO、Service 和 Controler 层,各个层之间进行数据交互的时候就需要对数据交互格式做统一的封装。后端和前端之间的交互的时候也要对数据格式进行封装。我们将其推广到 MVVM 中,显然,ViewModel 层和 View 层之间进行交互的时候也应该进行一层数据包装。下面是我看到的一段代码,
final private SingleLiveEvent<String> toast;final private SingleLiveEvent<Boolean> loading;
public ApartmentProjectViewModel() {toast = new SingleLiveEvent<>();loading = new SingleLiveEvent<>();}
public SingleLiveEvent<String> getToast() {return toast;}
public SingleLiveEvent<Boolean> getLoading() {return loading;}
public void requestData() {loading.setValue(true);ApartmentProjectRepository.getInstance().requestDetail(projectId, new Business.ResultListener<ProjectDetailBean>() {@Override
public void onFailure(BusinessResponse businessResponse, ProjectDetailBean projectDetailBean, String s) {toast.setValue(s);loading.setValue(false);}
@Overridepublic void onSuccess(BusinessResponse businessResponse, ProjectDetailBean projectDetailBean, String s) {data.postValue(dealProjectBean(projectDetailBean));loading.setValue(false);}});}
这里为了通知 View 层数据的加载状态定义了一个 Boolean 类型的 LiveData 进行交互。这样你需要多维护一个变量,显得代码不够简洁。实际上,通过对数据交互格式的规范,我们可以更优雅地完成这个任务。
在 Android-VMLib 当中,我们通过自定义枚举来表示数据的状态,
public enum Status {// 成功 SUCCESS(0),// 失败 FAILED(1),// 加载中 LOADING(2);
public final int id;
Status(int id) {this.id = id;}}
然后,将错误信息、数据结果、数据状态以及预留字段包装成一个 Resource 对象,来作为固定的数据交互格式,
public final class Resources<T> {// 状态 public final Status status;// 数据 public final T data;// 状态,成功或者错误的 code 以及 messagepublic final String code;public final String message;// 预留字段 public final Long udf1;public final Double udf2;public final Boolean udf3;public final String udf4;public final Object udf5;
// ...}
解释下这里的预留字段的作用:它们主要用来作为数据补充说明。比如进行分页的时候,如果 View 层不仅想获取真实的数据,还想得到当前的页码,那么你可以将页码信息塞到 udf1 字段上面。以上,我对各种不同类型的基础数据类型只提供了一个通用的选择,比如整型的只提供了 Long 类型,浮点型的只提供了 Double 类型。另外,我们还提供了一个无约束的类型 udf5.
除了数据交互格式的封装,Android-VMLib 还提供了交互格式的快捷操作方法。如下图所示:
那么,使用了 Resource 之后,代码会变成什么样呢?
// View 层代码 class MainActivity : CommonActivity<MainViewModel, ActivityMainBinding>() {
override fun getLayoutResId(): Int = R.layout.activity_main
override fun doCreateView(savedInstanceState: Bundle?) {addSubscriptions()vm.startLoad()}
private fun addSubscriptions() {vm.getObservable(String::class.java).observe(this, Observer {when(it!!.status) {Status.SUCCESS -> { ToastUtils.showShort(it.data) }Status.FAILED -> { ToastUtils.showShort(it.message) }Status.LOADING -> {/* temp do nothing / }else -> {/ temp do nothing */ }}})}}
// ViewModel 层代码 class MainViewModel(application: Application) : BaseViewModel(application) {
fun startLoad() {getObservable(String::class.java).value = Resources.loading()ARouter.getInstance().navigation(MainDataService::class.java)?.loadData(object : OnGetMainDataListener{override fun onGetData() {getObservable(String::class.java).value = Resources.loading()}})}}
这样对数据交互格式封装之后,代码是不是简洁多了呢?至于让你的代码更加简洁,Android-VMLib 还为你提供了其它的方法,请继续阅读。
2.4 进一步简化代码,优化无处不在的 LiveData
之前在使用 ViewModel+LiveData 的时候,为了进行数据交互,每个变量我都需要定义一个 LiveData,于是代码变成了下面这个样子。甚至我在有的同学那里看到过一个 ViewModel 中定义了 10+ 个 LiveData. 这让代码变得非常得难看,
public class ApartmentProjectViewModel extends ViewModel {
final private MutableLiveData<ProjectDetailBean> data;final private SingleLiveEvent<String> toast;final private SingleLiveEvent<Boolean> submit;final private SingleLiveEvent<Boolean> loading;
public ApartmentProjectViewModel() {data = new MutableLiveData<>();toast = new SingleLiveEvent<>();submit = new SingleLiveEvent<>();loading = new SingleLiveEvent<>();}
// ...}
后来我的一个同事建议我考虑下如何整理一下 LiveData,于是经过不断的推广和演化,如今这个解决方案已经比较完善——即通过 HashMap 统一管理单例的 LiveData。后来为了进一步简化 ViewModel 层的代码,我将这部分工作交给了一个 Holder 来完成。于是如下解决方案就基本成型了,
public class BaseViewModel extends AndroidViewModel {
private LiveDataHolder holder = new LiveDataHolder();
// 通过要传递的数据类型获取一个 LiveData 对象 public <T> MutableLiveData<Resources<T>> getObservable(Class<T> dataType) {return holder.getLiveData(dataType, false);}}
这里的 Holder 实现如下,
public class LiveDataHolder<T> {
private Map<Class, SingleLiveEvent> map = new HashMap<>();
public MutableLiveData<Resources<T>> getLiveData(Class<T> dataType, boolean single) {SingleLiveEvent<Resources<T>> liveData = map.get(dataType);if (liveData == null) {liveData = new SingleLiveEvent<>(single);map.put(dataType, liveData);}return liveData;}}
原理很简单吧。使用了这套方案之后你的代码将会变得如下面这般简洁优雅,
// ViewModel 层 class EyepetizerViewModel(application: Application) : BaseViewModel(application) {
private var eyepetizerService: EyepetizerService = ARouter.getInstance().navigation(EyepetizerService::class.java)
private var nextPageUrl: String? = null
fun requestFirstPage() {getObservable(HomeBean::class.java).value = Resources.loading()eyepetizerService.getFirstHomePage(null, object : OnGetHomeBeansListener {override fun onError(errorCode: String, errorMsg: String) {getObservable(HomeBean::class.java).value = Resources.failed(errorCode, errorMsg)}
override fun onGetHomeBean(homeBean: HomeBean) {nextPageUrl = homeBean.nextPageUrlgetObservable(HomeBean::class.java).value = Resources.success(homeBean)// 再请求一页 requestNextPage()}})}
fun requestNextPage() {eyepetizerService.getMoreHomePage(nextPageUrl, object : OnGetHomeBeansListener {override fun onError(errorCode: String, errorMsg: String) {getObservable(HomeBean::class.java).value = Resources.failed(errorCode, errorMsg)}
override fun onGetHomeBean(homeBean: HomeBean) {nextPageUrl = homeBean.nextPageUrlgetObservable(HomeBean::class.java).value = Resources.success(homeBean)}})}}
// View 层 class EyepetizerActivity : CommonActivity<EyepetizerViewModel, ActivityEyepetizerBinding>() {
private var loading : Boolean = falseprivate lateinit var adapter: HomeAdapter
override fun getLayoutResId() = R.layout.activity_eyepetizer
override fun doCreateView(savedInstanceState: Bundle?) {addSubscriptions()vm.requestFirstPage()}
private fun addSubscriptions() {vm.getObservable(HomeBean::class.java).observe(this, Observer { resources ->loading = falsewhen (resources!!.status) {Status.SUCCESS -> {L.d(resources.data)val list = mutableListOf<Item>()resources.data.issueList.forEach {it.itemList.forEach { item ->if (item.data.cover != null&& item.data.author != null) list.add(item)}}adapter.addData(list)}Status.FAILED -> {/* temp do nothing / }Status.LOADING -> {/ temp do nothing / }else -> {/ temp do nothing */ }}})}
// ...}
这里我们通过 getObservable(HomeBean::class.java)
获取一个 ViewModel 和 View 层之间交互的 LiveData<HomeBean>
,然后通过它进行数据传递。这种处理方式的好处是,你不需要在自己代码中到处定义 LiveData,将 Holder 当作一个 LiveData 池,需要数据交互的时候直接从 Holder 中获取即可。
有的同学可能会疑问,将 Class 作为从“池”中获取 LiveData 的唯一标记,会不会应用场景有限呢?Android-VMLib 已经考虑到了这个问题,下文踩坑部分会为你讲解。
2.5 共享 ViewModel,配置可以更简单
如果多个 ViewModel 在同一 Activity 的 Fragment 之间进行共享,那么该如何获取呢?
如果是不实用 Android-VMLib,你只需要在 Fragment 中通过 Activity 获取 ViewModel 即可,
ViewModelProviders.of(getActivity()).get(vmClass)
使用了 Android-VMLib 之后这个过程可以变得更加简洁——直接在 Fragment 上声明一个注解即可。比如,
@FragmentConfiguration(shareViewModel = true)class SecondFragment : BaseFragment<SharedViewModel>() {
override fun getLayoutResId(): Int = R.layout.fragment_second
override fun doCreateView(savedInstanceState: Bundle?) {L.d(vm)// Get and display shared value from MainFragmenttv.text = vm.shareValuebtn_post.setOnClickListener {Bus.get().post(SimpleEvent("MSG#00001"))}}}
评论