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后调用相关方法即可：

//要先设置LayoutManagermRecyclerView.setLayoutManager(new LinearLayoutManager(context, LinearLayoutManager.VERTICAL, false));//添加HeaderView(若干个)mAdapter.addHeaderView(headerView01,headerView02,headerView03...);//添加FooterView(若干个)mAdapter.addFooterView(footerView01,footerView02,footerView03...);//添加EmptyView（只能设置一个）//设置了EmptyView后，当数据量为0的时候会显示EmptyViewmAdapter.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点击监听：

//设置OnItemClickListenermAdapter.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. 添加分割线，直接上代码：

//适用于LinearLayoutManagermRecyclerView.addItemDecoration(new RcvLinearDecoration(context, LinearLayoutManager.VERTICAL));//适用于GridLayoutManager、StaggeredGridLayoutManagermRecyclerView.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