Android RecyclerView通用介面卡，支援Header、Footer、LoadMore、EmptyView等功能
阿新 • • 發佈：2019-02-16
前言
RecyclerView已經發布很久了，高度的解耦性和靈活的定製性使得其一經發布就廣受好評，但在使用過程中會發現，編寫介面卡的程式碼量貌似有點多，而且不支援新增HeaderView、FooterView等功能，甚至連Item點選監聽都沒有，這當然是不能忍的，所以還是有必要對其封裝一下，當然現在已經有很多這樣的開源框架，但自己實現一下也挺好，就當認真總結了。
RecyclerViewAdapter
原始碼地址
如果覺得有幫助，麻煩各位大佬賜個star吧…
引用方式
compile 'com.lwkandroid:recyclerviewadapter:1.2.1' 基礎功能
- 快速實現介面卡，支援多種ViewType模式
- 支援新增HeaderView、FooterView、EmptyView
- 支援滑到底部載入更多
- 支援每條Item顯示的動畫
- 支援巢狀Section（1.1.0版本新增）
- 支援懸浮標籤StickyLayout（1.2.0版本新增）
效果圖
使用方式
1. 當Item樣式一樣時，只需繼承RcvSingleAdapter<T>即可，示例：
public class TestSingleAdapter extends RcvSingleAdapter<TestData>
{
public
2. 當Item樣式不一樣時，即存在多種ViewType型別的Item，需要將每種ViewType的Item單獨實現，再關聯到RcvMultiAdapter<T>中，示例：
//第一步：每種Item分別繼承RcvBaseItemView<T>
public class LeftItemView extends RcvBaseItemView<TestData>
{
@Override
public int getItemViewLayoutId()
{
//這裡返回該Item的佈局id
return R.layout.layout_item_left;
}
@Override
public boolean isForViewType(TestData item, int position)
{
//這裡判斷何時引用該Item
return position % 2 == 0;
}
@Override
public void onBindView(RcvHolder holder, TestData testData, int position)
{
//在這裡繫結UI和資料，RcvHolder中提供了部分快速設定資料的方法，詳情請看原始碼
holder.setTvText(R.id.tv_left, testData.getContent());
}
}
//第二步：將所有Item關聯到介面卡中
public class TestMultiAdapter extends RcvMultiAdapter<TestData>
{
public TestMultiAdapter(Context context, List<TestData> datas)
{
super(context, datas);
//只需在構造方法裡將所有Item關聯進來,無論多少種ViewType都輕輕鬆鬆搞定
addItemView(new LeftItemView());
addItemView(new RightItemView());
}
}
3.優雅的新增HeaderView、FooterView、EmptyView，只需要在RecyclerView設定LayoutManager後呼叫相關方法即可：
//要先設定LayoutManager
mRecyclerView.setLayoutManager(new LinearLayoutManager(context, LinearLayoutManager.VERTICAL, false));
//新增HeaderView(若干個)
mAdapter.addHeaderView(headerView01,headerView02,headerView03...);
//新增FooterView(若干個)
mAdapter.addFooterView(footerView01,footerView02,footerView03...);
//新增EmptyView（只能設定一個）
//設定了EmptyView後，當資料量為0的時候會顯示EmptyView
mAdapter.setEmptyView(emptyView);
或者
mAdapter.setEmptyView(layoutId);
4.設定滑動到底部自動載入更多，先上示例程式碼吧：
//最簡單的方式，使用預設的樣式
mAdapter.enableLoadMore(true, new RcvLoadMoreListener()
{
@Override
public void onLoadMoreRequest()
{
//TODO 在這裡實現載入更多
/*載入完成後可呼叫以下方法快速回調給介面卡*/
//載入失敗
mAdapter.notifyLoadMoreFail();
//載入成功，第二個引數代表是否還有更多資料，如果為false和下面的方法效果一樣
mAdapter.notifyLoadMoreSuccess(newDatas, false);
//往後沒有更多資料，不會再觸發載入更多
mAdapter.notifyLoadMoreHasNoMoreData();
}
});
//自定義樣式
mAdapter.enableLoadMore(true, ? extends RcvBaseLoadMoreView,new RcvLoadMoreListener()
{
@Override
public void onLoadMoreRequest()
{
//TODO 在這裡實現載入更多
/*載入完成後可呼叫以下方法快速回調給介面卡*/
//載入失敗
mAdapter.notifyLoadMoreFail();
//載入成功，第二個引數代表是否還有更多資料，如果為false和下面的方法效果一樣
mAdapter.notifyLoadMoreSuccess(newDatas, false);
//往後沒有更多資料，不會再觸發載入更多
mAdapter.notifyLoadMoreHasNoMoreData();
}
});注：
① 預設的樣式實現是類RcvDefLoadMoreView
② 如需自定義樣式，只需繼承RcvBaseLoadMoreView，只要重寫各狀態UI的實現，無須關心狀態切換，可參考RcvDefLoadMoreView內的實現方式。
5.設定Item顯示動畫，先直接上程式碼：
//使用預設的動畫（Alpha動畫）
mAdapter.enableItemShowingAnim(true);
//使用自定義動畫
mAdapter.enableItemShowingAnim(true, ? extends RcvBaseAnimation);注：
①預設動畫的實現是類RcvAlphaInAnim
②自定義樣式需要繼承RcvBaseAnimation，可參考RcvAlphaInAnim內部實現。
6.設定Item點選監聽：
//設定OnItemClickListener
mAdapter.setOnItemClickListener(new RcvItemViewClickListener<TestData>()
{
@Override
public void onItemViewClicked(RcvHolder holder, TestData testData, int position)
{
//onClick回撥
}
});
//設定OnItemLongClickListener
mAdapter.setOnItemLongClickListener(new RcvItemViewLongClickListener<TestData>()
{
@Override
public void onItemViewLongClicked(RcvHolder holder, TestData testData, int position)
{
//onLongClick回撥
}
});
7. 新增分割線，直接上程式碼：
//適用於LinearLayoutManager
mRecyclerView.addItemDecoration(new RcvLinearDecoration(context, LinearLayoutManager.VERTICAL));
//適用於GridLayoutManager、StaggeredGridLayoutManager
mRecyclerView.addItemDecoration(new RcvGridDecoration(context));注：
①是直接設定給RecyclerView的，不是設定給介面卡的，不要看錯哦
②支援自定義drawable當分割線
8.巢狀Section，稍微複雜一點，配合程式碼講解：
介面卡繼承自RcvSectionAdapter,指定兩個泛型，第一個代表Section，第二個代表普通資料Data，但要注意的是，在將資料傳入介面卡前需要通過一個實體類RcvSectionWrapper將兩種資料進行包裝。
public class TestSectionAdapter extends RcvSectionAdapter<TestSection,TestData>
{
//注意建構函式裡傳入的資料集合必須是RcvSectionWrapper
public TestSectionAdapter(Context context, List<RcvSectionWrapper<TestSection,TestData>> datas)
{
super(context, datas);
}
@Override
public int getSectionLayoutId()
{
//返回Section對應的佈局Id
return R.layout.layout_section_label;
}
@Override
public void onBindSectionView(RcvHolder holder, TestSection section, int position)
{
//繫結Section資料和UI的地方
holder.setTvText(R.id.tv_section_label,section.getSection());
}
@Override
public int getDataLayoutId()
{
//返回Data對應的佈局Id
return android.R.layout.simple_list_item_1;
}
@Override
public void onBindDataView(RcvHolder holder, TestData data, int position)
{
//繫結Data資料和UI的地方
holder.setTvText(android.R.id.text1, data.getContent());
}
}注：
①傳給介面卡的資料集合內實體類必須經過RcvSectionWrapper包裝。
②向外公佈的方法（例如點選監聽）的實體類泛型不能傳錯。
9.懸浮標籤StickyLayout
介面卡方面無需改動，直接使用RcvSectionAdapter即可，在RecyclerView同級佈局下新增RcvStickyLayout，然後在程式碼中關聯起來即可：
// xml佈局中新增RcvStickyLayout：
<FrameLayout
android:layout_width="match_parent"
android:layout_height="match_parent">
<android.support.v7.widget.RecyclerView
android:id="@+id/rcv_sticky"
android:layout_width="match_parent"
android:layout_height="match_parent"/>
<com.lwkandroid.rcvadapter.ui.RcvStickyLayout
android:id="@+id/stickyLayout"
android:layout_width="match_parent"
android:layout_height="wrap_content"/>
</FrameLayout>
//程式碼中關聯RecyclerView
RecyclerView recyclerView = (RecyclerView) findViewById(R.id.rcv_sticky);
/...省略設定RecyclerView的LayoutMananger和Adapter.../
RcvStickyLayout stickyLayout = (RcvStickyLayout) findViewById(R.id.stickyLayout);
stickyLayout.attachToRecyclerView(recyclerView);
詳細使用示例請檢視Demo
上面就是大部分基礎功能的使用方法了，想了解更多方法請看原始碼。
待實現功能
- 暫未想到