文/yamda
谷歌在2014年6月26日的I/O 2014开发者大会上正式推出了Android L, 其中RecyclerView 也是在这次发布会上提出的。RecyclerView是一种新的视图组，目标是为任何基于适配器的视图提供相似的渲染方式。它被作为ListView和GridView控件的继承者。
用过ListView 和RecyclerView的朋友肯定会发现:
- RecyclerView 没有HeaderView 和 footerView。
- RecyclerView 没有 ItemClick事件。
- RecyclerView 没有 setEmptyView。
RecyclerView的优点也很明显：
- 强大的视图布局管理器。（可以使用横向、纵向、网格布局）
- 默认的ViewHolder重用机制。
- 强大的动画效果。(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() > 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类，这是一个数据观察者，在我们调用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 = 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 时候，说明现在应该返回headerView，而当 adjPosition 小于 adapterCount的时候 说明现在应该返回 被包装的adapter.getView()方法，其余的时候直接 返回footerView。在理解getView()方法后，
继续看getItemViewType()、getItemId()、getItem()等方法，发现他们实现的方式 和 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);
}
//数据观察者
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 / 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);
}
}
}
在写完这个类的时候， 我们基本已经完成了 RecyclerView 的 headerView 和 footerView的封装了。
在最后让我们预览下最终的效果:
headerView 和 footerView 已经成功添加进了。至此，我们已经完成了对 RecyclerView 进行简单的封装 headerView 和 footerView。
感谢大家的阅读。如果发现本文理解的不对的地方，欢迎指出，一起学习，一起进步！
更新：添加支持网格布局和瀑布流布局
