Android自定义LayoutManager实现表格，卡片显示效果

喜欢ヅ旅行 2022-06-02 12:19 634阅读 0赞

LayoutManager是RecyclerView的布局管理器，RecyclerView里面每个item的布局都依赖于LayoutManager的实现。Andorid系统给提供了三个LayoutManager布局管理器：LinearLayoutManager(线性布局管理器)、GridLayoutManager(网格布局管理器)、StaggeredGridLayoutManager(错列网格布局管理器)。大部分情况下这三个布局管理器都能满足我们的需求。但是，总有特殊情况的时候。有的时候UI设计师给的效果用系统自带的这三个布局管理器就是达不到。这个时候咱们就得根据实际需求自定义LayoutManager了，这也是我们接下来所要讨论的重点。

### 一、效果展示 ###

为了让大家在客观上有更好的感受，这里实现了两种效果：卡片式效果、表格式效果。效果如下：

![表格实现][SouthEast]

> 表格实现的功能：
> 
>  *  行数和列数不固定，可以随便多少个。
>  *  行数或者列数超过屏幕大小是可以上下左右全方位滑动。
>  *  支持设置固定第一行的功能，因为第一行经常是标题栏，在上下滑动的时候一直固定在顶部，大部分情况也许固定的效果更好点。
>  *  支持设置固定每一行的前面多少列，在左右滑动的时候一直固定左边。
>  *  支持设置除固定多少列之外，当总的列数小于这个设定值的时候。让剩下的列平分剩下的宽度。比如我们表格只有两列，我们可以设置让这两列平分屏幕的宽度。(＠2018.1.19)

![卡片式实现][SouthEast 1]

### 二、LayoutManager自定义 ###

对于自定义LayoutManager我们主要处理好三件事情，就所有的问题就都迎刃而解了:

*  布局每个ItemView
 *  处理滑动事件
 *  缓存重用ItemView

#### 2.1、LayoutManager自定义时常用函数介绍 ####

1.  布局每个ItemView

布局每个item需要重写的函数：

/** * 这里定义RecyclerView里面每个item默认的LayoutParams */
        @Override
        public RecyclerView.LayoutParams generateDefaultLayoutParams() {
            return new RecyclerView.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT);
        }
    
        /** * 重写这个函数来布局RecyclerView当前需要显示的item,确定每个item的位置 */
        @Override
        public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
            super.onLayoutChildren(recycler, state);
            //TODO:来布局RecyclerView当前需要显示的item
        }

>        generateDefaultLayoutParams和onLayoutChildren函数也是每个LayoutManager自定义的时候都必须重写的函数。

布局每个item常用API：

/** * 根据Adapter的位置position找RecyclerView中对应的item * 我们不管它是从scrap里取，还是从RecyclerViewPool里取，亦或是onCreateViewHolder里拿 * 系统已经帮我们处理好了缓存了 */
        View view = recycler.getViewForPosition(position);
    
        /** * 将item添加到RecyclerView当中去 */
        addView(item);
        addView(item, index);
    
        /** * 测量item,这个方法会考虑到View的ItemDecoration以及Margin */
        measureChildWithMargins(item, 0, 0);
    
        /** * 将item　layout布局出来，显示在屏幕上，内部会自动追加上该View的ItemDecoration和Margin * 这里就需要自己去控制显示的位置了 */
        layoutDecoratedWithMargins(item, 0, 0, 0, 0);

>        布局每个ItemView关键部分确定当前界面上需要显示的position对应的item，接着测量item，最后把item layout到指定的位置上。

1.  处理滑动事件

处理滑动需要重写的函数：

/** * 是否可以水平滑动 */
        @Override
        public boolean canScrollHorizontally() {
            return true;
        }
    
        /** * canScrollHorizontally返回true的基础上，RecyclerView有手指水平滑动的时候回调该函数 * 注意处理完之后要返回消费的距离 */
        @Override
        public int scrollHorizontallyBy(int dx, RecyclerView.Recycler recycler, RecyclerView.State state) {
            //TODO:滑动逻辑
            return dx;
        }
    
        /** * 是否可以垂直滑动 */
        @Override
        public boolean canScrollVertically() {
            return true;
        }
    
        /** * canScrollVertically返回true的基础上，RecyclerView有手指垂直滑动的时候回调该函数 * 注意处理完之后要返回消费的距离 */
        @Override
        public int scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state) {
            //TODO:滑动逻辑
            return dy;
        }

>        canScrollHorizontally和canScrollVertically是滑动的开关操作，只有开关打开了scrollHorizontallyBy()、scrollVerticallyBy()才会被回调，这样咱们就可以在里面处理滑动的逻辑了。在滑动的时候不管是重新去布局item，还是让item offset都可以。

处理滑动常用API：

/** * 垂直移动RecyclerView内所有的item */
        offsetChildrenVertical(-dy);
        /** * 垂直移动RecyclerView内所有的item */
        offsetChildrenHorizontal(-dx);

>        处理滑动事的关键之处是，在滑动过程中RecyclerView里面每个item的位置变化。

1.  缓存重用ItemView

常用API：

/** * detach轻量回收View */
        detachAndScrapAttachedViews(recycler);
        detachAndScrapView(view, recycler);
    
        /** * recycle真的回收一个View ，该View再次回来需要执行onBindViewHolder方法 */
        removeAndRecycleView(View child, Recycler recycler)
        removeAndRecycleAllViews(Recycler recycler);
    
        /** * 超级轻量回收一个View,马上就要添加回来,和attachView()对应 */
        detachView(view);
        /** * 将detachView(view)　detach的View attach回来 */
        attachView(view);
        /** * detachView 后 没有attachView的话 就要真的回收掉他们 */
        recycler.recycleView(viewCache.valueAt(i));

>        缓存重用ItemView的时候，只要你调用了合适的回收函数(detachAndScrapAttachedViews、detachAndScrapView)对应的View会自动回收到缓存机制里面去，当下次recycler.getViewForPosition(position)的时候会先检测缓存里面是否存在，如果存在则直接从缓存里面获取，如果不存在则执行Adapter的onBindViewHolder获取。

#### 2.２、LayoutManager自定义实例讲解 ####

前面讲了一大堆，都是为自定义LayoutManager实例做铺垫。咱得真刀真枪的用上来。接下来介绍两个自定义LayoutManager的思路：CardLayoutManager、TableLayoutManager。

##### 2.2.1、CardLayoutManager #####

![卡片式实现][SouthEast 1]

CardLayoutManager实现卡片式布局，RecyclerView里面所有的item从上往下依次叠在一起，同时为了看起来有层次感，越底下的item会我们稍微添加错位的效果。并且上层第一张卡片可以随手指的滑动删除。关于卡片随手指滑动删除效果通过ItemTouchHelper来实现，对于ItemTouchHelper的使用我们就不深究，有兴趣的可以参考[ItemTouchHelper源码分析][ItemTouchHelper]。我们重点在卡CardLayoutManager的实现。

我们需要通过CardLayoutManager来实现RecyclerView里面所有item叠在一起的效果。而且也不用去处理滑动的逻辑。所有关键部分在于重写onLayoutChildren()函数。

@Override
        public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
            super.onLayoutChildren(recycler, state);
            if (getItemCount() <= 0 || state.isPreLayout()) {
                return;
            }
            // 先移除所有view
            detachAndScrapAttachedViews(recycler);
            // 防止view过多产生oom情况，这里我们做了view最大个数的限制，因为没办法像别的LayoutManager那样通过item是否落在屏幕内判断是否回收
            int viewCount = getItemCount();
            if (getItemCount() > mShowViewMax) {
                viewCount = mShowViewMax;
            }
            //　这里要注意view要反着加，因为adapter position = 0对应的view我们要显示在最上层
            for (int position = viewCount - 1; position >= 0; position--) {
                // 获取到制定位置的view
                final View view = recycler.getViewForPosition(position);
                addView(view);
                // 测量view
                measureChildWithMargins(view, 0, 0);
                // view在RecyclerView里面还剩余的宽度
                int widthSpace = getWidth() - getDecoratedMeasuredWidth(view);
                // layout view,水平居中，靠上
                layoutDecoratedWithMargins(view, widthSpace / 2, 0, widthSpace / 2 + getDecoratedMeasuredWidth(view),
                                           getDecoratedMeasuredHeight(view));
                // 为了让重叠在一起的view，有一个更好的显示效果
                view.setScaleX(getScaleX(position));
                view.setScaleY(getScaleY(position));
                view.setTranslationX(getTranslationX(position));
                view.setTranslationY(getTranslationY(position));
            }
    
        }

看到里面的逻辑也很简单，先移除回收之前所有的item view。然后确定RecyclerView当前要显示多少个item(防止OOM，不可能显示所有item)，接着就是获取view，添加view，测量view，布局view。 为了让叠在一起的item有层次感对item做一些缩放和偏移。大功告成。

##### 2.2.２、TableLayoutManager #####

![表格实现][SouthEast]

TableLayoutManager实现表格的功能，当表格比较大的时候既可以上下滑动又可以左右滑动。在这个基础之上我们还加入了可以固定表头(因为第一行有的时候是标题，需要固定)，以及可以固定指定前面多少列的需求。其实之前我们也用ListView实现类似的需求，有兴趣的可以点击:[Android打造全方位滚动的ListView][Android_ListView]。

TableLayoutManager的实现我们分以下几个部分：

*  item布局：

表格里面肯定是有很多item项的，我们不可能所有的item都在onLayoutChildren里面布局出来。所以为了防止OOM发生，我们一定要明确当前屏幕要显示哪些item。所以我们有一个Rect变量来记录item可以显示的区域。在item layout布局的时候只布局在区域内的item。

*  处理滑动:

在滑动的时候，一定要及时去更新显示区域的变化，以及记录滑动offset的位置。当每次滑动的时候我们都会重新去layout RecyclerView 里面的item，加上相应的offset。更加具体的逻辑可以参考代码里面fillChildren()函数实现部分。

*  回收

其实在item布局的时候就已经把这个考虑进去了，item不在显示区域之内的不会add到RecyclerView里面，已经避免了OOM的情况。

*  处理固定列，固定行部分：

处理固定列，固定行我这里用的非常粗暴的办法，在每次layout RecyclerView 里面item的时候，我会把需要固定的item在重新layout到固定的位置上。具体可以参考代码里面fillChildren()函数实现。

TableLayoutManager的实现上面讲的比较少，推荐大家对照TableLayoutManager源码来看，TableLayoutManager源码里面也有相应的注释。

**最后给出CardLayoutManager、TableLayoutManager实现下载地址：[CardLayoutManager、TableLayoutManager代码链接][CardLayoutManager_TableLayoutManager]。里面肯定也有很多可以优化的地方欢迎大家指出，同时如果大家在CardLayoutManager、TableLayoutManager基础之上有什么新的需要也可以提出来，在能力范围之内的会尽量帮大家实现的**

[SouthEast]: /images/20220602/6bc7f7ac900e4a2aa1410111f52d7982.png
[SouthEast 1]: /images/20220602/656c75db720447c9a19ef7859477368e.png
[ItemTouchHelper]: http://blog.csdn.net/wuyuxing24/article/details/78985026
[Android_ListView]: http://blog.csdn.net/wuyuxing24/article/details/77169866
[CardLayoutManager_TableLayoutManager]: https://github.com/tuacy/LayoutManagerDemo