RecyclerView 添加HeaderView 和 FooterView

文/yamda

谷歌在2014年6月26日的I/O 2014開發(fā)者大會上正式推出了Android L, 其中RecyclerView 也是在這次發(fā)布會上提出的。RecyclerView是一種新的視圖組,目標是為任何基于適配器的視圖提供相似的渲染方式。它被作為ListView和GridView控件的繼承者。

用過ListView 和RecyclerView的朋友肯定會發(fā)現(xiàn):

  1. RecyclerView 沒有HeaderView 和 footerView。
  • RecyclerView 沒有 ItemClick事件。
  • RecyclerView 沒有 setEmptyView。

RecyclerView的優(yōu)點也很明顯:

  1. 強大的視圖布局管理器。(可以使用橫向、縱向、網(wǎng)格布局)

本篇文章主要是為Recyclerview添加headerView 和 footerView。
在接觸一個新功能的時,可能因為沒有接觸過導(dǎo)致有一種無從下手的感覺。在這里,我們不妨看看ListView是如何實現(xiàn)HeaderView 和 FooterView;

我們進入listView.setAdapter()方法中:

@Override
public void setAdapter(ListAdapter adapter) {
    if (mAdapter != null && mDataSetObserver != null) {
        //取消上一個數(shù)據(jù)觀察者
        mAdapter.unregisterDataSetObserver(mDataSetObserver);
    }

    .............
    
    //判斷是否添加了headerView 和 footerView
    if (mHeaderViewInfos.size() > 0|| mFooterViewInfos.size() > 0) {
        mAdapter = new HeaderViewListAdapter(mHeaderViewInfos, mFooterViewInfos, adapter);
    } else {
        mAdapter = adapter;
    }

    .............

    // AbsListView#setAdapter will update choice mode states.
    super.setAdapter(adapter);

    if (mAdapter != null) {
         .............
        
        //重新為adapter注冊一個觀察者
        mDataSetObserver = new AdapterDataSetObserver();
        mAdapter.registerDataSetObserver(mDataSetObserver);

        ..............

    }
    .............
}

在這里我們看到有一個AdapterDataSetObserver類,這是一個數(shù)據(jù)觀察者,在我們調(diào)用adapter.notifyDataSetChang()的時候,adapter會通知所有訂閱它的觀察者更新數(shù)據(jù)。在里面我們可以看到其中有一個類名為HeaderViewListAdapter類,從類名上我們就可以看出來這和 headerView有關(guān)系。我繼續(xù)點進去看看里面的具體內(nèi)容。

public HeaderViewListAdapter(ArrayList<ListView.FixedViewInfo> headerViewInfos,
                             ArrayList<ListView.FixedViewInfo> footerViewInfos,
                             ListAdapter adapter) {
    mAdapter = adapter;
    mIsFilterable = adapter instanceof Filterable;

    if (headerViewInfos == null) {
        mHeaderViewInfos = EMPTY_INFO_LIST;
    } else {
        mHeaderViewInfos = headerViewInfos;
    }

    if (footerViewInfos == null) {
        mFooterViewInfos = EMPTY_INFO_LIST;
    } else {
        mFooterViewInfos = footerViewInfos;
    }

    //判斷headerView 和 footerView 是否可以點擊
    mAreAllFixedViewsSelectable =
            areAllListInfosSelectable(mHeaderViewInfos)
                    && areAllListInfosSelectable(mFooterViewInfos);

構(gòu)造方法比較簡單, 主要是判斷是否有headerView 和 footerView, 以及它們是否可以進行選擇。在平時寫adapter的時候就知道adapter最主要是在getView()方法中,我們在去看看getView()方法是如何實現(xiàn)的。

public View getView(int position, View convertView, ViewGroup parent) {
    // Header (negative positions will throw an IndexOutOfBoundsException)
    int numHeaders = getHeadersCount();
    if (position < numHeaders) {
        //返回headerView
        return mHeaderViewInfos.get(position).view;
    }

    // Adapter
    final int adjPosition = position - numHeaders;
    int adapterCount = 0;
    if (mAdapter != null) {
        //adapter的實際位置
        adapterCount = mAdapter.getCount();
        if (adjPosition < adapterCount) {
            return mAdapter.getView(adjPosition, convertView, parent);
        }
    }

    // Footer (off-limits positions will throw an IndexOutOfBoundsException)
    // 返回footerView
    return mFooterViewInfos.get(adjPosition - adapterCount).view;
}

在這個方法中,我們可以看到如果 position 位置 小于headerViewCount 時候,說明現(xiàn)在應(yīng)該返回headerView,而當 adjPosition 小于 adapterCount的時候 說明現(xiàn)在應(yīng)該返回 被包裝的adapter.getView()方法,其余的時候直接 返回footerView。在理解getView()方法后,
繼續(xù)看getItemViewType()、getItemId()、getItem()等方法,發(fā)現(xiàn)他們實現(xiàn)的方式 和 getView() 的邏輯 大同小異。

在理解listView的封裝邏輯之后, 我們就可以模仿它來 封裝RecyclerView。

第一步,引入RecyclerView架包

在build.gradle 添加依賴

compile 'com.android.support:recyclerview-v7:24.0.0'

第二步,自定義RecyclerView

import android.content.Context;
import android.support.annotation.Nullable;
import android.support.v7.widget.RecyclerView;
import android.util.AttributeSet;
import android.view.View;

import java.util.ArrayList;
import java.util.List;

/**
 * Created by User on 2016/11/7.
 */
public class HeaderRecyclerView extends RecyclerView {

    private List<View> mHeaderViews = new ArrayList<>();
    private List<View> mFooterViews = new ArrayList<>();
    private HeaderViewAdapter mAdapter;

    public HeaderRecyclerView(Context context) {
        super(context);
    }

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

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

    public void removeHeaderView(View view) {
        if (mHeaderViews.contains(view)) {
            mHeaderViews.remove(view);
        }
        if (mAdapter != null) {
            mAdapter.notifyDataSetChanged();
        }
    }

    public void removeFooterView(View view) {
        if (mFooterViews.contains(view)) {
            mFooterViews.remove(view);
        }
        if (mAdapter != null) {
            mAdapter.notifyDataSetChanged();
        }
    }

    public void addHeaderView(View view) {
        mHeaderViews.add(view);
        if (mAdapter != null) {
            mAdapter.notifyDataSetChanged();
        }
    }

    public void addFooterView(View view) {
        mFooterViews.add(view);
        if (mAdapter != null) {
            mAdapter.notifyDataSetChanged();
        }
    }

    @Override
    public void setAdapter(Adapter adapter) {
        if (mAdapter != null) {
            //移除上一次的觀察者
            mAdapter.unregisterDataSetObserver(mAdapterDataObserver);
        }
        mAdapter = new HeaderViewAdapter(adapter, mHeaderViews, mFooterViews);

        //重新注冊一個新的觀察者
        mAdapter.registerDataSetObserver(mAdapterDataObserver);
        super.setAdapter(mAdapter);
    }

    //數(shù)據(jù)觀察者
    private AdapterDataObserver mAdapterDataObserver = new AdapterDataObserver() {
        @Override
        public void onChanged() {
            mAdapter.notifyDataSetChanged();
        }

        @Override
        public void onItemRangeChanged(int positionStart, int itemCount) {
            mAdapter.notifyItemRangeChanged(positionStart + mHeaderViews.size(), itemCount);
        }

        @Override
        public void onItemRangeChanged(int positionStart, int itemCount, Object payload) {
            mAdapter.notifyItemRangeChanged(positionStart + mHeaderViews.size(), itemCount, payload);
        }

        @Override
        public void onItemRangeInserted(int positionStart, int itemCount) {
            mAdapter.notifyItemRangeInserted(positionStart + mHeaderViews.size(), itemCount);
        }

        @Override
        public void onItemRangeRemoved(int positionStart, int itemCount) {
            mAdapter.notifyItemRangeRemoved(positionStart + mHeaderViews.size(), itemCount);
        }
    };
}

上面是我們的自定義的RecyclerView, 最主要的是在setAdapter()中添加 數(shù)據(jù)觀察者。

第三步, 編寫HeaderViewAdapter

import android.support.v7.widget.RecyclerView;
import android.view.View;
import android.view.ViewGroup;
import java.util.List;

/**
 * Created by User on 2016/11/2.
 */
public class HeaderViewAdapter extends RecyclerView.Adapter {

    private List<View> headerView;
    private List<View> footerView;
    private RecyclerView.Adapter tagAdapter;

    //定義FooterView類型 和 HeaderView類型
    private final static int HEADER_VIEW_TYPE = Integer.MAX_VALUE / 123;
    private final static int FOOTER_VIEW_TYPE = Integer.MAX_VALUE / 321;


    public HeaderViewAdapter(RecyclerView.Adapter tagAdapter, List<View> headerViews, List<View> footerViews) {
        this.tagAdapter = tagAdapter;
        this.headerView = headerViews;
        this.footerView = footerViews;
    }

    @Override
    public int getItemViewType(int position) {
        int headerNums = headerView.size();
        if (headerNums > position) return HEADER_VIEW_TYPE;
        if (position >= headerNums) {
            int adCount = tagAdapter.getItemCount();
            int adjPosition = position - headerNums;
            if (adjPosition < adCount) {
                return tagAdapter.getItemViewType(adjPosition);
            }
        }
        return FOOTER_VIEW_TYPE;
    }

    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        switch (viewType) {
            case HEADER_VIEW_TYPE:
                return new HeaderOrFooterView(headerView.get(0));
            case FOOTER_VIEW_TYPE:
                return new HeaderOrFooterView(footerView.get(0));
            default:
               return tagAdapter.onCreateViewHolder(parent, viewType);
        }
    }

    @Override
    public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {
        int headerNum = headerView.size();
        if (position >= headerNum) {
            int adCount = tagAdapter.getItemCount();
            int adjPosition = position - headerNum;
            if (adjPosition < adCount) {
                tagAdapter.onBindViewHolder(holder, adjPosition);
            }
        }
    }

      /**
     * 添加支持GridLayoutManager
     * @param recyclerView
     */
    @Override
    public void onAttachedToRecyclerView(RecyclerView recyclerView) {
        super.onAttachedToRecyclerView(recyclerView);
        RecyclerView.LayoutManager manager = recyclerView.getLayoutManager();
        if (manager instanceof GridLayoutManager) {
            final GridLayoutManager gridLayoutManager = (GridLayoutManager) manager;
            gridLayoutManager.setSpanSizeLookup(new GridLayoutManager.SpanSizeLookup() {
                @Override
                public int getSpanSize(int position) {
                    return (isHeaderView(position) || isFooterView(position)) ? gridLayoutManager.getSpanCount() : 1;
                }
            });
        }
    }
    
    /**
     * 添加支持StaggeredGridLayoutManager
     * @param holder
     */
    @Override
    public void onViewAttachedToWindow(RecyclerView.ViewHolder holder) {
        super.onViewAttachedToWindow(holder);
        ViewGroup.LayoutParams layoutParams = holder.itemView.getLayoutParams();
        if (null != layoutParams && layoutParams instanceof StaggeredGridLayoutManager.LayoutParams) {
            if (isFooterView(holder.getLayoutPosition()) || isHeaderView(holder.getLayoutPosition())) {
                StaggeredGridLayoutManager.LayoutParams params = (StaggeredGridLayoutManager.LayoutParams) layoutParams;
                params.setFullSpan(true);
            }
        }
    }

    private boolean isHeaderView(int position) {
        if (position < headerView.size()) {
            return true;
        }
        return false;
    }

    private boolean isFooterView(int position) {
        int headerSize = headerView.size();
        int footerSize = footerView.size();
        int adSize = tagAdapter.getItemCount();
        if ( position >= headerSize + adSize && position < headerSize + footerSize + adSize) {
            return true;
        }
        return false;
    }

    @Override
    public int getItemCount() {
        return tagAdapter.getItemCount() + headerView.size() + footerView.size();
    }

    public void registerDataSetObserver(RecyclerView.AdapterDataObserver mDataObserver) {
        if (tagAdapter != null) {
            tagAdapter.registerAdapterDataObserver(mDataObserver);
        }
    }

    public void unregisterDataSetObserver(RecyclerView.AdapterDataObserver mDataObserver) {
        if (tagAdapter != null) {
            tagAdapter.unregisterAdapterDataObserver(mDataObserver);
        }
    }

    /**
     * headerView 和 footerView  ViewHolder的持有類
     */
    class HeaderOrFooterView extends RecyclerView.ViewHolder {
        public HeaderOrFooterView(View itemView) {
            super(itemView);
        }
    }
}

在寫完這個類的時候, 我們基本已經(jīng)完成了 RecyclerView 的 headerView 和 footerView的封裝了。

在最后讓我們預(yù)覽下最終的效果:

headerView 和 footerView 已經(jīng)成功添加進了。至此,我們已經(jīng)完成了對 RecyclerView 進行簡單的封裝 headerView 和 footerView。

感謝大家的閱讀。如果發(fā)現(xiàn)本文理解的不對的地方,歡迎指出,一起學習,一起進步!


更新:添加支持網(wǎng)格布局和瀑布流布局

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,572評論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,071評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,409評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,569評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,360評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 54,895評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,979評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,123評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,643評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,559評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,742評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,250評論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 43,981評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,363評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,622評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,354評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,707評論 2 370

推薦閱讀更多精彩內(nèi)容