大家好瑞侮,今天給大家?guī)硪粋€我自己開發(fā)改造的 MVVM 封裝框架丐枉。代碼不難,但我更想說一些我在開發(fā)這樣一個架構(gòu)過程中的想法和思路苞轿,我們不僅要善于作一個搬運工,更要自己多多造輪子逗物,我們程序員就是會折騰嘛搬卒。
先送上源碼地址:WeaponApp
多提一句,這個 App 是我和朋友最近正在努力開發(fā)的一款 app翎卓,涵蓋絕大多數(shù)使用場景和技術(shù)(RxJava+Retrofit+MVVM+插件化+組件化+全平臺分享+服務(wù)端)契邀。盡量使用最優(yōu)雅和最高級的方式來開發(fā)業(yè)務(wù)代碼。使用這套框架可以快速構(gòu)建 app失暴,并能夠進(jìn)行高效的維護(hù)坯门。
希望大家可以 star 一下,提一些建議逗扒,幫助我們更好地完善它古戴!
在講具體的實現(xiàn)和思路之前,我們需要多說一些東西矩肩,可以說是封裝的動機(jī)吧现恼,或者可以解釋為什么要用面向接口的思想來封裝。
去年的時候黍檩,MVP
在移動端比較火熱叉袍,一直持續(xù)到現(xiàn)在,MVVM
作為更為高雅和清晰的開發(fā)架構(gòu)刽酱,使用的人不是很多喳逛。不像MVP
,我在研究的時候棵里,想搜索一些封裝的資料润文,發(fā)現(xiàn)多數(shù)只能找到dataBinding
的資料姐呐,但很少有教你怎么封裝的。 「Google」爸爸的databinding
為我們提供好了輪子转唉,我們實際上按照官方的使用方式來使用MVVM
已經(jīng)是比較簡單了皮钠,只需要在 View 里構(gòu)建VM
稳捆,在VM
里維持一個Model
引用赠法,進(jìn)行相關(guān)數(shù)據(jù)的綁定即可∏呛唬可以說是非常好用了砖织。
那么,為什么要特別地再封裝一下呢末荐?
這就和我們設(shè)計架構(gòu)的目的和思路有關(guān)了侧纯。當(dāng)然了,還有作為程序員甲脏,肯定還是希望能寫出最優(yōu)雅眶熬、最簡潔、最高級的代碼块请,我們都是偏執(zhí)狂娜氏。
設(shè)計思路:測試驅(qū)動、面向接口墩新、隱蔽實現(xiàn)
首先贸弥,我們要明確一點,不論是MVP
還是MVVM
海渊,它們都不一定會讓你用更少的代碼來實現(xiàn)一個頁面绵疲,代碼量可能會更多。它們能做到的就是做到數(shù)據(jù)臣疑、邏輯盔憨、視圖關(guān)系的解耦,提升代碼的可維護(hù)性讯沈、可讀性般渡、設(shè)計性和可測性。
MVVM 中芙盘,ViewModel 層是 View 和 Model 的中轉(zhuǎn)層驯用,View 專門用來處理 UI 的操作,Model 是一些數(shù)據(jù)實體儒老,ViewModel 操作一些和數(shù)據(jù)處理相關(guān)的綁定操作蝴乔,因為 databinding 的雙向綁定
特性,最好的封裝應(yīng)該是讓 View 層只有綁定 ViewModel 和一些必要的 UI 操作驮樊,整體的邏輯和思路干凈整齊薇正,ViewModel 是一個個功能單一方法的集合片酝。
「單一原則」是我們寫代碼的時候一定要養(yǎng)成的好習(xí)慣,它不僅能幫助我們寫出更優(yōu)雅的代碼挖腰,也是代碼具有可測性雕沿、邏輯性和可維護(hù)性的要求。
MVVM 單元測試很方便猴仑,因為有了雙向綁定审轮。只需要測一下 ViewModel 的方法,方法通過了即可驗證數(shù)據(jù)和 UI 邏輯辽俗。我們寫代碼的時候疾渣,就應(yīng)該保持好設(shè)計性,盡量做到讓代碼的可測性很強(qiáng)崖飘,保持單一原則榴捡,隔離好 View 和 Model 的邏輯,讓代碼通過驗證方法而不需要真正構(gòu)造 Activity 實例就能有足夠的可測性朱浴。為了讓代碼保持可測行吊圾,要求我們代碼需要具有設(shè)計性,而代碼的設(shè)計性和單一原則又是單元測試的一個本身要求翰蠢,兩者相互影響项乒,相互驅(qū)動。
這就是測試驅(qū)動開發(fā)躏筏。
好了板丽,現(xiàn)在我們代碼寫的也設(shè)計性了,方法也夠單一了趁尼,但單元測試的時候埃碱,ViewModel 作為 View 和 Model 的橋梁,它實際上應(yīng)該持有 View 和 Model 的引用的酥泞,可是單元測試構(gòu)造 Activity 對象不方便砚殿,我們既然是要使用單元測試,就應(yīng)該盡量避免需要打開頁面這樣的操作芝囤,雖然我們有一些非常強(qiáng)大的第三方單元測試框架能夠構(gòu)造 Activity 和 Fragment 甚至可以驗證一些 UI 的操作似炎,但總而言之還是一個比較麻煩而妥協(xié)的做法,所以我根據(jù)AndroidFire
這個項目上的 MVP 封裝思路悯姊,進(jìn)行了 MVVM 的改造羡藐,實現(xiàn)了編譯期的多態(tài),通過反射構(gòu)造類型參數(shù)的具體對象悯许,在 Contact 中定義各個層級的接口仆嗦,ViewModel 進(jìn)行跨層調(diào)用的時候,只關(guān)注具體接口的形式先壕,而不關(guān)心接口的具體實現(xiàn)和到底是哪個實例實現(xiàn)了他瘩扼。
這就是面向接口了谆甜。
同時,我們隱藏了 databinding 的綁定操作集绰,集成了一些ListView
规辱,RecyclerView
,ViewPager
的 databinding 第三方使用庫栽燕,再通過自定義一些@BindAdapter
幫助更好的進(jìn)行 MVVM 開發(fā)罕袋。即使開發(fā)者之前不了解 databinding,按照我們封裝的操作流程纫谅,開發(fā)界面就像堆磚塊一樣簡單高效炫贤。
面向接口的框架在作單元測試的時候溅固,我們只需要自己構(gòu)建出一個空實現(xiàn)的接口實例付秕,即可跳過一些 View 層的 UI 操作或者 Model 層的請求操作,做到真正意義上的單元測試侍郭。
說的很抽象询吴,下一節(jié)我們來看一下具體代碼。
MVVM 封裝核心實現(xiàn)
我們先來看下封裝的一些基類設(shè)計思路亮元。因為「WeaponApp」的頁面全是用 Fragment 進(jìn)行開發(fā)的猛计,只需要一個占坑 Activity 作為容器來展示 Fragment,所以我們只針對 Fragment 進(jìn)行了基類封裝:
public abstract class BaseFragment<VM extends BaseViewModel<? extends BaseView, ? extends BaseModel>,
M extends BaseModel>
extends Fragment
implements BaseView {}
emm...這是什么爆捞。奉瘤。看著這么多泛型疊加煮甥,是不是有點頭暈盗温,別急,我們從后往前慢慢看成肘。
BaseView
是一個接口卖局,里面定義了一些必須要實現(xiàn)的方法,比如databinding 需要的BR
文件双霍,init
初始化方法等砚偶,最重要的是定義了一個基類類型孕索,表示項目中所有的 Fragment 都是這個接口類型飘千,輔助編譯期檢查。
M extends BaseModel
:定義具體的 Model 類型倚评。
VM extends BaseViewModel<? extends BaseViewModel<? extends BaseView,? extends BaseModel>>
: VM 的泛型是比較復(fù)雜的丘逸,Android 中的列表控件都是需要一個 Adapter 单鹿,為了管理這些列表 item 的 VM,并且做到統(tǒng)一處理鸣个,所以 BaseViewModel 中的兩個泛型類型都是沒有 extends 來限制范圍的羞反,那么為了區(qū)分是頁面 VM 還是 item 的 VM布朦。在 BaseFragment 中,通過通配符來限定范圍昼窗,在編譯期提醒開發(fā)者是趴。
因為使用了
binding-collection-adapter
,所以在使用像 ListView澄惊,RecyclerView 和 ViewPager 這類控件的時候唆途,是不需要通過 adapter 來進(jìn)行管理的,全部都是通過 item 的 VM掸驱,通過 MVVM 的形式來配置肛搬。
好了,看好了類的定義代碼毕贼,我們來下最關(guān)鍵的onCreateView()
方法:
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
super.onCreateView(inflater, container, savedInstanceState);
return initFragment(inflater, container);
}
繼續(xù)跟進(jìn)initFragment
方法:
private View initFragment(LayoutInflater inflater, ViewGroup container) {
if (mViewDataBinding == null) {
mContext = getActivity();
mViewDataBinding = DataBindingUtil.inflate(inflater, getLayoutId(), container, false);
//反射生成泛型類對象
mViewModel = TUtil.getT(this, 0);
M model = TUtil.getT(this, 1);
//VM 和 View 綁定
if (mViewModel != null) {
mViewModel.setContext(mContext);
try {
Method setModel = mViewModel.getClass().getMethod("setModel",Object.class);
Method attachView = mViewModel.getClass().getMethod("attachView", Object.class);
setModel.invoke(mViewModel, model);
attachView.invoke(mViewModel, this);
} catch (Exception e) {
e.printStackTrace();
}
}
//Model 和 VM 綁定
if (model != null) {
model.attachViewModel(mViewModel);
}
//DataBinding 綁定
mViewDataBinding.setVariable(getBR(), mViewModel);
initView();
}
這里有一些 databinding 的綁定操作温赔,就不多細(xì)說了,我們來看下中間的部分鬼癣。
mViewModel = TUtil.getT(this,0);
M model = TUtil.getT(this,1);
這里的 mViewModel 的類型實際上是 VM陶贼,TUtil.getT(this,0)
方法的第二個參數(shù)傳入的是類上定義的泛型位置,比如 VM 在 BaseFragment 中的位置是第一個待秃,那么就傳入 0拜秧,M 是第二個,那么就傳入 1 章郁。該方法將返回具體泛型參數(shù)類型的實例枉氮。這樣做的好處就是我們不需要手動操作構(gòu)建對象并將引用保存到成員變量上了,只需要定義好具體類型參數(shù)的泛型類型暖庄,即可通過getViewModel
獲取 ViewModel 的具體實例聊替。
繼續(xù)看代碼。model.attachViewModel
將 ViewModel 綁定到 Model雄驹,ViewModel 和 View 的綁定以及將 Model 綁定到 ViewModel 是中間一段代碼做到的:
Method setModel = mViewModel.getClass().getMethod("setModel",Object.class);
Method attachView = mViewModel.getClass().getMethod("attachView", Object.class);
setModel.invoke(mViewModel, model);
attachView.invoke(mViewModel, this);
通配符實際上是一種具體但未知類型的類型佃牛。ViewModel 的attachView
和setModel
方法的參數(shù)都是泛型參數(shù),所以這里必須通過反射來獲取具體的方法實例医舆,再通過invoke
進(jìn)行調(diào)用方法俘侠。
舉個栗子?蔬将?
OK爷速,那么我們來看看到底怎么就「傻瓜式」開發(fā)了,怎么就單元測試很好使了霞怀。比如現(xiàn)在項目中的我的界面惫东,用這個封裝框架來寫界面的時候,先寫一個接口定義類 Contact :
interface MineContact{
interface View extends BaseView{
void testType();
}
abstract class ViewModel extends BaseViewModel<View,MineModel>{
abstract void onHttpResponse();//數(shù)據(jù)請求成功回調(diào)
abstract void onHttpError();//數(shù)據(jù)請求失敗回調(diào)
}
abstract class Model extends BaseModel<ViewModel>{
abstract void loadData();//請求數(shù)據(jù)
}
}
這里定義了 MVVM 三層的類型和接口。當(dāng)你需要添加接口的時候廉沮,只需要在這里添加即可颓遏。下面是MineFragment
、MineViewModel
滞时、MineModel
的類定義:
//View
public class MineFragment extends BaseFragment<MineViewModel,MineModel> implements MineContact.View{
private ShareView mShareView;
@Override
public int getLayoutId() {
return R.layout.fragment_mine;
}
@Override
public void initView() {
}
@Override
public int getBR() {
return com.weapon.joker.app.mine.BR.model;
}
@Override
public void testType(){
}
}
//ViewModel
public class MineViewModel extends MineContact.ViewModel{
public void init(){
setTestString("反射封裝測試成功");
getView().testType();
getModel.loadData();
}
@Bindable
public String getTestString(){
return getModel().testString;
}
public void setTestString(String testString){
getModel().testString = testString;
notifyPropertyChanged(BR.testString);
}
public void onHttpResponse(){}
public void onHttpError(){}
}
//Model
public class MineModel extends MineContact.Model{
@Bindable
public String testString;
public void loadData(){
getViewModel().onHttpResponse();
getViewModel().onHttpError();
}
}
我們可以看到我們寫具體類中叁幢,所有類的集成格式是一樣的,并且我們內(nèi)部可以通過我們剛剛在 Contact 中定義的接口進(jìn)行各個層級之間的通信坪稽,在編譯期曼玩,我們并不用關(guān)心各個接口具體的實現(xiàn)是什么,具體的實現(xiàn)將被移步到運行期中窒百,這極大的方便了我們的單元測試黍判,這也是多態(tài)和里式替換原則的應(yīng)用。同時我們發(fā)現(xiàn) MVVM 的很多操作在 ViewModel 層都被隱藏了篙梢,如果你想使用 BR 文件顷帖,就自己定義相對應(yīng)的 get 方法,并不需要具體的保存一個 model 的成員變量了庭猩。下面我們來看看具體的單元測試該怎么寫:
比如我們現(xiàn)在要測試 VM 中的 init 方法窟她,其中的 View 接口 testType() 是一個吐司顯示陈症,為了通過這個方法蔼水,我們?nèi)绻麡?gòu)建一個 MineFragment 實例,無疑非常麻煩录肯,但在我們這套封裝中趴腋,我們只需要這樣寫即可:
public class Test{
@Test
public void main(){
MineContact.View view = new MineContact.View(){
@Override
public void testType() {}
@Override
public int getLayoutId() {
return 0;
}
@Override
public void initView() {}
@Override
public int getBR() {
return 0;
}
};
MineContact.Model model = new MineContact.Model(){
@Override
void loadData() {}
};
MineViewModel vm = new MineViewModel();
vm.attachView(view);
vm.setModel(model);
//調(diào)用 init() 方法
vm.init();
}
}
我們成功的在單元測試中調(diào)用了 VM 的 init 方法,也沒有構(gòu)造真正的 MineFragment论咏,只是自己定義了一個和 MineFragment 同類型的接口优炬,因為面向接口的原因,VM 仍然能對其進(jìn)行調(diào)用操作厅贪,我們依然不需要關(guān)心 testType() 方法內(nèi)部到底是不是和 MineFragment 定義的 testType() 方法是不是一樣的蠢护,因為這里都是 UI 操作,我們不需要在 MVVM 的單元測試中測試它养涮。
MVVM 的強(qiáng)大當(dāng)然不止于此葵硕,還需要讀者自己多多發(fā)掘。當(dāng)然贯吓,在學(xué)習(xí)別人的輪子的時候懈凹,一定要多多思考,舉一反三悄谐,不能一味的搬運介评。