【UI篇3】RecyclerView创建动态列表

阿兰哥
520 阅读6分钟

前言
RecyclerView是一款功能十分强大的widget，涉及到列表呈现时，通常都会使用到RecyclerView，功能如此强大的widget不做一下记录实在可惜。

  • Android官方指导文档有详细的介绍如何使用RecyclerView创建动态列表，具体参考如下地址 developer.android.com/guide/topic…

  • 思考任何问题时，我们都需要回到问题的本质。通过RecyclerView 的源码我们可以知道RecyclerView是一个容器，用于显示列表或网格形式的数据，比如文本或照片。

1 RecyclerView展示数据实现

1.1 RecyclerView布局

  • 布局
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <androidx.recyclerview.widget.RecyclerView
        android:id="@+id/recycler_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>

    <com.google.android.material.floatingactionbutton.FloatingActionButton
        android:id="@+id/fab"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_margin="16dp"
        android:contentDescription="@string/fab_content_description"
        android:src="@drawable/ic_add_black_24dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"/>

</androidx.constraintlayout.widget.ConstraintLayout>

在Activity中的设置

  • Activity
//初始使用
mRecyclerView = findViewById(R.id.recycler_view)
mRecyclerView.layoutManager = LinearLayoutManager(this)
mRecyclerView.adapter = mAdapter

1.2 规划布局

组成RecyclerView的表项可能有多种类型，不同的类型会有不同的布局。根据列表或网格的外观，确定布局管理器，RecyclerView中的列表项由LayoutManager类负责排列。

  • 可以扩展RecyclerView.LayoutManager抽象类来创建自己的布局管理器
  • 可以扩展RecyclerView.ItemAnimator来定义自己的animator对象
  • 可以扩展RecyclerView.ItemDecoration来定义自己的分割线
class ItemDecoration(
    private val paddingSpace: Int
) : RecyclerView.ItemDecoration() {
    companion object {
        private const val TAG = "ItemDecoration"
    }

    override fun getItemOffsets(
        outRect: Rect,
        view: View,
        parent: RecyclerView,
        state: RecyclerView.State
    ) {
        super.getItemOffsets(outRect, view, parent, state)
        val position = parent.getChildLayoutPosition(view)
      
        outRect.left = 0
        outRect.right = paddingSpace
        outRect.top = 0
        outRect.bottom = 0
    }
}

同一个RecyclerView可以绑定不同ViewType类型的Item，可以定义接口如下，其他Item实现该接口

interface IWallpaperListItem {
    val type: Int
}

class SourceItem : IWallpaperListItem {
    override val type: Int
        get() = ViewType.SOURCE
}

class RecommendItem(
    val imageList: List<Image>? = null
) : IWallpaperListItem {
    override val type: Int
        get() =ViewType.WALLPAPER
}

1.3 实现Adapter和ViewHolder

  • a. 创建Adapter 只定义名字
  • b. 创建ViewHolder 创建ViewHolder的内部类，并且它可以接收一个itemView作为参数。然后创建bind函数，将数据和携带数据的UI关联起来。
abstract class AbsViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
	abstract fun bind(wallpaperListItem: IWallpaperListItem)
}

class ***TitleViewHolder(itemView: View) : AbsViewHolder(itemView) {
	override fun bind(wallpaperListItem: IWallpaperListItem) {
		//绑定内容
	}
}

class ***SourceViewHolder(itemView: View) : AbsViewHolder(itemView) {
	private val ***CardView = itemView.findViewById<CardView>(R.id.***_card_view)
	private val ***CardView = itemView.findViewById<CardView>(R.id.***_card_view)
	init {
                //设置背景
		//CardView.background = 
		***CardView.setOnClickListener {
			Log.d(TAG, "onClick")
			//点击
		}

		//***View.background = 
		***CardView.setOnClickListener {
			Log.d(TAG, "onClick")
			//点击
		}
	}

	override fun bind(wallpaperListItem: IWallpaperListItem) {
		//绑定
	}

}
  • c. 继承RecyclerView.Adapter 更新Adapter类的定义，使其继承RecyclerView.Adapter类，并且将ViewHolder作为参数传入 这里也可以改为继承ListAdapter
class ***Adapter(
    private val retryLoad: () -> Unit
) : ListAdapter<IWallpaperListItem, ***.AbsViewHolder>(***DiffCallback) {
  • d. 重写onCreateViewHolder() 当ViewHolder创建的时候会调用该方法。在该方法里进行初始化和填充RecyclerView中的表项视图。
override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): AbsViewHolder {
        Log.d(TAG, "onBindViewHolder viewType=$viewType")
        return when (viewType) {
            ViewType.SOURCE -> {
                val view = LayoutInflater.from(parent.context).inflate(R.layout.1_item, parent, false)
                ***SourceViewHolder(view)
            }

            ViewType.TITLE -> {
                val view = LayoutInflater.from(parent.context).inflate(R.layout.2_title_item, parent, false)
                ***TitleViewHolder(view)
            }

            ViewType.WALLPAPER -> {
                val view = LayoutInflater.from(parent.context).inflate(R.layout.3_recommend_item, parent, false)
                ***WallpaperViewHolder(view) { retryLoad() }
            }

            else -> {
                throw IllegalStateException("view type is error")
            }
        }
    }
  • e. 重写onBindViewHolder() onBindViewHolder()被调用的时候，会传入参数ViewHolder和位置position，该位置可以用于提取表项所需的数据，并且将数据传递给ViewHolder来使数据绑定到对应的UI。
override fun onBindViewHolder(holder: AbsViewHolder, position: Int) {
        Log.d(TAG, "onBindViewHolder position=$position")
        val ***ListItem = getItem(position)
        holder.bind(***ListItem)
    }
  • f. 重写getItemCount() RecyclerView显示一个列表，所以它需要知道列表里共有多少项。

ListAdapter可以处理元素的添加和删除而无需重绘视图，甚至可以为变化添加动画效果。 DiffUtil 是 ListAdapter 能够高效改变元素的奥秘所在。DiffUtil 会比较新旧列表中增加、移动、删除了哪些元素，然后输出更新操作的列表将原列表中的元素高效地转换为新的元素。

为了能够识别新的数据，DiffUtil 需要您重写 areItemsTheSame() 和 areContentsTheSame()。areItemsTheSame() 检查两个元素是否为同一元素。areContentsTheSame() 检查两个元素是否包含相同的数据。

在Adapter类中添加DiffUtil对象，并且复写 areItemsTheSame()和areContentsTheSame()

object FlowerDiffCallback : DiffUtil.ItemCallback<Flower>() {
    override fun areItemsTheSame(oldItem: Flower, newItem: Flower): Boolean {
        return oldItem == newItem
    }

    override fun areContentsTheSame(oldItem: Flower, newItem: Flower): Boolean {
        return oldItem.id == newItem.id
    }
}

将Adapter的父类由RecyclerView.Adapter改为ListAdapter，并传入DiffCallback

class FlowersAdapter(private val onClick: (Flower) -> Unit) :
    ListAdapter<Flower, FlowersAdapter.FlowerViewHolder>(FlowerDiffCallback) {

更新列表

ListAdapter 通过 submitList() 方法获取数据，该方法提交了一个列表来与当前列表进行对比并显示。也就是说您无需再重写 getItemCount()，因为 ListAdapter 会负责管理列表。

在 Activity 类中，调用 Adapter 的 submitList() 方法并传入数据列表。 此处需要通过toMutableList转换生成一个新的list，否则不会更新，不同的item，viewType不一样。

private fun updateListData(imageList: List<ImageData>?) {
        Log.d(TAG, "updateListData imageList.size=${imageList?.size}")
        mItemList.clear()
        mItemList.add(SourceItem())
        mItemList.add(TitleItem())
        mItemList.add(RecommendItem(imageList))
        mAddAdapter.submitList(mItemList.toMutableList())
    }

1.4 连接

我们已经创建了布局、数据列表和adapter，可以直接将adapter赋给RecyclerView

1.5 刷新

一个item可能有多个控件，点击item进行刷新时，可能只想刷新其中某一个控件，此时就可以用到payload参数

2 响应点击事件

2.1 定义点击动作

在创建监听器之前，在 Activity 类中添加一个函数用于处理点击之后的响应操作。

private fun adapterOnClick() {
   val intent = Intent(this,DetailActivity()::class.java)
   this.startActivity(intent)
}

接下来，修改 Adapter 的构造函数来传入 onClick() 函数。

class **Adapter(private val onClick: (Flower) -> Unit) :
  ListAdapter<T, RecyclerView.ViewHolder>(DiffCallback())

在 Activity 类中，在初始化 Adapter 的时候传入刚刚创建的点击事件函数。

2.2 添加onClickHandler()

现在响应处理已经定义好了，可以将它关联到 Adapter 的 ViewHolder 了。

修改 ViewHolder，将 onClick() 作为参数传入。

class ViewHolder(itemView: View, val onClick: (Source) -> Unit) :
  RecyclerView.ViewHolder(itemView)

在初始化的代码中，调用 itemView 的 setOnClickListener{}

init {
    itemView.setOnClickListener {
       currentItem?.let {
          onClick(it)
       }
    }
}

现在就可以响应点击事件了

3 使用SpanSizeLookup设置item占位

3.1 使用GridLayoutManager

// 该方法返回position这个位置对应item所占的位数，默认情况下，每个item占1个位
public abstract int getSpanSize(int position)

//给布局管理器设置SpanSizeLookup对象
public void setSpanSizeLookup(SpanSizeLookup spanSizeLookup)

实现

  1. 实现getSpanSize方法：GridLayoutManager.SpanSizeLookup 子类 , 并实现 public int getSpanSize(int position) 方法；在getSpanSize 方法中, 设置每个 position 位置占据的格子数量
  2. 设置setSpanSizeLookup方法：调用 setSpanSizeLookup 方法 , 将 GridLayoutManager.SpanSizeLookup 子类对象设置给 GridLayoutManager

公式：spanCount/getSpanSize = 该行的item数

layoutManager = GridLayoutManager(context, 2, RecyclerView.HORIZONTAL, false).apply {
    spanSizeLookup = object : SpanSizeLookup() {
        override fun getSpanSize(position: Int): Int {
            return if (position == 0) {
                2
            } else {
                1
            }
        }

    }
}

3.2 StaggeredGridLayoutManager

通过设置fullSpan占满整行，多用于RecyclerView是垂直方向

//StaggeredGridLayoutManager.LayoutParams

public void setFullSpan(boolean fullSpan) {
    mFullSpan = fullSpan;
}

4 RecyclerView 划动冲突

划动冲突的分析和解决方法见：纵向RecyclerView嵌套横向RecyclerView划动冲突

5 RecyclerView与ViewPager2联动

5.1 RecyclerView的item点击触发ViewPager2切换

viewPager2.setCurrentItem(position, false)
//RecyclerView划动到指定位置
recyclerView.smoothScrollBy(offset, 0, INTERPOLATOR, duration)

5.2 ViewPager2划动触发RecyclerView滚动

recyclerAdapter.setCurrentPosition(position)
//根据ItemDecoration和当前的position计算左划和右划的偏移位置offset，然后进行滚动
recyclerView.smoothScrollBy(offset, 0, INTERPOLATOR, duration)
//item项执行选择改变的动画
recyclerAdapter.selectItemChanged(position)

6 RecyclerView点击滚动到指定位置

6.1 定位距离顶部指定偏移位置

【实现方法】自定义LinearSmoothScroller

class TopSmoothScroller(context: Context) : LinearSmoothScroller(context) {
    //偏移量
    private val offset = context.resources.getDimensionPixelSize(R.dimen.item_margin_top)

    override fun getVerticalSnapPreference(): Int {
        return SNAP_TO_START
    }

    override fun onTargetFound(targetView: View, state: RecyclerView.State, action: Action) {
        val dx = calculateDxToMakeVisible(targetView, horizontalSnapPreference)
        val dy = calculateDyToMakeVisible(targetView, verticalSnapPreference)
        val distance = sqrt((dx * dx + dy * dy).toDouble()).toInt()
        val time = calculateTimeForDeceleration(distance)
        if (time > 0) {
            //指定距离增加一个offset偏移量
            action.update(-dx, -dy - offset, time, mDecelerateInterpolator)
        }
    }
}


val topSmoothScroller = TopSmoothScroller(context)
//滚动到指定位置
topSmoothScroller.targetPosition = position
(mRvDropSpaceList?.layoutManager as LinearLayoutManager).startSmoothScroll(topSmoothScroller)

6.2 RecyclerView中指定item可见的条件判断

可见时，执行对应的操作

val outLocation = IntArray(2)
adView?.getLocationOnScreen(outLocation)
val adViewScreenY = outLocation[1]
val adViewBottom = adViewScreenY + (adView?.height ?: 0)

if (adViewBottom > ActionbarHeight && adViewScreenY < ScreenUtils.getScreenHeight(context)) {
   //表示可见，可执行相关操作
}

7 ConcatAdapter

使用ConcatAdapter可以将多个adapter添加到RecyclerView，ConcatAdapter会依次显示多个Adapter的内容，有兴趣可以了解

8 参考资料

mp.weixin.qq.com/mp/appmsgal…

avatar
文章
阅读
粉丝