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

前言

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

<br />

RecyclerViewAdapter

源碼地址

Github：https://github.com/Vanish136/RecyclerViewAdapter
OSChina：http://git.oschina.net/vanish136/RecyclerViewAdapter

如果覺得有幫助，麻煩各位大佬賜個star吧...

<br />

引用方式

compile 'com.lwkandroid:recyclerviewadapter:1.2.1'

<br />

基礎(chǔ)功能

  • 快速實現(xiàn)適配器，支持多種ViewType模式
  • 支持添加HeaderView、FooterView、EmptyView
  • 支持滑到底部加載更多
  • 支持每條Item顯示的動畫
  • 支持嵌套Section（1.1.0版本新增）
  • 支持懸浮標(biāo)簽StickyLayout（1.2.0版本新增）

<br />

效果圖

<br />

使用方式

1. 當(dāng)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和數(shù)據(jù)，RcvHolder中提供了部分快速設(shè)置數(shù)據(jù)的方法，詳情請看源碼
        holder.setTvText(android.R.id.text1, itemData.getContent());
    }
}

<br />
2. 當(dāng)Item樣式不一樣時，即存在多種ViewType類型的Item，需要將每種ViewType的Item單獨實現(xiàn)，再關(guān)聯(lián)到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和數(shù)據(jù)，RcvHolder中提供了部分快速設(shè)置數(shù)據(jù)的方法，詳情請看源碼
        holder.setTvText(R.id.tv_left, testData.getContent());
    }
}

//第二步：將所有Item關(guān)聯(lián)到適配器中
public class TestMultiAdapter extends RcvMultiAdapter<TestData>
{
    public TestMultiAdapter(Context context, List<TestData> datas)
    {
        super(context, datas);
        //只需在構(gòu)造方法里將所有Item關(guān)聯(lián)進(jìn)來,無論多少種ViewType都輕輕松松搞定
        addItemView(new LeftItemView());
        addItemView(new RightItemView());
    }
}

<br />
3.優(yōu)雅的添加HeaderView、FooterView、EmptyView，只需要在RecyclerView設(shè)置LayoutManager后調(diào)用相關(guān)方法即可：

//要先設(shè)置LayoutManager
mRecyclerView.setLayoutManager(new LinearLayoutManager(context, LinearLayoutManager.VERTICAL, false));

//添加HeaderView(若干個)
mAdapter.addHeaderView(headerView01,headerView02,headerView03...);

//添加FooterView(若干個)
mAdapter.addFooterView(footerView01,footerView02,footerView03...);

//添加EmptyView（只能設(shè)置一個）
//設(shè)置了EmptyView后，當(dāng)數(shù)據(jù)量為0的時候會顯示EmptyView
mAdapter.setEmptyView(emptyView);
或者
mAdapter.setEmptyView(layoutId);

<br />
4.設(shè)置滑動到底部自動加載更多，先上示例代碼吧：

//最簡單的方式，使用默認(rèn)的樣式
mAdapter.enableLoadMore(true, new RcvLoadMoreListener()
{
    @Override
    public void onLoadMoreRequest()
    {
        //TODO 在這里實現(xiàn)加載更多
        
        /*加載完成后可調(diào)用以下方法快速回調(diào)給適配器*/
        //加載失敗
        mAdapter.notifyLoadMoreFail();
        //加載成功，第二個參數(shù)代表是否還有更多數(shù)據(jù)，如果為false和下面的方法效果一樣
        mAdapter.notifyLoadMoreSuccess(newDatas, false);
        //往后沒有更多數(shù)據(jù)，不會再觸發(fā)加載更多
        mAdapter.notifyLoadMoreHasNoMoreData();
    }
});

//自定義樣式
mAdapter.enableLoadMore(true, ? extends RcvBaseLoadMoreView,new RcvLoadMoreListener()
{
    @Override
    public void onLoadMoreRequest()
    {
        //TODO 在這里實現(xiàn)加載更多
        
        /*加載完成后可調(diào)用以下方法快速回調(diào)給適配器*/
        //加載失敗
        mAdapter.notifyLoadMoreFail();
        //加載成功，第二個參數(shù)代表是否還有更多數(shù)據(jù)，如果為false和下面的方法效果一樣
        mAdapter.notifyLoadMoreSuccess(newDatas, false);
        //往后沒有更多數(shù)據(jù)，不會再觸發(fā)加載更多
        mAdapter.notifyLoadMoreHasNoMoreData();
    }
});

注：
① 默認(rèn)的樣式實現(xiàn)是類RcvDefLoadMoreView
② 如需自定義樣式，只需繼承RcvBaseLoadMoreView，只要重寫各狀態(tài)UI的實現(xiàn)，無須關(guān)心狀態(tài)切換，可參考RcvDefLoadMoreView內(nèi)的實現(xiàn)方式。
<br />
5.設(shè)置Item顯示動畫，先直接上代碼：

//使用默認(rèn)的動畫（Alpha動畫）
mAdapter.enableItemShowingAnim(true);

//使用自定義動畫
mAdapter.enableItemShowingAnim(true, ? extends RcvBaseAnimation);

注：
①默認(rèn)動畫的實現(xiàn)是類RcvAlphaInAnim
②自定義樣式需要繼承RcvBaseAnimation，可參考RcvAlphaInAnim內(nèi)部實現(xiàn)。
<br />
6.設(shè)置Item點擊監(jiān)聽：

//設(shè)置OnItemClickListener
mAdapter.setOnItemClickListener(new RcvItemViewClickListener<TestData>()
        {
            @Override
            public void onItemViewClicked(RcvHolder holder, TestData testData, int position)
            {
                //onClick回調(diào)
            }
        });
        
//設(shè)置OnItemLongClickListener        
mAdapter.setOnItemLongClickListener(new RcvItemViewLongClickListener<TestData>()
        {
            @Override
            public void onItemViewLongClicked(RcvHolder holder, TestData testData, int position)
            {
                //onLongClick回調(diào)
            }
        });

<br />
7. 添加分割線，直接上代碼：

//適用于LinearLayoutManager
mRecyclerView.addItemDecoration(new RcvLinearDecoration(context, LinearLayoutManager.VERTICAL));

//適用于GridLayoutManager、StaggeredGridLayoutManager
mRecyclerView.addItemDecoration(new RcvGridDecoration(context));

注：
①是直接設(shè)置給RecyclerView的，不是設(shè)置給適配器的，不要看錯哦
②支持自定義drawable當(dāng)分割線
<br />
8.嵌套Section，稍微復(fù)雜一點，配合代碼講解：

適配器繼承自RcvSectionAdapter,指定兩個泛型，第一個代表Section，第二個代表普通數(shù)據(jù)Data，但要注意的是，在將數(shù)據(jù)傳入適配器前需要通過一個實體類RcvSectionWrapper將兩種數(shù)據(jù)進(jìn)行包裝。

public class TestSectionAdapter extends RcvSectionAdapter<TestSection,TestData>
{
    //注意構(gòu)造函數(shù)里傳入的數(shù)據(jù)集合必須是RcvSectionWrapper
    public TestSectionAdapter(Context context, List<RcvSectionWrapper<TestSection,TestData>> datas)
    {
        super(context, datas);
    }

    @Override
    public int getSectionLayoutId()
    {
        //返回Section對應(yīng)的布局Id
        return R.layout.layout_section_label;
    }

    @Override
    public void onBindSectionView(RcvHolder holder, TestSection section, int position)
    {
        //綁定Section數(shù)據(jù)和UI的地方
        holder.setTvText(R.id.tv_section_label,section.getSection());
    }

    @Override
    public int getDataLayoutId()
    {
        //返回Data對應(yīng)的布局Id
        return android.R.layout.simple_list_item_1;
    }

    @Override
    public void onBindDataView(RcvHolder holder, TestData data, int position)
    {
        //綁定Data數(shù)據(jù)和UI的地方
        holder.setTvText(android.R.id.text1, data.getContent());
    }
}

注：
①傳給適配器的數(shù)據(jù)集合內(nèi)實體類必須經(jīng)過RcvSectionWrapper包裝。
②向外公布的方法（例如點擊監(jiān)聽）的實體類泛型不能傳錯。

<br />
9.懸浮標(biāo)簽StickyLayout

適配器方面無需改動，直接使用RcvSectionAdapter即可，在RecyclerView同級布局下添加RcvStickyLayout，然后在代碼中關(guān)聯(lián)起來即可：

    // 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>



    //代碼中關(guān)聯(lián)RecyclerView
    RecyclerView recyclerView = (RecyclerView) findViewById(R.id.rcv_sticky);
    /...省略設(shè)置RecyclerView的LayoutMananger和Adapter.../
    RcvStickyLayout stickyLayout = (RcvStickyLayout) findViewById(R.id.stickyLayout);
    stickyLayout.attachToRecyclerView(recyclerView);

<br />
詳細(xì)使用示例請查看Demo
上面就是大部分基礎(chǔ)功能的使用方法了，想了解更多方法請看源碼。
<br />

待實現(xiàn)功能

  • 暫未想到
    <br />

開源參考

  1. https://github.com/hongyangAndroid/baseAdapter
  2. https://github.com/CymChad/BaseRecyclerViewAdapterHelper
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容