自定义LayoutManager

本文转自RecyclerView系列之三自定义LayoutManager

LayoutManager主要用于布局其中的item，在LayoutManager中能够对每个item的大小、位置进行更改，将它放到指定的位置上，在很多优秀的效果中，都是通过自定义LayoutManager实现的。

20181121103142295.gif

下面先来看下如何自定义LinearLayoutManager。

1、初始化展示界面

1.1、自定义CustomLinearLayoutManager

public class CustomLinearLayoutManager extends LayoutManager {
    @Override
    public LayoutParams generateDefaultLayoutParams() {
        return null;
    }
}

继承LayoutManager会强制让我们实现generateDefaultLayoutParams()方法。该方法主要用于设置RecyclerView中item的LayoutParams。

当在onCreateViewHolder方法中通过LayoutInflater.inflate(resource, root,attachToRoot)加载布局时root传入为null时item的LayoutParams为null，此时generateDefaultLayoutParams()生成的LayoutParams就派上用场了。

一般来说没有什么特殊的情况下，让子item自己决定宽高，故设置为wrap_content。

public class CustomLayoutManager extends LayoutManager {
    @Override
    public LayoutParams generateDefaultLayoutParams() {
        return new RecyclerView.LayoutParams(RecyclerView.LayoutParams.WRAP_CONTENT,
                RecyclerView.LayoutParams.WRAP_CONTENT);
    }
}

这样自定义LayoutManager就完成了吗，运行一下你会发现，啥也不显示。这又是为啥呢？前面我们就说了LayoutManager主要负责item的布局，而上面代码中并未对item布局进行布局。

1.2、onLayoutManager

在LayoutManager中，item的布局是在onLayoutManager中完成的。

@Override
public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
    //定义竖直方向的偏移量
    int offsetY = 0;
    for (int i = 0; i < getItemCount(); i++) {
        View view = recycler.getViewForPosition(i);
        addView(view);
        measureChildWithMargins(view, 0, 0);
        int width = getDecoratedMeasuredWidth(view);
        int height = getDecoratedMeasuredHeight(view);
        layoutDecorated(view, 0, offsetY, width, offsetY + height);
        offsetY += height;
    }
}

上面方法中主要做了两件事：

• 1、将所有的item添加进来

//从缓存中取出合适的View，如果缓存中没有则通过onCreateViewHolder创建
 View view = recycler.getViewForPosition(i);
   //添加View
 addView(view);

• 2、对所有item进行布局

//添加View后，进行View测量
measureChildWithMargins(view, 0, 0);
//getDecoratedMeasuredWidth得到的是item+decoration总宽度
int width = getDecoratedMeasuredWidth(view);
//getDecoratedMeasuredHeight得到的是item+decoration总高度
int height = getDecoratedMeasuredHeight(view);
//布局item
layoutDecorated(view, 0, offsetY, width, offsetY + height);

再次运行就会发现可以显示界面了。

2、滚动逻辑

2.1、添加滚动效果

但是现在还不能滚动，如果要实现滚动，需要修改两个地方。

@Override
public boolean canScrollVertically() {
    return true;
}

@Override
public int scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state) {
    // 平移容器内的item
    offsetChildrenVertical(-dy);
    return dy;
}

• 1、重写canScrollVertically()返回true，表示竖直滚动，如果想实现水平滚动则需要重写canScrollHorizontally()并返回true。
• 2、方法scrollVerticallyBy()中接收参数dy表示每次竖直滚动的距离。当手指从下向上滑动时：dy>0，手指从上向下滑动时：dy<0。当手指向上滑动时，RecyclerView中item应该也跟着手指向上移动，所以在调用offsetChildrenVertical(-dy)方法实现item的平移时，应传入-dy才合适。
  这样就完成了item的滚动，运行后发现有两个问题，当滚动到顶部和底部时，依然可以滚动，这显然是不对的，下面就看下如何进行边界的限制。

2.2、边界判断

现在我们就面临两个问题：如何判断滑动到了顶部和底部。

2.2.1、判断到顶部

将滑动过程中所有dy累加，如果小于0，表示已经滑动到了顶部，此时不让它移动即可。

private int mSumDy = 0;
@Override
public int scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state) {
    int travel = dy;
    //如果滑动到最顶部
    if (mSumDy + dy < 0) {
        travel = -mSumDy;
    }
    mSumDy += travel;
    // 平移容器内的item
    offsetChildrenVertical(-travel);
    return travel;
}

上面代码中，通过mSumDy累加所有滑动过的距离，如果当前滑动距离小于0，就让它移动到y=0的位置，mSumDy是之前移动过的距离，所以计算方法为：

travel+mSumDy=0，即travel = -mSumDy;

然后调用offsetChildrenVertical()将修正后的travel传入。

2.2.2、判断到底部

当向上滑动，在恰好滑动到底部时，滑动距离=所有item的高度和-RecyclerView的高度。当滑动的距离大于所有item的高度和-RecyclerView的高度时就说明已经滑动到了底部。

根据上面的分析，首先我们要得到所有item的高度和，在onLayoutChildren中我们会对每一个item进行测量并布局，在这里进行累加就可以算出总高度。

private int mTotalHeight = 0;
public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
    //定义竖直方向的偏移量
    int offsetY = 0;
    for (int i = 0; i < getItemCount(); i++) {
        View view = recycler.getViewForPosition(i);
        addView(view);
        measureChildWithMargins(view, 0, 0);
        int width = getDecoratedMeasuredWidth(view);
        int height = getDecoratedMeasuredHeight(view);
        layoutDecorated(view, 0, offsetY, width, offsetY + height);
        offsetY += height;
    }
    //如果所有子View的高度和没有填满RecyclerView的高度，
    // 则将高度设置为RecyclerView的高度
    mTotalHeight = Math.max(offsetY, getVerticalSpace());
}
private int getVerticalSpace() {
    return getHeight() - getPaddingBottom() - getPaddingTop();
}

getVerticalSpace()函数可以得到RecyclerView用于显示item的真实高度。而相比上面的onLayoutChildren，这里只添加了一句代码：mTotalHeight = Math.max(offsetY, getVerticalSpace());这里只所以取最offsetY和getVerticalSpace()的最大值是因为，offsetY是所有item的总高度，而当item填不满RecyclerView时，offsetY应该是比RecyclerView的真正高度小的，而此时的真正的高度应该是RecyclerView本身所设置的高度。
接下来就是在scrollVerticallyBy中判断到底并处理了：

public int scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state) {
    int travel = dy;
    //如果滑动到最顶部
    if (mSumDy + dy < 0) {
        travel = -mSumDy;
    } else if (mSumDy + dy > mTotalHeight - getVerticalSpace()) {
        travel = mTotalHeight - getVerticalSpace() - mSumDy;
    }

    mSumDy += travel;
    // 平移容器内的item
    offsetChildrenVertical(-travel);
    return dy;
}

当滑动偏移量大于 mTotalHeight - getVerticalSpace()时说明已经滑到了底部，所以此时需要对将要滑动的dy进行修正，使得满足

travel+mSumDy=mTotalHeight - getVerticalSpace();
即travel = mTotalHeight - getVerticalSpace() - mSumDy;

这样就完成了底部边界的问题的修复。下面贴出完整代码：

public class CustomLayoutManager extends LayoutManager {
    private int mSumDy = 0;
    private int mTotalHeight = 0;

    @Override
    public LayoutParams generateDefaultLayoutParams() {
        return new RecyclerView.LayoutParams(RecyclerView.LayoutParams.WRAP_CONTENT,
                RecyclerView.LayoutParams.WRAP_CONTENT);
    }

    @Override
    public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
        //定义竖直方向的偏移量
        int offsetY = 0;
        for (int i = 0; i < getItemCount(); i++) {
            View view = recycler.getViewForPosition(i);
            addView(view);
            measureChildWithMargins(view, 0, 0);
            int width = getDecoratedMeasuredWidth(view);
            int height = getDecoratedMeasuredHeight(view);
            layoutDecorated(view, 0, offsetY, width, offsetY + height);
            offsetY += height;
        }

        //如果所有子View的高度和没有填满RecyclerView的高度，
        // 则将高度设置为RecyclerView的高度
        mTotalHeight = Math.max(offsetY, getVerticalSpace());
    }

    private int getVerticalSpace() {
        return getHeight() - getPaddingBottom() - getPaddingTop();
    }

    @Override
    public boolean canScrollVertically() {
        return true;
    }
    
    @Override
    public int scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state) {
        int travel = dy;
        //如果滑动到最顶部
        if (mSumDy + dy < 0) {
            travel = -mSumDy;
        } else if (mSumDy + dy > mTotalHeight - getVerticalSpace()) {
        //如果滑动到最底部
            travel = mTotalHeight - getVerticalSpace() - mSumDy;
        }

        mSumDy += travel;
        // 平移容器内的item
        offsetChildrenVertical(-travel);
        return dy;
    }
}