RecyclerView 添加headerView 和 footerView

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

用過ListView 和RecyclerView的朋友肯定會發現:

1. RecyclerView 沒有HeaderView 和 footerView。

2. RecyclerView 沒有 ItemClick事件。

3. RecyclerView 沒有 setEmptyView。

RecyclerView的優點也很明顯：

1. 強大的視圖布局管理器。（可以使用橫向、縱向、網格布局）

2. 預設的ViewHolder重用機制。

3. 強大的動畫效果。(https://github.com/wasabeef/recyclerview-animators)

本篇文章主要是為Recyclerview添加headerView 和 footerView。

在接觸一個新功能的時，可能因為沒有接觸過導緻有一種無從下手的感覺。在這裡，我們不妨看看ListView是如何實作HeaderView 和 FooterView;

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

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

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

    //判斷是否添加了headerView 和 footerView
    if (mHeaderViewInfos.size() > || mFooterViewInfos.size() > ) {
        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類，這是一個資料觀察者，在我們調用adapter.notifyDataSetChang()的時候，adapter會通知所有訂閱它的觀察者更新資料。在裡面我們可以看到其中有一個類名為HeaderViewListAdapter類，從類名上我們就可以看出來這和 headerView有關系。我繼續點進去看看裡面的具體内容。

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);

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

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 = ;
    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 時候，說明現在應該傳回headerView，而當 adjPosition 小于 adapterCount的時候說明現在應該傳回被包裝的adapter.getView()方法，其餘的時候直接傳回footerView。在了解getView()方法後，

繼續看getItemViewType()、getItemId()、getItem()等方法，發現他們實作的方式和 getView() 的邏輯大同小異。

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

第一步，引入RecyclerView架包

在build.gradle 添加依賴

第二步，自定義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);
    }

    //資料觀察者
    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()中添加資料觀察者。

第三步, 編寫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 / ;
    private final static int FOOTER_VIEW_TYPE = Integer.MAX_VALUE / ;


    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());
            case FOOTER_VIEW_TYPE:
                return new HeaderOrFooterView(footerView.get());
            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);
            }
        }
    }

    @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);
        }
    }
}

在寫完這個類的時候，我們基本已經完成了 RecyclerView 的 headerView 和 footerView的封裝了。

在最後讓我們預覽下最終的效果:

RecyclerView 添加headerView 和 footerView

headerView 和 footerView 已經成功添加進了。至此，我們已經完成了對 RecyclerView 進行簡單的封裝 headerView 和 footerView。

感謝大家的閱讀。如果發現本文了解的不對的地方，歡迎指出，一起學習，一起進步！

RecyclerView 添加headerView 和 footerView

繼續閱讀

專訪鄧凡平：深入了解Android

與專家面對面：Android開發入門問與答

Android MVP架構MVCMVP

mvp初探

Android常用工具類簡介目錄

android常用工具類轉載自：http://www.trinea.cn/android/android-common-utils/Android常用工具類

Android常用工具類ToastUtilsSizeUtilsLogUtilsRetrofitManagerAnimUtil

Android Studio 0.8.0解決 Failure [INSTALL_FAILED_OLDER_SDK] 問題

Android – ListView 中添加按鈕，動态删除添加ItemView的操作

Kotlin的ListView與RecyclerView的簡單應用

關于公司的那些坑：Android Studio篇

android SQLite事務和kotlin協程

無法正常編譯錯誤Compilation failed to complete

關于Gradle配置的小結

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Android APK檔案反編譯Android APK檔案反編譯