Android RecyclerView通用適配器，支持Header、Footer、LoadMore、EmptyView等功能

前言

RecyclerView已經發布很久了，高度的解耦性和靈活的定製性使得其一經發布就廣受好評，但在使用過程中會發現，編寫適配器的代碼量貌似有點多，而且不支持添加HeaderView、FooterView等功能，甚至連Item點擊監聽都沒有，這當然是不能忍的，所以還是有必要對其封裝一下，當然現在已經有很多這樣的開源框架，但自己實現一下也挺好，就當認真總結了。

RecyclerViewAdapter

源碼地址

Github：https://github.com/Vanish136/RecyclerViewAdapter
OSChina：http://git.oschina.net/vanish136/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 TestSingleAdapter(Context context, List<TestData> datas)
    {
        super(context, android.R.layout.simple_list_item_1, datas);
    }

    @Override
    public void onBindView(RcvHolder holder, TestData itemData, int position)
    {
        //在這裏綁定UI和數據，RcvHolder中提供了部分快速設置數據的方法，詳情請看源碼
        holder.setTvText(android.R.id.text1, itemData.getContent());
    }
}

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
上面就是大部分基礎功能的使用方法了，想了解更多方法請看源碼。

待實現功能

• 暫未想到
  
  

開源參考

1. https://github.com/hongyangAndroid/baseAdapter
2. https://github.com/CymChad/BaseRecyclerViewAdapterHelper