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

前言

RecyclerView已经发布很久了,高度的解耦性和灵活的定制性使得其一经发布就广受好评,但在使用过程中会发现,编写适配器的代码量貌似有点多,而且不支持添加HeaderView、FooterView等功能,甚至连Item点击监听都没有,这当然是不能忍的,所以还是有必要对其封装一下,当然现在已经有很多这样的开源框架,但自己实现一下也挺好,就当认真总结了。

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

基础功能

  • 快速实现适配器,支持多种ViewType模式
  • 支持添加HeaderView、FooterView、EmptyView
  • 支持滑到底部加载更多
  • 支持每条Item显示的动画
  • 支持嵌套Section(1.1.0版本新增)
  • 支持悬浮标签StickyLayout(1.2.0版本新增)

<br />

效果图

<br />

使用方式

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());
    }
}

<br />
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());
    }
}

<br />
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);

<br />
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内的实现方式。
<br />
5.设置Item显示动画,先直接上代码:

//使用默认的动画(Alpha动画)
mAdapter.enableItemShowingAnim(true);

//使用自定义动画
mAdapter.enableItemShowingAnim(true, ? extends RcvBaseAnimation);

注:
①默认动画的实现是类RcvAlphaInAnim
②自定义样式需要继承RcvBaseAnimation,可参考RcvAlphaInAnim内部实现。
<br />
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回调
            }
        });

<br />
7. 添加分割线,直接上代码:

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

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

注:
①是直接设置给RecyclerView的,不是设置给适配器的,不要看错哦
②支持自定义drawable当分割线
<br />
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包装。
②向外公布的方法(例如点击监听)的实体类泛型不能传错。

<br />
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);

<br />
详细使用示例请查看Demo
上面就是大部分基础功能的使用方法了,想了解更多方法请看源码。
<br />

待实现功能

  • 暂未想到
    <br />

开源参考

  1. https://github.com/hongyangAndroid/baseAdapter
  2. https://github.com/CymChad/BaseRecyclerViewAdapterHelper
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,560评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,104评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,297评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,869评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,275评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,563评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,833评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,543评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,245评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,512评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,011评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,359评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,006评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,062评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,825评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,590评论 2 273
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,501评论 2 268

推荐阅读更多精彩内容