RecyclerView使用

RecyclerView缓存原理及源码

1.最简单的RecyclerView实现：

1.添加依赖：

	implementation "com.android.support:recyclerview-v7:28.0.0"

2.写一个简单的Adapter：

public class RecyclerAdapter extends RecyclerView.Adapter<RecyclerAdapter.ItemViewHolder> {

    private List<Item> dataList = new ArrayList<>();

    public void update(List<Item> items) {
        dataList.clear();
        dataList.addAll(items);
        notifyDataSetChanged();
    }

    //这个方法只有在创建RecycleView的时候才会执行一次，目的是加载每个Item的布局，parent就是RecyclerView
	//parent设为null时item_layout的layout_width,layout_height属性将会失效；attatchToParent也会失效
	//attatchToParent = false时，LayoutInflater.inflate()返回的view的类型是itemView
	//attatchToParent = true时，LayoutInflater.inflate()返回的view为parent
	//attatchToParent 默认为true；
    @Override
    public ItemViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
   		//最后一个参数必须是false，否则会崩溃，具体原因参考inflate加载机制
        View view = LayoutInflater.from(parent.getContext()).inflate(R.layout.item_layout, parent, false);
        ItemViewHolder holder = new ItemViewHolder(view);
        return holder;
    }

    @Override
    public void onBindViewHolder(ItemViewHolder holder, int position) {
        String text = dataList.get(position).getName();
        holder.textView.setText(text);
        holder.textView.setOnClickListener(null);
    }

    @Override
    public int getItemCount() {
        return dataList.size();
    }


    class ItemViewHolder extends RecyclerView.ViewHolder {
        TextView textView;

        public ItemViewHolder(View itemView) {
            super(itemView);
            textView = itemView.findViewById(R.id.name);
        }
    }
}

3.给布局中的RecyclerView添加Adapter：

	RecyclerAdapter adapter = new RecyclerAdapter();
	recyclerView = (RecyclerView) findViewById(R.id.list);
    recyclerView.setLayoutManager(new LinearLayoutManager(this));
    recyclerView.setAdapter(adapter);
    //设置分割线
    DividerItemDecoration divider = new DividerItemDecoration(this,DividerItemDecoration.VERTICAL);
    divider.setDrawable(ContextCompat.getDrawable(this,R.drawable.divider)); 
    recyclerView.addItemDecoration(divider);

2.在Adapter中添加更新项检查：

在上面的例子中，如果每次更新只有少量Item需要更新，也不得不更新所有的Item，下面的例子中通过修改Adapter，达到每次只更新数据发生变化的Item的效果：

public class RecyclerAdapter extends RecyclerView.Adapter<RecyclerAdapter.ItemViewHolder> {
    private List<Item> dataList = new ArrayList<>();

    public void update(List<Item> items) {
        DiffUtil.DiffResult result = getDiffResult(items);
        dataList.clear();
        dataList.addAll(items);
        result.dispatchUpdatesTo(this);
    }

	 //这个方法只有在创建RecycleView的时候才会执行一次，目的是加载每个Item的布局
    @Override
    public ItemViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(parent.getContext()).inflate(R.layout.item_layout, parent, false);
        ItemViewHolder holder = new ItemViewHolder(view);
        return holder;
    }

    @Override
    public void onBindViewHolder(ItemViewHolder holder, int position) {
        String text = dataList.get(position).getName();
        holder.textView.setText(text);
        holder.textView.setOnClickListener(null);
    }
    
    //此方法为配合DiffUtil.Callback中的getChangePayload方法使用
    @Override
    public void onBindViewHolder(ItemViewHolder holder, int position, List<Object> payloads) {
        if (payloads == null || payload.size() == 0) {
            onBindViewHolder(holder, position);
        } else {
            Bundle payload = (Bundle) payloads.get(0);
            Item item = dataList.get(position);
            for (String key : payload.keySet()) {
                switch (key) {
                    case "name":
                        holder.textView.setText(item.getName());
                        break;
                    default:
                        break;
                }
            }
        }
    }

    @Override
    public int getItemCount() {
        return dataList.size();
    }

    private DiffUtil.DiffResult getDiffResult(final List<Item> newList) {
        return DiffUtil.calculateDiff(new DiffUtil.Callback() {
            @Override
            public int getOldListSize() {
                return dataList.size();
            }

            @Override
            public int getNewListSize() {
                return newList.size();
            }

            @Override
            public boolean areItemsTheSame(int oldItemPosition, int newItemPosition) {
                Item oldItem = dataList.get(oldItemPosition);
                Item newItem = newList.get(newItemPosition);
                return oldItem.getId().equals(newItem.getId());
            }

            @Override
            public boolean areContentsTheSame(int oldItemPosition, int newItemPosition) {
                Item oldItem = dataList.get(oldItemPosition);
                Item newItem = newList.get(newItemPosition);
                return oldItem.getName().equals(newItem.getName());
            }
            
            @Nullable
            @Override        
            //payload表示数据项变化了的部分用于一个Item的部分字段更新
            public Object getChangePayload(int oldItemPosition, int newItemPosition) {
                Item oldItem = dataList.get(oldItemPosition);
                Item newItem = newList.get(newItemPosition);
                Bundle payload = new Bundle();
                if (!oldItem.getName().equals(newItem.getName())) {
                    payload.putString("name", newItem.getName());
                }
                return payload.size() == 0 ? null : payload;
            }
        });
    }

    class ItemViewHolder extends RecyclerView.ViewHolder {
        TextView textView;
        public ItemViewHolder(View itemView) {
            super(itemView);
            textView = itemView.findViewById(R.id.name);
        }
    }
}

3.RecycleView中显示多种布局：

重写Adapter在RecyclerView中加载两种布局：

//Adapter改为继承RecyclerView.Adapter
public class RecyclerAdapter extends RecyclerView.Adapter {

    private List<Item> dataList = new ArrayList<>();

    private static final int TYPE1 = 1;
    private static final int TYPE2 = 2;

    public void update(List<Item> items) {
        dataList.clear();
        dataList.addAll(items);
        notifyDataSetChanged();
    }

    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view;
        RecyclerView.ViewHolder holder;

        switch (viewType) {
            case TYPE1:
                view = LayoutInflater.from(parent.getContext()).inflate(R.layout.item_layout, parent, false);
                holder = new ItemViewHolder(view);
                return holder;

            case TYPE2:
                view = LayoutInflater.from(parent.getContext()).inflate(R.layout.item_layout2, parent, false);
                holder = new ItemViewHolder2(view);
                return holder;
            default:
                return null;
        }
    }

    @Override
    public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {
        if (holder instanceof ItemViewHolder) {
            String text = dataList.get(position).getName();
            ((ItemViewHolder) holder).textView.setText(text);
        } else if (holder instanceof ItemViewHolder2) {
            String text = dataList.get(position).getName();
            ((ItemViewHolder2) holder).textView.setText(text);
        }
    }

    @Override
    public int getItemCount() {
        return dataList.size();
    }

	//增加覆写getItemViewType方法，根据位置判断要返回哪种类型的ItemView
    @Override
    public int getItemViewType(int position) {
        if (position % 2 == 0) {
            return TYPE1;
        } else {
            return TYPE2;
        }
    }

    class ItemViewHolder extends RecyclerView.ViewHolder {
        TextView textView;

        public ItemViewHolder(View itemView) {
            super(itemView);
            textView = itemView.findViewById(R.id.name);
        }
    }

    class ItemViewHolder2 extends RecyclerView.ViewHolder {
        TextView textView;

        public ItemViewHolder2(View itemView) {
            super(itemView);
            textView = itemView.findViewById(R.id.name);
        }
    }
}

4.RecycleView中使用DataBinding

首先ItemViewHolder需要改写：

public class BindingTestAdapter extends RecyclerView.Adapter<BindingTestAdapter.ItemViewHolder> {
    private List<Item> dataList = new ArrayList<>();

    @Override
    public ItemViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
    	//加载一个databinding类型的布局文件
        ItemLayoutBinding binding = DataBindingUtil.inflate(LayoutInflater.from(parent.getContext()), 
        				R.layout.item_layout, parent, false);
        ItemViewHolder holder = new ItemViewHolder(binding);
        return holder;
    }

    @Override
    public void onBindViewHolder(@NonNull ItemViewHolder holder, int position) {
        holder.binding.name.setText(dataList.get(position).name);
    }

    @Override
    public int getItemCount() {
        return dataList.size();
    }

    public void setData(List<Item> data) {
        this.dataList.clear();
        this.dataList.addAll(data);
    }

    class ItemViewHolder extends RecyclerView.ViewHolder {
        private ItemLayoutBinding binding;

        public ItemLayoutBinding getBinding() {
            return binding;
        }

        public ItemViewHolder(ItemLayoutBinding binding) {
            super(binding.getRoot());
            this.binding = binding;
        }
    }
}

然后为RecyclerView添加一个自定义属性：

    @BindingAdapter("dataList")
    public static void setData(final RecyclerView editor, List<Item> list) {
        if (editor.getAdapter() instanceof BindingTestAdapter) {
            ((BindingTestAdapter) editor.getAdapter()).setData(list);
        }
    }

	<android.support.v7.widget.RecyclerView
            android:id="@+id/recycler"
            dataList="@{viewmodel.list}"/>

RecycleView刷新时要注意：

每次刷新列表时都要把所有的信息更新到UI上，否则可能发生多个Item之间UI错乱的问题，因为某个Item某一时刻展示的是某个对象的数据，当列表中Item顺序发生变化时这个Item显示的就可能是另外一个对象的数据，这是RecycleView的复用机制导致的