×

通用RecylerAdapter,内置XRecyclerView,兼容上下拉与动画,高复用,一个Adapter通用所有页面,支持空页面,懒人专属

96
恋猫月亮 595a1b60 08f6 4beb 998f 2bf55e230555
2016.11.25 16:25* 字数 1566
Hello大家好,郭老司机又来了。以前都是看文章的小喵同志,如今终于体也会到码字的不易,作为一个沉默寡言的程序猿,对于码文无数的前辈深表敬佩((/- -)/。

这是欢迎各位践踏的Github:https://github.com/CarGuo

我叫DEMO:https://github.com/CarGuo/LazyRecyclerAdapter

RecylerView相信大家都听过(你确定要说没听过 = =),在ListView横行的年代里,RecyclerView携带了褒贬不一的评价,开始进入了我们的视线,那时候刚好开始了新的项目,正好就拿它练手了。下方进入介绍使用流程,建议对着Demo撸起来。( ・᷄-・᷅ )

一个列表多种类型的item

正常情况下,对于每一个不同的列表,我们经常需要实现不同的Adapter ,来处理对应的逻辑,这样导致了我们有着许多重复的代码,在优化代码()这种动力的驱动下,个人实现了一个通用的Adapter。后面所说的Holder,可以理解为列表中一个Item,属于它的逻辑处理类,每一种类型的Item有一种Holder

只需要一个Adapter,你就可以实现各种类型的列表,在一个列表里兼容不同类型的Item,你需要做的,仅仅是维护你的Holder(类似List里的一个Item)和Model,无需再关心其他,实现高复用与多样式逻辑,外带支持自定义动画,多种上下拉实现方式,不需要再写任何Adapter代码(o)/。

1、 CommonRecyclerManager :绑定layoutId和你的Holder类名。
 这个管理类是用于绑定Holder和R.layout.xxx,这样在后面CommonRecyclerAdapter 用它通过数据ModellayoutId,找到对应的Holder并创建它。

//将布局的ID和holder类型关联
commonRecyclerManager.addType(TextHolder.ID, TextHolder.class.getName());

2、 RecyclerBaseHolder :继承这个Holder,实现你的需求。
 RecyclerBaseHolder的所有Holder的基类,他继承了RecyclerView.ViewHolder,并定义写两个方法,所以你继承它就对了,在createView的时候找到控件,在onBind读取数据填充画面。这里就是实现你梦想的地方!

//实现的hodler继承RecyclerBaseHolder,重载下面方式实现你的需求
public class TextHolder extends RecyclerBaseHolder {
    //布局id,一般我习惯吧这个Holder需要处理的id都写在这里,方便管理
    public final static int ID = R.layout.text_item;
    @BindView(R.id.item_text)
    TextView itemText;
    
    public TextHolder(Context context, View v) {
        super(context, v);
    }    

    //view创建好了
    @Override 
    public void createView(View v) {
        ButterKnife.bind(this, v);
    }

    //view创建好了,更具数据处理逻辑
    @Override
    public void onBind(RecyclerBaseModel model, int position) {
        //转化为你的model
        TextModel textModel = (TextModel) (model);
        itemText.setText(textModel.getText());
    }

    //不需要可以不写
    @Override
    public AnimatorSet getAnimator(View view) {
        //实现你的动画
        return null;
    }
}

3、 CommonRecyclerAdapter :通用的适配器
 只需要传入数据ListCommonRecyclerManager,就会根据Model的顺序,通过数据的layoutId,在RecyclerView中自动生成对应的Holder,其他的功能只需要简单的配置即可。

//用数据和manager创建
adapteradapter = new CommonRecyclerAdapter(getActivity(), commonRecyclerManager, datas);

//支持需要加载更多
adapter.setNeedLoadMore(true);

//支持空数据显示 空页面
adapter.setShowNoData(true);

//设置item显示动画支持打开
adapter.setNeedAnimation(true);

4、RecyclerBaseModel :数据model的积累,必须继承它,不离不弃。
 继承它的作用是,因为整个Adapter都是以它为基类,你需要继承他,最终的是,你需要这个Model对应的布局Id,这样它才能找到属于自己的Holder。

//继承RecyclerBaseModel实现你需要的数据类型
public class TextModel extends RecyclerBaseModel {
    private String text = "";

    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }
}
总结起来就是

1、实现你的Holder并继承RecyclerBaseHolder,这里是你实现需求的地方,相当于Item的逻辑。

2、让你的数据model继承RecyclerBaseModel,设置Model的LayoutId(很重要),这样model就会通过CommonRecyclerManager,找到LayoutId对应关联的Holder,并生成它。

3、你需要一个CommonRecyclerManager来绑定你的LayoutId和处理这布局的Holder类名。

4、通过CommonRecyclerManager和Model的数据列表生成CommonRecyclerAdapter。

5、把Adapter交给Recycler。

逻辑看起来是不是有些复杂?其实就是model的LayoutId,CommonRecyclerManager通过关联了处理它的Holder。这样我们只需要在数据List里,根据数据设置不同的LayoutId的model,Adapter就会自动匹配对应的Holder。

效果GIF

如此一来,<( ̄︶ ̄)>你只需要实现好Holder和组装好Model,任何列表都可以使用起来,不需要再写Adapter逻辑了。根据model的顺序,Adapter自动生成对应的Holder,并且同一个Holder是可以绑定不同的LayoutId,以后你只需要维护和兼容你的Holder,在各个列表里通用的你holder逻辑了,是不是瞬间代码干净了好多?

下拉刷新与上拉加载更多

普通的列表,直接使用系统的SwipeRefreshLayout就可以啦,简单有好用。下拉加载更多直接添加下方方法,轻松实现上下拉刷新<( ̄︶ ̄),简单粗暴,就是记得要加个锁避免重复进入。

//打开支持需要加载更多
adapter.setNeedLoadMore(true);

recycler.addOnScrollListener(new LoadMoreScrollListener() {
    @Override
    public void onLoadMore() {
        //注意加锁
        if (!isLoadMore) {
            isLoadMore = true;
            recycler.postDelayed(new Runnable() {
                @Override
                public void run() {
                    isLoadMore = false;
                    loadMore();
                }

            }, 2000);
        }
    }

    //当前第一个可视的是哪个item
    @Override
    public void onScrolled(int firstPosition) {
    }
});

其他配置

你还可以配置是否显示动画效果,配置上拉loading的颜色,单击和长按等,看下面。

//支持空数据显示 空页面
adapter.setShowNoData(true);

//显示空数据model,不设置显示默认空页面
adapter.setNoDataModel(noDataModel);

//显示空数据页面布局,不设置显示默认,布局id需要通过CommonRecyclerManager关联hodler
adapter.setNoDataLayoutId(noDataLayoutId);

//设置动画支持打开
adapter.setNeedAnimation(true);

//添加点击
adapter.setOnItemClickListener();

XRecyclerView兼容支持

这里添加了XRecyclerView,并且对其进行了修改。XRecyclerView内置了内部Adapter,使其支持添加头部,自带上下拉效果的控件,部分调整之后,全面支持CommonRecyclerAdapter

不需要监听滑动,不需要SwipeRefreshLayout,轻松添加刷新与加载更多。而且更是支持动态配置,上下拉的各种样式支持,具体在ProgressStyle下有多种类型支持配置,解决了Adapter对瀑布流上拉的支持不够兼容的问题。

这里使用方式,和普通的RecyclerView一样,支持和CommonRecyclerAdapter的配合,而且它同样支持空页面显示,还支持添加各种头部,唯一需要注意的是,添加分割线类addItemDecoration点击的时候,需要针对添加了头部,和刷新的绝对的position,换算成相对的位置,此处曾经把自己坑哭了╥﹏╥...,下面看代码吧。


//是否屏蔽下拉
//xRecycler.setPullRefreshEnabled(false);
//上拉加载更多样式,也可以设置下拉
xRecycler.setLoadingMoreProgressStyle(ProgressStyle.SysProgress);
//设置管理器,关联布局与holder类名,不同id可以管理一个holder
CommonRecyclerManager commonRecyclerManager = new CommonRecyclerManager();
commonRecyclerManager.addType(ImageHolder.ID, ImageHolder.class.getName());
commonRecyclerManager.addType(TextHolder.ID, TextHolder.class.getName());
commonRecyclerManager.addType(ClickHolder.ID, ClickHolder.class.getName());
//初始化通用管理器
commonRecyclerAdapter = new CommonRecyclerAdapter(getActivity(), commonRecyclerManager, dataList);
xRecycler.setAdapter(commonRecyclerAdapter);

ImageView imageView = new ImageView(getActivity());
imageView.setImageResource(R.drawable.xxx1);
imageView.setScaleType(ImageView.ScaleType.CENTER_CROP);
imageView.setMinimumHeight(dip2px(getActivity(), 100));
//添加头部
xRecycler.addHeaderView(imageView);
//本身也支持设置空局部
//xRecycler.setEmptyView();
xRecycler.setLoadingListener(new XRecyclerView.LoadingListener() {
    @Override
    public void onRefresh() {
        xRecycler.postDelayed(new Runnable() {
            @Override
            public void run() {
                xRecycler.refreshComplete();
            }
        }, 2000);
    }

    @Override
    public void onLoadMore() {
        xRecycler.postDelayed(new Runnable() {
            @Override
            public void run() {
                loadMore();
            }
        }, 2000);
    }
});

commonRecyclerAdapter.setOnItemClickListener(new OnItemClickListener() {
    @Override
    public void onItemClick(Context context, int position) {
        //需要减去你的header和刷新的view的数量
        Toast.makeText(getActivity(), "点击了!! " + (position - 2), Toast.LENGTH_SHORT).show();
    }
});
最后

到这里你已经知道了大致的用法了吧。详细的内部实现,可以通过DEMO查看。大致逻辑是 CommonRecyclerManager 关联接layoutId和Holder类名,CommonRecyclerAdapter通过Model的layoutId找到这个Holder,然后用layoutId创建view,把View、position、model传入到Holder里面实现数据填充。所layoutId也是类型id*,注意:

使用的时候切记要给你的model设置setResLayoutId(),这是最容易让人遗忘的。

我叫DEMO:https://github.com/CarGuo/LazyRecyclerAdapter

看明白了吗?
Android程序员的日常
Web note ad 1