RecyclerView 源码解析：自定义 LayoutManager 的正确姿势

2024-02-09 19:59:14

在上一篇文章中，我们对 RecyclerView 的 LayoutManager 进行了一番详细的解析，相信大家对 LayoutManager 有了一定的了解。在这篇文章中，我们主要来探讨如何自定义 LayoutManager。

自定义 LayoutManager 可以让你创建出拥有独特布局方式的 RecyclerView，这对于开发一些特殊需求的 App 是非常有用的。例如，你可以创建一个瀑布流布局的 RecyclerView，也可以创建一个网格布局的 RecyclerView，甚至可以创建一个环形布局的 RecyclerView。

自定义 LayoutManager 的步骤大致如下：

创建一个继承自 RecyclerView.LayoutManager 的类。
重写 LayoutManager 中的几个关键方法，如 onLayoutChildren()、canScrollHorizontally() 和 canScrollVertically() 等。
在 RecyclerView 中使用你的自定义 LayoutManager。

在重写 LayoutManager 中的关键方法时，你需要考虑以下几点：

子 View 的排列方式： 你需要决定子 View 在 RecyclerView 中是如何排列的。例如，瀑布流布局的子 View 是垂直排列的，网格布局的子 View 是水平排列的。
子 View 的大小： 你需要决定每个子 View的大小。例如，瀑布流布局的子 View 可以有不同的高度，网格布局的子 View 必须具有相同的宽度和高度。
子 View 的位置： 你需要决定每个子 View的位置。例如，瀑布流布局的子 View 可以位于任意位置，网格布局的子 View 必须位于网格的单元格中。

为了帮助大家更好地理解如何自定义 LayoutManager，这里提供一些自定义 LayoutManager 的示例代码：

瀑布流布局：

public class WaterfallLayoutManager extends RecyclerView.LayoutManager {

    private int mColumnCount; // 列数
    private int mColumnWidth; // 列宽
    private int mColumnHeight; // 列高
    private List<Integer> mColumnHeights; // 列高列表

    public WaterfallLayoutManager(int columnCount) {
        this.mColumnCount = columnCount;
    }

    @Override
    public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
        // 计算列宽和列高
        mColumnWidth = getWidth() / mColumnCount;
        mColumnHeight = 0;
        mColumnHeights = new ArrayList<>();
        for (int i = 0; i < mColumnCount; i++) {
            mColumnHeights.add(0);
        }

        // 布置子 View
        for (int i = 0; i < state.getItemCount(); i++) {
            View child = recycler.getViewForPosition(i);
            int childWidth = mColumnWidth;
            int childHeight = child.getMeasuredHeight();

            // 找到高度最小的列
            int minColumnHeight = Collections.min(mColumnHeights);
            int minColumnIndex = mColumnHeights.indexOf(minColumnHeight);

            // 将子 View 添加到最小高度的列中
            mColumnHeights.set(minColumnIndex, minColumnHeight + childHeight);
            child.layout(minColumnIndex * mColumnWidth, minColumnHeight,
                    minColumnIndex * mColumnWidth + childWidth, minColumnHeight + childHeight);
        }
    }

    @Override
    public boolean canScrollHorizontally() {
        return false;
    }

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

网格布局：

public class GridLayoutManager extends RecyclerView.LayoutManager {

    private int mColumnCount; // 列数
    private int mItemWidth; // 项目宽度
    private int mItemHeight; // 项目高度

    public GridLayoutManager(int columnCount) {
        this.mColumnCount = columnCount;
    }

    @Override
    public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
        // 计算项目宽度和高度
        mItemWidth = getWidth() / mColumnCount;
        mItemHeight = mItemWidth;

        // 布置项目
        for (int i = 0; i < state.getItemCount(); i++) {
            View child = recycler.getViewForPosition(i);

            // 计算项目的位置
            int columnIndex = i % mColumnCount;
            int rowIndex = i / mColumnCount;

            // 将项目添加到网格中
            child.layout(columnIndex * mItemWidth, rowIndex * mItemHeight,
                    columnIndex * mItemWidth + mItemWidth, rowIndex * mItemHeight + mItemHeight);
        }
    }

    @Override
    public boolean canScrollHorizontally() {
        return false;
    }

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

环形布局：

public class CircleLayoutManager extends RecyclerView.LayoutManager {

    private int mRadius; // 半径
    private int mItemWidth; // 项目宽度
    private int mItemHeight; // 项目高度

    public CircleLayoutManager(int radius) {
        this.mRadius = radius;
    }

    @Override
    public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
        // 计算项目宽度和高度
        mItemWidth = getWidth() / 2;
        mItemHeight = mItemWidth;

        // 布置项目
        for (int i = 0; i < state.getItemCount(); i++) {
            View child = recycler.getViewForPosition(i);

            // 计算项目的位置
            double angle = Math.PI * 2 * i / state.getItemCount();
            int x = (int) (mRadius * Math.cos(angle));
            int y = (int) (mRadius * Math.sin(angle));

            // 将项目添加到环形布局中
            child.layout(x - mItemWidth / 2, y - mItemHeight / 2,
                    x + mItemWidth / 2, y + mItemHeight / 2);
        }
    }

    @Override
    public boolean canScrollHorizontally() {
        return false;
    }

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