前言
在Android項目開發中一個界面的顯示狀態包括好幾種：內容界面，loading界面，網絡錯誤界面等等；以前開發的時候都是直接把這些界面include到main界面中，然后動態去切換界面，后來發現這樣處理不容易復用到其他項目中，而且在activity中處理這些狀態的顯示和隱藏比較亂，所以就想著能不能封裝一個類來管理這些狀態View的切換。
思路
為了讓View狀態的切換和Activity徹底分離開，必須把這些狀態View都封裝到一個管理類中，然后暴露出幾個方法來實現View之間的切換，因為在不同的項目中可以需要的View也不一樣，所以考慮把管理類設計成builder模式來自由的添加需要的狀態View。
實現
通常一個界面會包括：內容，空數據，異常錯誤，加載，網絡錯誤等5種狀態的View，所以我們就設置這5種狀態View的切換
public static final class Builder {
private Context context;
private int loadingLayoutResId;
private int contentLayoutResId;
private ViewStub netWorkErrorVs;
private int netWorkErrorRetryViewId;
private ViewStub emptyDataVs;
private int emptyDataRetryViewId;
private ViewStub errorVs;
private int errorRetryViewId;
private int retryViewId;
private OnShowHideViewListener onShowHideViewListener;
private OnRetryListener onRetryListener;
public Builder(Context context) {
this.context = context;
}
public Builder loadingView(@LayoutRes int loadingLayoutResId) {
this.loadingLayoutResId = loadingLayoutResId;
return this;
}
public Builder netWorkErrorView(@LayoutRes int newWorkErrorId) {
netWorkErrorVs = new ViewStub(context);
netWorkErrorVs.setLayoutResource(newWorkErrorId);
return this;
}
public Builder emptyDataView(@LayoutRes int noDataViewId) {
emptyDataVs = new ViewStub(context);
emptyDataVs.setLayoutResource(noDataViewId);
return this;
}
public Builder errorView(@LayoutRes int errorViewId) {
errorVs = new ViewStub(context);
errorVs.setLayoutResource(errorViewId);
return this;
}
public Builder contentView(@LayoutRes int contentLayoutResId) {
this.contentLayoutResId = contentLayoutResId;
return this;
}
public Builder netWorkErrorRetryViewId(int netWorkErrorRetryViewId) {
this.netWorkErrorRetryViewId = netWorkErrorRetryViewId;
return this;
}
public Builder emptyDataRetryViewId(int emptyDataRetryViewId) {
this.emptyDataRetryViewId = emptyDataRetryViewId;
return this;
}
public Builder errorRetryViewId(int errorRetryViewId) {
this.errorRetryViewId = errorRetryViewId;
return this;
}
public Builder retryViewId(int retryViewId) {
this.retryViewId = retryViewId;
return this;
}
public Builder onShowHideViewListener(OnShowHideViewListener onShowHideViewListener) {
this.onShowHideViewListener = onShowHideViewListener;
return this;
}
public Builder onRetryListener(OnRetryListener onRetryListener) {
this.onRetryListener = onRetryListener;
return this;
}
public StatusLayoutManager build() {
return new StatusLayoutManager(this);
}
}
狀態管理類用到了建造者模式，上面是builder內部類，總共有11個屬性，loadingLayoutResId和contentLayoutResId代表等待加載和顯示內容的xml文件；netWorkErrorVs，emptyDataVs，errorVs代表另外幾種異常狀態，那為什么這幾種狀態要用ViewStub，因為在界面狀態切換中loading和內容View都是一直需要加載顯示的，但是其他的3個只有在沒數據或者網絡異常的情況下才會加載顯示，所以用ViewStub來加載他們可以提高性能。
在錯誤的幾個界面需要重試按鈕重新加載數據，netWorkErrorRetryViewId, emptyDataRetryViewId, errorRetryViewId分別為幾個狀態界面重試按鈕的id， 如果這幾個按鈕的id是一樣的話就直接給retryViewId屬性賦值即可，retryViewId優先級最高。
onShowHideViewListener為狀態View顯示隱藏監聽事件
onRetryListener為重試加載按鈕的監聽事件
接下來需要把這些View添加到一個根View中返回給Activity，為了方便顯示隱藏這些View，我們在根View中定義一個集合屬性，然后把這些View添加到集合當中管理
/** * 存放布局集合 */
private SparseArray<View> layoutSparseArray = new SparseArray();
這個集合Key為id，Value為View，id為根View類內部自定義的id，通過id找到對應的View來顯示隱藏View，下面通過一個方法來看下它的切換邏輯
/** * 顯示空數據 */
public void showEmptyData() {
if(inflateLayout(LAYOUT_EMPTYDATA_ID))
showHideViewById(LAYOUT_EMPTYDATA_ID);
}
首先調用inflateLayout方法，方法返回true然后調用showHideViewById方法，
下面來看看inflateLayout方法的實現
private boolean inflateLayout(int id) {
boolean isShow = true;
if(layoutSparseArray.get(id) != null) return isShow;
switch (id) {
case LAYOUT_NETWORK_ERROR_ID:
if(mStatusLayoutManager.netWorkErrorVs != null) {
View view = mStatusLayoutManager.netWorkErrorVs.inflate();
retryLoad(view, mStatusLayoutManager.netWorkErrorRetryViewId);
layoutSparseArray.put(id, view);
isShow = true;
} else {
isShow = false;
}
break;
case LAYOUT_ERROR_ID:
if(mStatusLayoutManager.errorVs != null) {
View view = mStatusLayoutManager.errorVs.inflate();
retryLoad(view, mStatusLayoutManager.errorRetryViewId);
layoutSparseArray.put(id, view);
isShow = true;
} else {
isShow = false;
}
break;
case LAYOUT_EMPTYDATA_ID:
if(mStatusLayoutManager.emptyDataVs != null) {
View view = mStatusLayoutManager.emptyDataVs.inflate();
retryLoad(view, mStatusLayoutManager.emptyDataRetryViewId);
layoutSparseArray.put(id, view);
isShow = true;
} else {
isShow = false;
}
break;
}
return isShow;
}
方法里面通過id判斷來執行不同的代碼，首先判斷ViewStub是否為空，如果為空就代表沒有添加這個View就返回false，不為空就加載View并且添加到集合當中，然后調用showHideViewById方法顯示隱藏View，retryLoad方法是給重試按鈕添加事件，先來看看showHideViewById方法邏輯
private void showHideViewById(int id) {
for(int i = 0; i < layoutSparseArray.size(); i++) {
int key = layoutSparseArray.keyAt(i);
View valueView = layoutSparseArray.valueAt(i);
//顯示該view
if(key == id) {
valueView.setVisibility(View.VISIBLE);
if(mStatusLayoutManager.onShowHideViewListener != null)
mStatusLayoutManager.onShowHideViewListener.onShowView(valueView, key);
} else {
if(valueView.getVisibility() != View.GONE) {
valueView.setVisibility(View.GONE);
if(mStatusLayoutManager.onShowHideViewListener != null)
mStatusLayoutManager.onShowHideViewListener.onHideView(valueView, key);
}
}
}
}
通過id找到需要顯示的View并且顯示它，隱藏其他View，如果顯示隱藏監聽事件不為空，就分別調用它的顯示和隱藏方法，下面再來看看retryLoad方法
public void retryLoad(View view, int id) {
View retryView = view.findViewById(mStatusLayoutManager.retryViewId != 0 ? mStatusLayoutManager.retryViewId : id);
if(retryView == null || mStatusLayoutManager.onRetryListener == null) return;
retryView.setOnClickListener(new OnClickListener() {
@Override
public void onClick(View v) {
mStatusLayoutManager.onRetryListener.onRetry();
}
});
}
可以看出retryViewId 的優先級最好，如果它不為0，就用它去查找View實例，然后如果View實例和重試監聽都不為空就添加點擊事件，點擊事件里調用onRetryListener監聽的onRetry方法。
使用
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
initToolBar();
LinearLayout mainLinearLayout = (LinearLayout) findViewById(R.id.main_rl);
statusLayoutManager = StatusLayoutManager.newBuilder(this)
.contentView(R.layout.activity_content)
.emptyDataView(R.layout.activity_emptydata)
.errorView(R.layout.activity_error)
.loadingView(R.layout.activity_loading)
.netWorkErrorView(R.layout.activity_networkerror)
.retryViewId(R.id.button_try)
.onShowHideViewListener(new OnShowHideViewListener() {
@Override
public void onShowView(View view, int id) {
}
@Override
public void onHideView(View view, int id) {
}
}).onRetryListener(new OnRetryListener() {
@Override
public void onRetry() {
statusLayoutManager.showLoading();
new Thread(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
runOnUiThread(new Runnable() {
@Override
public void run() {
statusLayoutManager.showContent();
}
});
}
}).start();
}
}).build();
mainLinearLayout.addView(statusLayoutManager.getRootLayout(), 1);
statusLayoutManager.showLoading();
}
StatusLayoutManager提供了一系列的方法來顯示不同布局View之間的切換
statusLayoutManager.showLoading(); 顯示loading加載view
statusLayoutManager.showContent(); 顯示你的內容view
statusLayoutManager.showEmptyData(); 顯示空數據view
statusLayoutManager.showError(); 顯示error view
statusLayoutManager.showNetWorkError(); 顯示網絡異常view
結束語
至此，核心邏輯和代碼都已經分析完成，想看如何調用和源碼的朋友可以移步至：https://github.com/chenpengfei88/StatusLayout
我還有一篇封裝底部導航欄的文章，大家有興趣也可以看看
http://www.lxweimin.com/p/7cccb5c054da#
