装饰者模式实现HeaderFooterRecyclerViewAdapter

上一篇文章详细介绍了如何制作高复用性的RecyclerView.Adapter,得到了ComRecyclerViewAdapter,但是ComRecyclerViewAdapter也是拥有局限性的,例如,当我希望能够在列表中加入Header或者Footer的时候,显然是无法直接使用ComRecyclerViewAdapter的,因为首先,getViewType方法无法分辨类型,其次无法传入多个不同的layoutId。再者,当我希望拥有Header或Footer的这个Adapter也能够支持对内容item的操作动画时(横滑,拖拽等),是不是还要抛弃ComRecyclerViewAdapter,重新写一个不一样的Adapter呢?答案当然不是。下面介绍,如何在不修改ComRecyclerViewAdapter的任何一个地方的情况下,令其支持上述新需求。

我们知道装饰者模式的定义就是在原有类的基础上,通过组合等方式,再包装一层,并对外界提供与原有类一模一样的接口调用,从而赋予更多的能力和职责。试想,HeaderFooterRecyclerViewAdapter 和 ComRecyclerViewAdapter的区别是什么?当然是在后者的基础上,上、下可能都会有新的View作为Header和Footer。如果把ComRecyclerViewAdapter看成一个盒子,那么,HeaderFooterRecyclerViewAdapter就可以被看成是一个宽度与ComRecyclerViewAdapter一致,高度大于ComRecyclerViewAdapter的盒子,装入ComRecyclerViewAdapter的时候,上下留有空隙承载其他View(这个模型刚刚好符合装饰者模式哦)。

于是我们的思路就是:用一个更大的Adapter装入ComRecyclerViewAdapter,实现Header、Footer及手势动画的工能。对于Header、Footer,允许有多组,因此我们再次使用SparseArray(上一次用到可是在ComViewHolder哦)。k-v结构中,我们以viewType作为k,具体view作为v,分别对Headers和Footers初始化两个SparseArray。为了灵活而又能够自动化控制这些view的viewType,我们设置HEADER_BASE_TYPE和FOOTER_BASE_TYPE作为基数,对应的viewType公式如下:
(header|footer).viewType(n) = HEADER_BASE_TYPE+(header|footer)SparseArray.size(),其中n = SparseArray.size()

因此,如果view是header,则它的position属于[0,headerSparseArray.size),反之也成立;如果view是footer,则其position一定属于[ headerSparseArray.size+innerAdapter.size,headerSparseArray.size+innerAdapter.size+footerSparseArray.size ),反之也成立。这可以作为我们判断view身份的依据。

完整代码如下:


public class HeaderFooterRecyclerViewAdapter extends RecyclerView.Adapter implements ItemTouchHelperAdapter {

    private final static int HEADER_BASE_TYPE = 10000;
    private final static int FOOTER_BASE_TYPE = 20000;

    private SparseArrayCompat<View> mHeaderViews = new SparseArrayCompat<>();
    private SparseArrayCompat<View> mFooterViews = new SparseArrayCompat<>();
    private RecyclerView.Adapter mInnerAdapter;
    private Context mContext;

    public HeaderFooterRecyclerViewAdapter(Context context, RecyclerView.Adapter innerAdapter) {
        mContext = context;
        mInnerAdapter = innerAdapter;
    }

    public void addHeaderView(View headerView) {
        mHeaderViews.put(mHeaderViews.size() + HEADER_BASE_TYPE, headerView);
    }

    public void addFooterView(View footerView) {
        mFooterViews.put(mFooterViews.size() + FOOTER_BASE_TYPE, footerView);
    }

    public boolean isHeaderPosition(int position) {
        return position < mHeaderViews.size();
    }

    public boolean isFooterPosition(int position) {
        return position >= mInnerAdapter.getItemCount() + mHeaderViews.size();
    }

    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        if (mHeaderViews.get(viewType) != null) {
            return new ComViewHolder(mContext, mHeaderViews.get(viewType), parent);
        } else if (mFooterViews.get(viewType) != null) {
            return new ComViewHolder(mContext, mFooterViews.get(viewType), parent);
        } else {
            return mInnerAdapter.onCreateViewHolder(parent, viewType);
        }
    }

    @Override
    public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {
        
        if (isHeaderPosition(position) || isFooterPosition(position)) {
            return;
        }
        //需要处理好相对于装饰者的position和相对于innerAdapter的position之间的对应关系。
        mInnerAdapter.onBindViewHolder(holder, position - mHeaderViews.size());
    }

    @Override
    public int getItemCount() {
        return mHeaderViews.size() + mInnerAdapter.getItemCount() + mFooterViews.size();
    }

    @Override
    public int getItemViewType(int position) {
        if (isHeaderPosition(position)) {
            //SparseArray是基于key的有序结构,在存储的时候是按照顺序将key增序存储,因此按照position获取到的key所在的view依然是有序的。
            return mHeaderViews.keyAt(position);
        }
        if (isFooterPosition(position)) {
            return mFooterViews.keyAt(position - mHeaderViews.size() - mInnerAdapter.getItemCount());
        }
        return mInnerAdapter.getItemViewType(position - mHeaderViews.size());
    }

    @Override
    public void onItemTop(int fromPosition) {
        if (isHeaderPosition(fromPosition) || isFooterPosition(fromPosition)) {
            return;
        }
        ((ItemTouchHelperAdapter) mInnerAdapter).onItemTop(fromPosition - mHeaderViews.size());
        notifyItemMoved(fromPosition, mHeaderViews.size());
    }

    @Override
    public void onItemDismiss(int position) {
        if (isHeaderPosition(position) || isFooterPosition(position))
            return;
        ((ItemTouchHelperAdapter) mInnerAdapter).onItemDismiss(position - mHeaderViews.size());
        notifyItemRemoved(position);
    }

    @Override
    public void onItemSwap(int itemAPosition, int itemBPosition) {
        if (isHeaderPosition(itemAPosition) || isFooterPosition(itemBPosition) || isFooterPosition(itemAPosition) || isFooterPosition(itemBPosition))
            return;
        ((ItemTouchHelperAdapter) mInnerAdapter).onItemSwap(itemAPosition - mHeaderViews.size(), itemBPosition - mHeaderViews.size());
        notifyItemMoved(itemAPosition, itemBPosition);
    }

}

当然,这样的实现方式也存在缺点,成员变量中mInnerAdapter是RecyclerView.Adapter类型,而在onItemTop、onItemDismiss等动画操作的时候需要的是ItemTouchHelperAdapter,因此并不是类型安全的,可能会误导使用者传入一个非ItemTouchHelperAdapter从而引发类型异常的crash,后续会进行改进。

git源码:
https://github.com/GhostInMatrix/PullToRefreshRecyclerview

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

推荐阅读更多精彩内容