装饰者模式实现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 mHeaderViews = new SparseArrayCompat<>();
    private SparseArrayCompat 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