1. 程式人生 > >Android RecyclerView瀑布流佈局新增Footer實現上拉載入

Android RecyclerView瀑布流佈局新增Footer實現上拉載入

這篇文章應該是晚到了好幾個月,之前想寫,但是中途遇到了一些棘手的問題,無奈沒有去寫。寫這篇文章的最初來源是一個朋友問我在Android中如何實現瀑布流佈局?,當時我的回答是使用RecyclerView,後來他又問我那怎麼實現上拉載入並新增Footer呢?我想都沒想就回答他根據type的不同去新增一個Footer,監聽滾動事件,當滑動到最後顯示footer並回調對應的介面,那麼,這個過程就會遇到一個Footer佈局顯示的問題,就像下面這張圖一樣。

瀑布流佈局

可以看到,我們 的 Footer佈局並沒有佔據全屏,而是作為瀑布流佈局的一部分了。這顯然不是我們想要的。

當然,除了為瀑布流佈局新增Footer實現上拉載入外,我們還想要對GridLayout新增Footer實現上拉載入,同樣的,在GridLayout中,佈局也不是我們想要的結果。效果也是這樣。

網格佈局

也把我們的Footer作為了GridLayout的一部分,並沒有全屏進行顯示。

那麼接下來,我們需要解決幾個問題,即可以實現正確的新增Footer並實現上拉載入功能了。

  • 如何實現上拉載入更多?這個解決方法很簡單,就是為RecyclerView新增滾動監聽事件,根據佈局的不同編寫對應的邏輯程式碼,實現滑到到底部載入更多的功能。
  • 如何正確的新增Footer,使其能夠佔據寬度為全屏顯示?這個有點棘手,但是並不是不能解決,我們需要對介面卡進行一些處理就能實現該功能。
  • 此外我們還想要新增一個Header,用於展示ViewPager或者圖片等資訊。這個原理和新增Footer是一樣的。

首先定義一個處理上拉載入的介面

public interface OnLoadMoreListener<T> {
    /**
     * 載入更多前回調,比如顯示Footer的操作
     */
    void onStart();

    /**
     * 載入更多業務處理,如網路請求資料
     */
    void onLoadMore();

    /**
     * 由於onLoadMore可能是非同步呼叫的,所以onFinish需要手動呼叫,完成資料的重新整理,隱藏Footer等
     * @param list onLoadMore中返回的資料
     */
    void onFinish(List<T> list);
}

然後我們自己定義一個抽象類,用於繼承RecyclerView.OnScrollListener並實現我們定義的介面OnLoadMoreListener,如果需要上拉載入更多,直接為RecyclerView新增滾動監聽為我們的實現類即可,就像這樣子

mRecyclerView.addOnScrollListener(new OnRecyclerViewScrollListener<Content>(){
            @Override
            public void onStart() {

            }

            @Override
            public void onLoadMore() {

            }

            @Override
            public void onFinish(List<Content> contents) {

            }
        });

由於RecyclerView預設有三種佈局,所以我們要對這三種佈局分別進行判斷上拉載入,處理的邏輯有點不同,首先新增如下定義

public abstract class OnRecyclerViewScrollListener<T extends RecyclerViewAdapter.Item> extends RecyclerView.OnScrollListener implements OnLoadMoreListener<T> {

    public static enum layoutManagerType {
        LINEAR_LAYOUT,
        GRID_LAYOUT,
        STAGGERED_GRID_LAYOUT
    }
    protected layoutManagerType mLayoutManagerType;

    private boolean mIsLoadingMore = false;

    public boolean isLoadingMore() {
        return mIsLoadingMore;
    }

    public void setLoadingMore(boolean loadingMore) {
        mIsLoadingMore = loadingMore;
    }

}

這個類是泛型的,接收一個實現了Item介面的類。主要是定義了一個列舉類,裡面是佈局的型別,然後是一個布林變數,用於判斷當前是否正在載入更多。

RecyclerViewAdapter.Item主要是一個介面,其定義如下

    public interface Item {
        int TYPE_HEADER = 0;
        int TYPE_FOOTER = 1;
        /**
         * 返回item型別,其值不能為0或者1;
         *
         * @return
         */
        int getType();
    }

我們的RecyclerView的Item實體類需要實現Item介面,並返還item的型別,預設情況下header的型別為0,footer的型別為1。

接下來最重要的事就是實現onScrolledonScrollStateChanged方法,根據佈局的不同判斷是否需要載入更多操作。

    private int[] lastPositions;
    private int lastVisibleItemPosition;
    private int currentScrollState = 0;

    @Override
    public void onScrolled(RecyclerView recyclerView, int dx, int dy) {
        super.onScrolled(recyclerView, dx, dy);

        RecyclerView.LayoutManager layoutManager = recyclerView.getLayoutManager();
        if (mLayoutManagerType == null) {
            if (layoutManager instanceof LinearLayoutManager) {
                mLayoutManagerType = layoutManagerType.LINEAR_LAYOUT;
            } else if (layoutManager instanceof GridLayoutManager) {
                mLayoutManagerType = layoutManagerType.GRID_LAYOUT;
            } else if (layoutManager instanceof StaggeredGridLayoutManager) {
                mLayoutManagerType = layoutManagerType.STAGGERED_GRID_LAYOUT;
            } else {
                throw new RuntimeException("Unsupported LayoutManager used. Valid ones are LinearLayoutManager, GridLayoutManager and StaggeredGridLayoutManager");
            }
        }

        switch (mLayoutManagerType) {
            case LINEAR_LAYOUT:
                lastVisibleItemPosition = ((LinearLayoutManager) layoutManager).findLastVisibleItemPosition();
                break;
            case GRID_LAYOUT:
                lastVisibleItemPosition = ((GridLayoutManager) layoutManager).findLastVisibleItemPosition();
                break;
            case STAGGERED_GRID_LAYOUT:
                StaggeredGridLayoutManager staggeredGridLayoutManager = (StaggeredGridLayoutManager) layoutManager;
                if (lastPositions == null) {
                    lastPositions = new int[staggeredGridLayoutManager.getSpanCount()];
                }
                staggeredGridLayoutManager.findLastVisibleItemPositions(lastPositions);
                lastVisibleItemPosition = findMax(lastPositions);
                break;
            default:
                break;
        }
    }

    @Override
    public void onScrollStateChanged(RecyclerView recyclerView, int newState) {
        super.onScrollStateChanged(recyclerView, newState);
        currentScrollState = newState;
        RecyclerView.LayoutManager layoutManager = recyclerView.getLayoutManager();
        int visibleItemCount = layoutManager.getChildCount();
        int totalItemCount = layoutManager.getItemCount();
        if (visibleItemCount > 0 && currentScrollState == RecyclerView.SCROLL_STATE_IDLE
                && lastVisibleItemPosition >= totalItemCount - 1) {
            if (!isLoadingMore()){
                mIsLoadingMore =true;
                onStart();
                onLoadMore();
            }
        }
    }

    private int findMax(int[] lastPositions) {
        int max = lastPositions[0];
        for (int value : lastPositions) {
            if (value > max) {
                max = value;
            }
        }
        return max;
    }

具體邏輯見程式碼,LinearLayoutManager 和 GridLayoutManager的處理邏輯類似,只不過StaggeredGridLayoutManager 的處理稍微複雜一點,因為佈局是錯亂的,所以需要自己找到最底下的佈局是哪一個,關鍵程式碼就是這兩句

staggeredGridLayoutManager.findLastVisibleItemPositions(lastPositions);
lastVisibleItemPosition = findMax(lastPositions);

就這樣子,其實已經出現了上拉載入更多的功能了,這時候你使用一下這個滾動監聽,是完全沒有什麼問題的,只不過沒有顯示Footer佈局而已。接下來我們最重要的事就是改造介面卡。

public abstract class RecyclerViewAdapter<T extends RecyclerViewAdapter.Item> extends RecyclerView.Adapter<RecyclerView.ViewHolder> {
    public interface Item {
        int TYPE_HEADER = 0;
        int TYPE_FOOTER = 1;
        /**
         * 返回item型別,其值不能為0或者1;
         *
         * @return
         */
        int getType();
    }
}

這是最基本的結構,內部定義了上面提到的Item介面,我們的Item實體類需要實現該介面,用於判斷Item的型別。

定義Getter和Setter方法

    protected List<T> list = null;
    protected int headerViewRes;
    protected int footerViewRes;
    protected boolean hasHeader = false;
    protected boolean hasFooter = false;


    public List<T> getList() {
        return list;
    }

    public void setList(List<T> list) {
        this.list = list;
    }

    public boolean isHeader(int position) {
        return hasHeader() && position == 0;
    }

    public boolean isFooter(int position) {
        if(hasHeader()){
            return hasFooter() && position == list.size() + 1;
        }else {
            return hasFooter() && position == list.size();
        }
    }

    public int getHeaderView() {
        return headerViewRes;
    }

    public int getFooterView() {
        return footerViewRes;
    }

    public void setHeaderView(int headerViewRes) {

        if (headerViewRes != 0) {
            if (!hasHeader()){
                this.headerViewRes = headerViewRes;
                this.hasHeader = true;
                notifyItemInserted(0);
            }else{
                this.headerViewRes = headerViewRes;
                notifyDataSetChanged();
            }

        } else {
            if (hasHeader()){
                this.hasHeader = false;
                notifyItemRemoved(0);
            }

        }

    }

    public void setFooterView(int footerViewRes) {
        if (footerViewRes != 0) {
            if (!hasFooter()){
                this.footerViewRes = footerViewRes;
                this.hasFooter = true;
                if (hasHeader()){
                    notifyItemInserted(list.size()+1);
                }else{
                    notifyItemInserted(list.size());
                }
            }else{
                this.footerViewRes = footerViewRes;
                notifyDataSetChanged();
            }

        } else {
            if(hasFooter()){
                this.hasFooter = false;
                if (hasHeader()){
                    notifyItemRemoved(list.size()+1);
                }else{
                    notifyItemRemoved(list.size());
                }

            }

        }

    }

    public boolean hasHeader() {
        return hasHeader;
    }

    public boolean hasFooter() {
        return hasFooter;
    }

內部邏輯看上去一大堆,其實並不複雜,關鍵是需要判斷Header存不存在,Header存在與不存在的情況下Footer的位置是不同的,注意這一點,編寫對應的邏輯即可,當然你的邏輯可以與我不同。

接下來是建構函式,傳入我們的資料集,Header和Footer的佈局資源

    public RecyclerViewAdapter(List<T> list) {
        this.list = list;
    }

    public RecyclerViewAdapter(List<T> list, int headerViewRes) {
        this.list = list;
        setHeaderView(headerViewRes);
    }

    public RecyclerViewAdapter(List<T> list, int headerViewRes, int footerViewRes) {
        this.list = list;
        setHeaderView(headerViewRes);
        setFooterView(footerViewRes);
    }

實現我們的Header佈局和Footer佈局的ViewHolder,其實就是定義兩個類

    static class HeaderViewHolder extends RecyclerView.ViewHolder {
        public HeaderViewHolder(View itemView) {
            super(itemView);
        }
    }

    static class FooterViewHolder extends RecyclerView.ViewHolder {
        public FooterViewHolder(View itemView) {
            super(itemView);
        }
    }

重寫getItemCountgetItemViewType方法

getItemCount中我們需要根據是否有Header和Footer來返回對應的Item數

  @Override
    public int getItemCount() {
        int count = 0;
        count += (hasHeader() ? 1 : 0);
        count += (hasFooter() ? 1 : 0);
        count += list.size();
        return count;
    }

getItemViewType就需要根據判斷位置判斷是否具有Header來判斷對應的Item的型別

 @Override
    public int getItemViewType(int position) {
        int size = list.size();
        if (hasHeader()) {
            if (position == 0) {
                return Item.TYPE_HEADER;
            } else {
                if (position == size + 1) {
                    return Item.TYPE_FOOTER;
                } else {
                    return list.get(position - 1).getType();
                }
            }

        } else {
            if (position == size) {
                return Item.TYPE_FOOTER;
            } else {
                return list.get(position).getType();
            }
        }
    }

建立ViewHolder,根據型別的不同建立對應的ViewHolder,如果不是Header和Footer之外的型別,交由抽象方法onCreateHolder處理


    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        if (hasHeader() && viewType == Item.TYPE_HEADER) {
            View v = LayoutInflater.from(parent.getContext()).inflate(getHeaderView(), parent, false);
            return new HeaderViewHolder(v);
        } else if (hasFooter() && viewType == Item.TYPE_FOOTER) {
            View v = LayoutInflater.from(parent.getContext()).inflate(getFooterView(), parent, false);
            return new FooterViewHolder(v);
        } else {
            return onCreateHolder(parent, viewType);
        }
    }
    public abstract RecyclerView.ViewHolder onCreateHolder(ViewGroup parent, int viewType);

繫結資料,同建立ViewHolder,根據位置的不同來獲得item的型別,如果是Header就回調抽象方法onBindHeaderView,如果是Footer就回調抽象方法onBindFooterView,否則就回調抽象方法onBindItemView,將對應的holder和實體類傳入。

 @Override
    public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {
        if (getItemViewType(position) == Item.TYPE_HEADER) {
            HeaderViewHolder headerHolder = (HeaderViewHolder) holder;
            View headerView = headerHolder.itemView;

            onBindHeaderView(headerView);
        } else if (getItemViewType(position) == Item.TYPE_FOOTER) {
            FooterViewHolder footerHolder = (FooterViewHolder) holder;
            View footerView = footerHolder.itemView;

            onBindFooterView(footerView);
        } else {
            T i = getItemByPosition(position);
            onBindItemView(holder, i);

        }

    }
    protected abstract void onBindHeaderView(View headerView);

    protected abstract void onBindFooterView(View footerView);

    protected abstract void onBindItemView(RecyclerView.ViewHolder holder, T item);

這樣子,已經能夠處理Header和Footer了,但是顯示位置還是不正確的,接下來我們需要對GridLayout和StaggeredGridLayout做特殊處理。

定義抽象類GridLayoutAdapter繼承RecyclerViewAdapter

public abstract class GridLayoutAdapter<T extends RecyclerViewAdapter.Item> extends RecyclerViewAdapter<T> {
    public GridLayoutAdapter(List list) {
        super(list);
    }
    public GridLayoutAdapter(List list, int headerViewRes) {
        super(list, headerViewRes);
    }

    public GridLayoutAdapter(List list, int headerViewRes, int footerViewRes) {
        super(list, headerViewRes, footerViewRes);
    }
}

定義一個內部類GridSpanSizeLookup 繼承GridLayoutManager.SpanSizeLookup,呼叫父類isHeader和isFooter方法判斷是否是頭或者尾,如果是則返回gridManager.getSpanCount();即一個item佔據一行的span數,否則就返回1


    class GridSpanSizeLookup extends GridLayoutManager.SpanSizeLookup {
        @Override
        public int getSpanSize(int position) {
            if (isHeader(position) || isFooter(position)) {
                return gridManager.getSpanCount();
            }
            return 1;
        }
    }

最重要的一步就是重寫onAttachedToRecyclerView,判斷是否是GridLayout佈局,然後通過setSpanSizeLookup設定為我們的內部類

    private GridSpanSizeLookup mGridSpanSizeLookup;
    private GridLayoutManager gridManager;
    @Override
    public void onAttachedToRecyclerView(RecyclerView recyclerView) {
        super.onAttachedToRecyclerView(recyclerView);
        RecyclerView.LayoutManager manager = recyclerView.getLayoutManager();
        if (manager instanceof GridLayoutManager) {
            gridManager = ((GridLayoutManager) manager);
            if (mGridSpanSizeLookup == null) {
                mGridSpanSizeLookup = new GridSpanSizeLookup();
            }
            gridManager.setSpanSizeLookup(mGridSpanSizeLookup);
        }
    }

同理,瀑布流佈局也需要進行同樣的操作。

public abstract class StaggeredGridLayoutAdapter<T extends RecyclerViewAdapter.Item> extends RecyclerViewAdapter<T> {
    public StaggeredGridLayoutAdapter(List<T> list) {
        super(list);
    }

    public StaggeredGridLayoutAdapter(List<T> list, int headerViewRes) {
        super(list, headerViewRes);
    }

    public StaggeredGridLayoutAdapter(List<T> list, int headerViewRes, int footerViewRes) {
        super(list, headerViewRes, footerViewRes);
    }
}

但是 StaggeredGridLayoutManager中沒有setSpanSizeLookup方法,慶幸的是StaggeredGridLayoutManager.LayoutParams中有setFullSpan方法可以達到同樣的效果。

這時候重寫的不再是onAttachedToRecyclerView方法而是onViewAttachedToWindow方法

  @Override
    public void onViewAttachedToWindow(RecyclerView.ViewHolder holder) {
        super.onViewAttachedToWindow(holder);
        if (isStaggeredGridLayout(holder)) {
            handleLayoutIfStaggeredGridLayout(holder, holder.getLayoutPosition());
        }
    }

    private boolean isStaggeredGridLayout(RecyclerView.ViewHolder holder) {
        ViewGroup.LayoutParams layoutParams = holder.itemView.getLayoutParams();
        if (layoutParams != null && layoutParams instanceof StaggeredGridLayoutManager.LayoutParams) {
            return true;
        }
        return false;
    }

    protected void handleLayoutIfStaggeredGridLayout(RecyclerView.ViewHolder holder, int position) {
        if (isHeader(position) || isFooter(position)) {
            StaggeredGridLayoutManager.LayoutParams p = (StaggeredGridLayoutManager.LayoutParams) holder.itemView.getLayoutParams();
            p.setFullSpan(true);
        }
    }

基本上,到這裡為止,就完成了所有的工作,在使用的時候要實現上拉載入顯示Footer,如果是瀑布流佈局,就需要繼承StaggeredGridLayoutAdapter,如果是網格佈局,就需要繼承GridLayoutAdapter,其他情況下,繼承RecyclerViewAdapter即可。

為了演示,這裡簡單進行使用,首先定義一個Item的實現類

public class Content implements RecyclerViewAdapter.Item {
    private int TYPE = 2;
    private String title;
    private String desc;
    private String url;

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }

    public String getIconUrl() {
        return url;
    }

    public void setIconUrl(String iconUrl) {
        this.url = iconUrl;
    }

    @Override
    public String toString() {
        return "Content{" +
                "title='" + title + '\'' +
                ", desc='" + desc + '\'' +
                ", icon=" + url +
                '}';
    }

    @Override
    public int getType() {
        return TYPE;
    }
}

我們這裡以瀑布流佈局為例,因此繼承StaggeredGridLayoutAdapter實現我們的介面卡。

public class MyAdapter extends StaggeredGridLayoutAdapter<Content> {


    public MyAdapter(List<Content> list, int headerViewRes) {
        super(list, headerViewRes);
    }

    public MyAdapter(List<Content> list) {
        super(list);
    }

    public MyAdapter(List<Content> list, int headerViewRes, int footerViewRes) {
        super(list, headerViewRes, footerViewRes);
    }

    @Override
    public RecyclerView.ViewHolder onCreateHolder(ViewGroup parent, int viewType) {
        View view=LayoutInflater.from(parent.getContext()).inflate(R.layout.item_content,parent,false);
        return new ItemViewHolder(view);
    }

    @Override
    protected void onBindHeaderView(View headerView) {
        Log.e("TAG","這是HeadView資料繫結的過程");
        ImageView imageView= (ImageView) headerView.findViewById(R.id.icon);
        Picasso.with(headerView.getContext()).load("http://img.my.csdn.net/uploads/201508/05/1438760758_3497.jpg").into(imageView);
    }

    @Override
    protected void onBindFooterView(View footerView) {
        Log.e("TAG","這是FootView資料繫結的過程");
    }


    @Override
    protected void onBindItemView(RecyclerView.ViewHolder holder, Content item) {
        ItemViewHolder itemViewHolder = (ItemViewHolder) holder;
        Picasso.with(holder.itemView.getContext()).load(item.getIconUrl()).into( itemViewHolder.icon);
        itemViewHolder.title.setText(item.getTitle());
        itemViewHolder.desc.setText(item.getDesc());
    }


    static class ItemViewHolder extends RecyclerView.ViewHolder {
        ImageView icon;
        TextView title;
        TextView desc;
        public ItemViewHolder(View itemView) {
            super(itemView);
            icon = (ImageView) itemView.findViewById(R.id.icon);
            title = (TextView) itemView.findViewById(R.id.title);
            desc = (TextView) itemView.findViewById(R.id.desc);
        }
    }
}

使用也很簡單,在onStart中顯示footer,在onLoadMore中載入資料,這裡是模擬操作,非同步返回資料後將資料傳入onFinish進行回撥,回撥完成後記得呼叫 setLoadingMore(false);來通知當前處於沒在載入的狀態,通過Handler傳送資料到主執行緒進行UI更新,並因此Footer

  public class MainActivity extends AppCompatActivity {
    private RecyclerView mRecyclerView;
    private List<Content> list = new ArrayList<Content>();
    private RecyclerViewAdapter<Content> myAdapter;
    private  ArrayList<Content> arrayList;
    Handler mHandler=new Handler(){
        @Override
        public void handleMessage(Message msg) {
            super.handleMessage(msg);
            List<Content> list= (List<Content>) msg.obj;
            myAdapter.getList().addAll(list);
            myAdapter.notifyDataSetChanged();
            myAdapter.setFooterView(0);
        }
    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        mRecyclerView = (RecyclerView) findViewById(R.id.recyclerview);

        initData();


        //mRecyclerView.setLayoutManager(new LinearLayoutManager(this,LinearLayoutManager.VERTICAL,false));
        mRecyclerView.setLayoutManager(new GridLayoutManager(this,2));
       // mRecyclerView.setLayoutManager(new StaggeredGridLayoutManager(2,StaggeredGridLayoutManager.VERTICAL));
        myAdapter = new MyAdapter(list);
        //myAdapter.setHeaderView(R.layout.item_header);
        //myAdapter.setFooterView(R.layo