使用更少代码的ListAdapter-CSDN博客

写在前面的话

在项目中，我们经常用到列表，在以前我们使用RecyclerView,伴随着肯定会有一个继承RecyclerView.Adapter的adapter 但是在这个adapter中，但是这个adapter中，我们会写较多的代码。在com.android.support:recyclerview-v7:27.1.0 中增加了一个ListAdapter,这个ListAdapter让我们使用起来更加方便。

存在的问题

在以前我们是通过这样的方式来进行处理

class TestAdapter<T> : RecyclerView.Adapter<TestAdapter.ViewHolder<T>>() {

    var TAG = "ADAPTER"

    var mData: MutableList<T> = ArrayList()


    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ViewHolder<T> {
        val inflater = LayoutInflater.from(parent.context)
        return TestAdapter.ViewHolder(inflater.inflate(R.layout.item_user, parent, false))
    }

    override fun getItemCount(): Int {
        return mData.size
    }

    override fun onBindViewHolder(holder: ViewHolder<T>, position: Int) {

        holder.bind(mData[position])
    }


    fun add(t: T) {
        if (t != null) {
            mData.add(t)
        } else {
            Log.e(TAG, "the data is null")
        }
        notifyDataSetChanged()
    }


    fun addList(@NonNull ts: List<T>) {
        mData.clear()
        mData.addAll(0, ts)
        notifyDataSetChanged()
    }

    fun appendList(@NonNull ts: List<T>) {

        mData.addAll(mData.size, ts)
        notifyDataSetChanged()
    }
    
    fun deleteItem(position: Int){
        if (mData.size > position){
            mData.removeAt(position)
        }
       notifyDataSetChanged()
    }

   

    class ViewHolder<T>(itemView: View) : RecyclerView.ViewHolder(itemView) {

        fun bind(t: T) {

        }

    }

}

复制代码

我们大概都会做类似以上的一种事情，但是里面有一个最大的问题，那就是不论是增加（add）还是删除，都需要我们自己处理，处理后我们会调用notifyDataSetChanged()方法进行刷新。但是刷新之后我们会发现RecyclerView的动画消失了。当然为了解决这个问题，我们可以调用以下方法：

adapter.notifyItemRangeInserted(position, count);
adapter.notifyItemRangeRemoved(position, count);
adapter.notifyItemMoved(fromPosition, toPosition);
adapter.notifyItemRangeChanged(position, count, payload);

这四种方法是带动画。还有一种解决方式就是使用DiffUtil

DiffUtil

DiffUtil在 support library 25.1.0 的时候就引入了，最主要的功能就是处理adapter的更新，其功能就是比较两个数据集，用newList和oldList进行比较，得出最小的变化量。也就是说我们不需要再无脑的使用 notifyDataSetChanged()。也就是说如果我们使用了DiffUtil，那么我们不需要去区别上述的四种调用方式， DiffUtil将自动为我们处理然后进行调用。

DiffUtil.ItemCallback

在ListAdapter的构造函数中，我们需要一个DiffUtil的回调，当然我们一般就使用DiffUtil.ItemCallback

class UserDiffCallback : DiffUtil.ItemCallback<User>() {

    override fun areItemsTheSame(oldItem: User?, newItem: User?): Boolean {
        return oldItem?.userId == newItem?.userId
    }

    override fun areContentsTheSame(oldItem: User?, newItem: User?): Boolean {
        return oldItem == newItem
    }
}
复制代码

如上，我们需重写其中的两个方法areItemsTheSame和areContentsTheSame

areItemsTheSame

areItemsTheSame提供了两个对象，需你提供这个两个对象是否是同一个对象。在User对象中有一个userId, 其代表了唯一性，所以这里我就使用了oldItem?.userId == newItem?.userId。这个可根据实际情况自行判断。

areContentsTheSame

areContentsTheSame也提供了两个对象，然后需要你提供这个两个对象的内容是否一致，如果不一致，那么它就将对列表进行重绘和动画加载，反之，表示你已经显示了这个对象的内容并且没有任何的变化，那么将不做任何的操作。

ListAdapter

与之前的adapter没有太多的区别，就是去掉了我们的数据列表mData和不在使用notifyDataSetChanged相关方法。


class UserAdapter : ListAdapter<User, RecyclerView.ViewHolder>(UserDiffCallback()) {

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RecyclerView.ViewHolder {
        val inflater = LayoutInflater.from(parent.context)
        return UserAdapter.ViewHolder(inflater.inflate(R.layout.item_user, parent, false))
    }

    override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int) {
        if (holder is ViewHolder) {
            holder.bind(getItem(position))
        }
    }


    class ViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
        fun bind(user: User) {
            
        }
    }

}
复制代码

其实就是一个很简单的Adapter，不需要任增加任何新的方法（增、删、改），无论是增加还是更新或者删除，我们只需要使用adapter.submitList(List)方法

但是需要注意一个问题，这个adapter.submitList(List)方法中需要提供一个列表，这个List必须是一个新的列表，也就是说，如果你使用的是一个已经加载了的列表，那么将不会被加载。