Android LRecyclerView

簡介

LRecyclerView是支持addHeaderView、 addFooterView、下拉刷新、分頁加載數據的RecyclerView。

它對 RecyclerView 控件進行了拓展，給RecyclerView增加HeaderView、FooterView，並且不需要對你的Adapter做任何修改。

主要功能

1. 下拉刷新、滑動到底部自動加載下頁數據；

2. 可以方便添加Header和Footer；

3. 頭部下拉樣式可以自定義；

4. 具備item點擊和長按事件。

5. 網絡錯誤加載失敗點擊Footer重新請求數據；

6. 可以動態爲FooterView賦予不同狀態（加載中、加載失敗、滑到最底等）。

項目地址：https://github.com/jdsjlzx/LRecyclerView

本開源控件是基於 HeaderAndFooterRecyclerView 開源項目而來，在原基礎上進行了擴充。在此感謝cundong作者（github地址：https://github.com/cundong）。

效果圖

Gradle

Step 1. 在你的根build.gradle文件中增加JitPack倉庫依賴。

allprojects {

    repositories {

        jcenter()

        maven { url "https://jitpack.io" }

    }

}

Step 2. 在你的model的build.gradle文件中增加LRecyclerView依賴。

compile 'com.github.jdsjlzx:LRecyclerView:1.0.0'

使用

添加HeaderView、FooterView

mDataAdapter = new DataAdapter(this);

        mDataAdapter.setData(dataList);

 

        mHeaderAndFooterRecyclerViewAdapter = new HeaderAndFooterRecyclerViewAdapter(this, mDataAdapter);

        mRecyclerView.setAdapter(mHeaderAndFooterRecyclerViewAdapter);

 

        mRecyclerView.setLayoutManager(new LinearLayoutManager(this));

 

        //add a HeaderView

        RecyclerViewUtils.setHeaderView(mRecyclerView, new SampleHeader(this));

 

        //add a FooterView

        RecyclerViewUtils.setFooterView(mRecyclerView, new SampleFooter(this));

注意：

mHeaderAndFooterRecyclerViewAdapter = new HeaderAndFooterRecyclerViewAdapter(this, mDataAdapter);

HeaderAndFooterRecyclerViewAdapter提供了一些實用的功能，使用者不用關心它的實現，只需構造的時候把自己的mDataAdapter以參數形式傳進去即可。

下拉刷新和加載更多

爲了大家使用方便，將需要用的方法統一封裝到接口LScrollListener中。

mRecyclerView.setLScrollListener(new LRecyclerView.LScrollListener() {

            @Override

            public void onRefresh() {

 

            }

 

            @Override

            public void onScrollUp() {

            }

 

            @Override

            public void onScrollDown() {

            }

 

            @Override

            public void onBottom() {

 

            }

 

            @Override

            public void onScrolled(int distanceX, int distanceY) {

            }

 

        });

LScrollListener實現了nRefresh()、onScrollUp()、onScrollDown()、onBottom()、onScrolled五個事件，如下所示：

void onRefresh();//pull down to refresh

void onScrollUp();//scroll down to up

void onScrollDown();//scroll from up to down

void onBottom();//load next page

void onScrolled(int distanceX, int distanceY);// moving state,you can get the move distance

• onRefresh()——RecyclerView下拉刷新事件；

• onScrollUp()——RecyclerView向上滑動的監聽事件；

• onScrollDown()——RecyclerView向下滑動的監聽事件；

• onBottom()——RecyclerView滑動到底部的監聽事件；

• onScrollDown()——RecyclerView正在滾動的監聽事件；

加載更多（加載下頁數據）

從上面的LScrollListener介紹中就可以看出，實現加載更多只要在onBottom()接口中處理即可。

下拉刷新

爲了達到和Listview的下拉刷新效果，本項目沒有藉助SwipeRefreshLayout控件，而是在自定義RecyclerView頭部實現的刷新效果。

這裏的下拉刷新效果借鑑了開源庫：AVLoadingIndicatorView

設置加載樣式：

mRecyclerView.setRefreshProgressStyle(ProgressStyle.BallSpinFadeLoader);

mRecyclerView.setArrowImageView(R.drawable.iconfont_downgrey);

AVLoadingIndicatorView庫有多少效果，LRecyclerView就支持多少下拉刷新效果，當然你也可以自定義下拉效果。

效果圖：

下拉刷新邏輯處理：

從上面的LScrollListener介紹中就可以看出，實現下拉刷新只要在onRefresh()接口中處理即可。

加載網絡異常處理

加載數據時如果網絡異常或者斷網，LRecyclerView爲你提供了重新加載的機制。

效果圖：

網絡異常出錯代碼處理如下：

RecyclerViewStateUtils.setFooterViewState(getActivity(), mRecyclerView, getPageSize(), LoadingFooter.State.NetWorkError, mFooterClick);

 

private View.OnClickListener mFooterClick = new View.OnClickListener() {

        @Override

        public void onClick(View v) {

            RecyclerViewStateUtils.setFooterViewState(getActivity(), mRecyclerView, getPageSize(), LoadingFooter.State.Loading, null);

            requestData();

        }

    };

上面的mFooterClick就是我們點擊底部的Footer時的邏輯處理事件，很顯然我們還是在這裏做重新請求數據操作。

點擊事件和長按事件處理

在Hongyang前輩的博客中有下描述：

Click and LongClick

不過一個挺鬱悶的地方就是，系統沒有提供ClickListener和LongClickListener。

不過我們也可以自己去添加，只是會多了些代碼而已。

實現的方式比較多，你可以通過mRecyclerView.addOnItemTouchListener去監聽然後去判斷手勢， 當然你也可以通過adapter中自己去提供回調，這裏我們選擇後者，前者的方式，大家有興趣自己去實現。

出自：http://blog.csdn.net/lmj623565791/article/details/45059587

Hongyang大神選擇了後者，LRecyclerView早期選擇了前者，經過實踐總結，在adapter中實現點擊事件會好點。

先看下怎麼使用：

mHeaderAndFooterRecyclerViewAdapter.setOnItemClickLitener(new OnItemClickLitener() {

            @Override

            public void onItemClick(View view, int position) {

 

            }

 

            @Override

            public void onItemLongClick(View view, int position) {

 

            }

        });

原理就是實現viewHolder.itemView的點擊和長按事件。由於代碼過多就不貼出來了。

viewHolder.itemView是RecyclerView.Adapter中本身就具有的，不用額外定義。

源碼如下：

public static abstract class ViewHolder {

        public final View itemView;

        int mPosition = NO_POSITION;

        int mOldPosition = NO_POSITION;

        long mItemId = NO_ID;

        int mItemViewType = INVALID_TYPE;

        int mPreLayoutPosition = NO_POSITION;

設置空白View（setEmptyView）

mRecyclerView.setEmptyView(view);

注意佈局文件：

<RelativeLayout

    xmlns:android="http://schemas.android.com/apk/res/android"

    android:layout_width="match_parent"

    android:layout_height="match_parent"

    >

 

    <com.cundong.recyclerview.LRecyclerView

        android:id="@+id/list"

        android:layout_width="fill_parent"

        android:layout_height="fill_parent"/>

 

    <include

        android:id="@+id/empty_view"

        layout="@layout/layout_empty"

        android:visibility="gone"/>

</RelativeLayout>

分享

介紹完了LRecyclerView，似乎還少些什麼，對了，那就是adapter了。

爲了方便大家使用，分享個封裝過的adapter。

public class ListBaseAdapter<T extends Entity> extends RecyclerView.Adapter {

    protected Context mContext;

    protected int mScreenWidth;

 

    public void setScreenWidth(int width) {

        mScreenWidth = width;

    }

 

    protected ArrayList<T> mDataList = new ArrayList<>();

 

    @Override

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

        return null;

    }

 

    @Override

    public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {

 

    }

 

    @Override

    public int getItemCount() {

        return mDataList.size();

    }

 

    public List<T> getDataList() {

        return mDataList;

    }

 

    public void setDataList(Collection<T> list) {

        this.mDataList.clear();

        this.mDataList.addAll(list);

        notifyDataSetChanged();

    }

 

    public void addAll(Collection<T> list) {

        int lastIndex = this.mDataList.size();

        if (this.mDataList.addAll(list)) {

            notifyItemRangeInserted(lastIndex, list.size());

        }

    }

 

    public void clear() {

        mDataList.clear();

        notifyDataSetChanged();

    }

}

ListBaseAdapter使用了泛型，簡單方便，消除了強制類型轉換。

使用如下：

private class DataAdapter extends ListBaseAdapter<ItemModel>{

 

        private LayoutInflater mLayoutInflater;

 

        public DataAdapter(Context context) {

            mLayoutInflater = LayoutInflater.from(context);

            mContext = context;

        }

 

        @Override

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

            return new ViewHolder(mLayoutInflater.inflate(R.layout.sample_item_text, parent, false));

        }

 

        @Override

        public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {

            ItemModel item = mDataList.get(position);

 

            ViewHolder viewHolder = (ViewHolder) holder;

            viewHolder.textView.setText(item.title);

        }

 

 

        private class ViewHolder extends RecyclerView.ViewHolder {

 

            private TextView textView;

 

            public ViewHolder(View itemView) {

                super(itemView);

                textView = (TextView) itemView.findViewById(R.id.info_text);

            }

        }

    }

ListBaseAdapter雖然功能不強大，但是使用很方便。

結語

LRecyclerView使用方便簡單，無論你添加多少Header和Footer，你都不用擔心position的問題，除了方便還是方便。

最後再介紹下項目地址：https://github.com/jdsjlzx/LRecyclerView

如果覺得上面的例子UI簡單，這裏再分享個項目：https://github.com/jdsjlzx/Community