天天看點
傳回

裝飾設計模式 - RecyclerView添加頭部和底部

定義:

裝飾設計模式也稱包裝設計模式，用來動态的擴充對象的功能，也是繼承關系的的一種替代方案之一。

說個大白話就是，在不使用的繼承的方式下，采用裝飾設計模式可以擴充一個對象的功能，可以使一個對象變得越來越強大。

我們首先看下效果圖
裝飾設計模式 - RecyclerView添加頭部和底部
我們都知道listview是可以添加頭部和尾部的，我們大概看下，具體的可以自己去看下，源碼并不難。 
public void setAdapter(ListAdapter adapter) {
        if (mAdapter != null && mDataSetObserver != null) {
            mAdapter.unregisterDataSetObserver(mDataSetObserver);
        }

        resetList();
        mRecycler.clear();

        if (mHeaderViewInfos.size() > || mFooterViewInfos.size() > ) {
         //實際上呢，listview是将adapter添加了一個包裹類
            mAdapter = wrapHeaderListAdapterInternal(mHeaderViewInfos, mFooterViewInfos, adapter);
        } else {
            mAdapter = adapter;
        }
    //代碼省略
}
我們可以模仿listview進行adapter的封裝

首先WrapRecyclerAdapter類是繼承于RecylerView的adapter,參數如下

private final static String TAG = "WrapRecyclerAdapter";
    // 用來存放底部和頭部View的集合  比Map要高效一些
    private SparseArray<View> mHeaderViews;
    private SparseArray<View> mFooterViews;

    // 基本的頭部類型開始位置  用于viewType
    private static int BASE_ITEM_TYPE_HEADER = ;
    // 基本的底部類型開始位置  用于viewType
    private static int BASE_ITEM_TYPE_FOOTER = ;
    // 清單的Adapter
    private RecyclerView.Adapter mAdapter;
 //通過構造函數的方法
  public WrapRecyclerAdapter(RecyclerView.Adapter adapter) {
        this.mAdapter = adapter;
        mHeaderViews = new SparseArray<>();
        mFooterViews = new SparseArray<>();
    }

我們首先定義四個方法，添加頭部，尾部，删除頭部，尾部

/**
     * 添加頭部
     */
    public void addHeaderView(View view) {
        int position = mHeaderViews.indexOfValue(view);
        if (position < ) {
            mHeaderViews.put(BASE_ITEM_TYPE_HEADER++, view);
        }
        notifyDataSetChanged();
    }

    /**
     * 添加底部
     */
    public void addFooterView(View view) {
        int position = mFooterViews.indexOfValue(view);
        if (position < ) {
            mFooterViews.put(BASE_ITEM_TYPE_FOOTER++, view);
        }
        notifyDataSetChanged();
    }

    /**
     * 移除頭部
     */
    public void removeHeaderView(View view) {
        int index = mHeaderViews.indexOfValue(view);
        if (index < ) return;
        mHeaderViews.removeAt(index);
        notifyDataSetChanged();
    }

    /**
     * 移除底部
     */
    public void removeFooterView(View view) {
        int index = mFooterViews.indexOfValue(view);
        if (index < ) return;
        mFooterViews.removeAt(index);
        notifyDataSetChanged();
    }

然後我們看下我們複寫的第一個方法 getItemCount()很簡單： 底部條數 + 頭部條數 + Adapter的條數

@Override
    public int getItemCount() {
        // 條數三者相加 = 底部條數 + 頭部條數 + Adapter的條數
        return mAdapter.getItemCount() + mHeaderViews.size() + mFooterViews.size();
    }

然後看下我們複寫的第二個方法onCreateViewHolder()方法

@Override
    public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {

        // viewType 可能就是 SparseArray 的key
        if (isHeaderViewType(viewType)) {
            View headerView = mHeaderViews.get(viewType);
            return createHeaderFooterViewHolder(headerView);
        }

        if (isFooterViewType(viewType)) {
            View footerView = mFooterViews.get(viewType);
            return createHeaderFooterViewHolder(footerView);
        }
        return mAdapter.onCreateViewHolder(parent, viewType);
    }

判斷是不是頭部或者底部類型并建立ViewHolder

/**
     * 是不是底部類型
     */
    private boolean isFooterViewType(int viewType) {
        int position = mFooterViews.indexOfKey(viewType);
        return position >= ;
    }

    /**
     * 建立頭部或者底部的ViewHolder
     */
    private RecyclerView.ViewHolder createHeaderFooterViewHolder(View view) {
        return new RecyclerView.ViewHolder(view) {

        };
    }

    /**
     * 是不是頭部類型
     */
    private boolean isHeaderViewType(int viewType) {
        int position = mHeaderViews.indexOfKey(viewType);
        return position >= ;
    }

注意這裡viewType不是position是以我們一定要複寫getItemViewType将傳回的值指派給viewType

@Override
    public int getItemViewType(int position) {
        if (isHeaderPosition(position)) {
            // 直接傳回position位置的key
            return mHeaderViews.keyAt(position);
        }
        if (isFooterPosition(position)) {
            // 直接傳回position位置的key
            position = position - mHeaderViews.size() - mAdapter.getItemCount();
            return mFooterViews.keyAt(position);
        }
        // 傳回清單Adapter的getItemViewType
        position = position - mHeaderViews.size();
        return mAdapter.getItemViewType(position);
    }

看最後一個複寫的方法onBindViewHolder()

@Override
    public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {
        if (isHeaderPosition(position) || isFooterPosition(position)) {
            return;
        }
        // 計算一下位置
        final int adapterPosition = position - mHeaderViews.size();
        mAdapter.onBindViewHolder(holder, adapterPosition);

        // 設定點選和長按事件
        if (mItemClickListener != null) {
            holder.itemView.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    mItemClickListener.onItemClick(adapterPosition);
                }
            });
        }
        if (mLongClickListener != null) {
            holder.itemView.setOnLongClickListener(new View.OnLongClickListener() {
                @Override
                public boolean onLongClick(View v) {
                    return mLongClickListener.onLongClick(adapterPosition);
                }
            });
        }
    }

/判斷是不是頭部或者底部的位置

/**
     * 是不是底部位置
     */
    private boolean isFooterPosition(int position) {
        return position >= (mHeaderViews.size() + mAdapter.getItemCount());
    }

    /**
     * 是不是頭部位置
     */
    private boolean isHeaderPosition(int position) {
        return position < mHeaderViews.size();
    }

好了，這時候我們的裝飾的adapter已經寫好了，接下來我們寫下RecylerView的包裹類，不然我們這樣使用

RecyclerAdapter mRealAdapter = new RecyclerAdapter();
        WrapRecyclerAdapter wrapRecyclerAdapter = new WrapRecyclerAdapter(mRealAdapter);
        // setAdapter
        mRecyclerView.setAdapter(wrapRecyclerAdapter);
    //添加頭尾部

這這樣使用感覺很尴尬啊

WrapRecyclerView繼承于RecyclerView内部 

// 包裹了一層的頭部底部Adapter
    private WrapRecyclerAdapter mWrapRecyclerAdapter;
    // 這個是清單資料的Adapter
    private Adapter mAdapter;

    // 增加一些通用功能
    // 空清單資料應該顯示的空View
    // 正在加載資料頁面，也就是正在擷取背景接口頁面
    private View mEmptyView, mLoadingView;
public WrapRecyclerView(Context context) {
        super(context);
    }

    public WrapRecyclerView(Context context, @Nullable AttributeSet attrs) {
        super(context, attrs);
    }

    public WrapRecyclerView(Context context, @Nullable AttributeSet attrs, int defStyle) {
        super(context, attrs, defStyle);
    }

還是先看我們添加和删除的的四個方法

// 添加頭部
    public void addHeaderView(View view) {
        // 如果沒有Adapter那麼就不添加，也可以選擇抛異常提示
        // 讓他必須先設定Adapter然後才能添加，這裡是仿照ListView的處理方式
        if (mWrapRecyclerAdapter != null) {
            mWrapRecyclerAdapter.addHeaderView(view);
        }
    }

    // 添加底部
    public void addFooterView(View view) {
        if (mWrapRecyclerAdapter != null) {
            mWrapRecyclerAdapter.addFooterView(view);
        }
    }

    // 移除頭部
    public void removeHeaderView(View view) {
        if (mWrapRecyclerAdapter != null) {
            mWrapRecyclerAdapter.removeHeaderView(view);
        }
    }

    // 移除底部
    public void removeFooterView(View view) {
        if (mWrapRecyclerAdapter != null) {
            mWrapRecyclerAdapter.removeFooterView(view);
        }
    }

複寫setAdapter的方法

@Override
    public void setAdapter(Adapter adapter) {
        // 為了防止多次設定Adapter
        if (mAdapter != null) {
            mAdapter.unregisterAdapterDataObserver(mDataObserver);
            mAdapter = null;
        }

        this.mAdapter = adapter;

        if (adapter instanceof WrapRecyclerAdapter) {
            mWrapRecyclerAdapter = (WrapRecyclerAdapter) adapter;
        } else {
            mWrapRecyclerAdapter = new WrapRecyclerAdapter(adapter);
        }

        super.setAdapter(mWrapRecyclerAdapter);

        // 注冊一個觀察者
        mAdapter.registerAdapterDataObserver(mDataObserver);

        // 解決GridLayout添加頭部和底部也要占據一行
        mWrapRecyclerAdapter.adjustSpanSize(this);

        // 加載資料頁面
        if (mLoadingView != null && mLoadingView.getVisibility() == View.VISIBLE) {
            mLoadingView.setVisibility(View.GONE);
        }

        if (mItemClickListener != null) {
            mWrapRecyclerAdapter.setOnItemClickListener(mItemClickListener);
        }

        if (mLongClickListener != null) {
            mWrapRecyclerAdapter.setOnLongClickListener(mLongClickListener);
        }
    }

mDataObserver注冊器的使用呢

private AdapterDataObserver mDataObserver = new AdapterDataObserver() {
        @Override
        public void onChanged() {
            if (mAdapter == null) {
                return;
            }
            // 觀察者  清單Adapter更新 包裹的也需要更新不然清單的notifyDataSetChanged沒效果
            if (mWrapRecyclerAdapter != mAdapter) {
                mWrapRecyclerAdapter.notifyDataSetChanged();
            }
            dataChanged();
        }

        @Override
        public void onItemRangeRemoved(int positionStart, int itemCount) {
            if (mAdapter == null) return;
            // 觀察者  清單Adapter更新 包裹的也需要更新不然清單的notifyDataSetChanged沒效果
            if (mWrapRecyclerAdapter != mAdapter)
                mWrapRecyclerAdapter.notifyItemRemoved(positionStart);
            dataChanged();
        }

        @Override
        public void onItemRangeMoved(int fromPosition, int toPosition, int itemCount) {
            if (mAdapter == null) {
                return;
            }
            // 觀察者  清單Adapter更新 包裹的也需要更新不然清單的notifyItemMoved沒效果
            if (mWrapRecyclerAdapter != mAdapter) {
                mWrapRecyclerAdapter.notifyItemMoved(fromPosition, toPosition);
            }
            dataChanged();
        }

        @Override
        public void onItemRangeChanged(int positionStart, int itemCount) {
            if (mAdapter == null) {
                return;
            }
            // 觀察者  清單Adapter更新 包裹的也需要更新不然清單的notifyItemChanged沒效果
            if (mWrapRecyclerAdapter != mAdapter) {
                mWrapRecyclerAdapter.notifyItemChanged(positionStart);
            }
            dataChanged();
        }

        @Override
        public void onItemRangeChanged(int positionStart, int itemCount, Object payload) {
            if (mAdapter == null) {
                return;
            }
            // 觀察者  清單Adapter更新 包裹的也需要更新不然清單的notifyItemChanged沒效果
            if (mWrapRecyclerAdapter != mAdapter) {
                mWrapRecyclerAdapter.notifyItemChanged(positionStart, payload);
            }
            dataChanged();
        }

        @Override
        public void onItemRangeInserted(int positionStart, int itemCount) {
            if (mAdapter == null) {
                return;
            }
            // 觀察者  清單Adapter更新 包裹的也需要更新不然清單的notifyItemInserted沒效果
            if (mWrapRecyclerAdapter != mAdapter) {
                mWrapRecyclerAdapter.notifyItemInserted(positionStart);
            }
            dataChanged();
        }
    };

Adapter資料改變的方法

private void dataChanged() {
        if (mAdapter.getItemCount() == ) {
            // 沒有資料
            if (mEmptyView != null) {
                mEmptyView.setVisibility(VISIBLE);
            } else {
                mEmptyView.setVisibility(GONE);
            }
        }
    }

添加一個空清單資料頁面和添加一個正在加載資料的頁面

/**
     * 添加一個空清單資料頁面
     */
    public void addEmptyView(View emptyView) {
        this.mEmptyView = emptyView;
    }

    /**
     * 添加一個正在加載資料的頁面
     */
    public void addLoadingView(View loadingView) {
        this.mLoadingView = loadingView;
        mLoadingView.setVisibility(View.VISIBLE);
    }
Android系統架構
上一篇: SQL 對郵箱資料的處理（分類統計）
下一篇: JavaMail入門第四篇 接收郵件

繼續閱讀