ItemTouchHelper(一)认识与实现

前言

ItemTouchHelper是什么？

看看官方解释

/**
  *  This is a utility class to add swipe to dismiss and drag & drop support to RecyclerView.
  */

通过这段解释其实可以清楚这个ItemTouchHelper到底是干什么的，它是一个可以给RecyclerView提供添加拖动排序与滑动删除等等操作的工具类。

大家应该清楚拖动排序与滑动删除其实如果代码去写会比较麻烦，所以ItemTouchHelper的出现也确实解决了这部分代码比较复杂的问题，这偏文章就简单的介绍下ItemTouchHelper的使用方法

简单实现

1.首先实现一个RecyclerView就好了

直接上代码

public class RecyclerAdapter extends RecyclerView.Adapter{

    private static final String[] STRINGS = new String[]{
            "One", "Two", "Three", "Four", "Five", "Six", "Seven", "Eight", "Nine", "Ten"
    };

    private final List mItems = new ArrayList<>();

    public RecyclerAdapter() {
        mItems.addAll(Arrays.asList(STRINGS));
    }

    @Override
    public ItemViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(parent.getContext()).inflate(R.layout.item_main, parent, false);
        ItemViewHolder itemViewHolder = new ItemViewHolder(view);
        return itemViewHolder;
    }

    @Override
    public void onBindViewHolder(ItemViewHolder holder, int position) {
        holder.textView.setText(mItems.get(position));
    }

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

    public static class ItemViewHolder extends RecyclerView.ViewHolder{

        public final TextView textView;

        public ItemViewHolder(View itemView) {
            super(itemView);
            textView = (TextView) itemView;
        }
    }
}

mRecyclerView.setAdapter(new RecyclerAdapter());
mRecyclerView.setLayoutManager(new LinearLayoutManager(MainActivity.this));

创建好了，如下

图1 RecycleView

2.创建一个类继承ItemTouchHelper.Callback，并且与RecycleView建立链接

public class ItemTouchHelperCallback extends ItemTouchHelper.Callback{
    @Override
    public int getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) {
        return 0;
    }

    @Override
    public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) {
        return false;
    }

    @Override
    public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction) {

    }
}

创建了一个类并继承了ItemTouchHelper.Callback与他的一些方法，但是些方法根据我们的需求需要重写

需要重写getMovementFlags()方法来指定可以支持的拖放和滑动的方向使用helperItemTouchHelper.makeMovementFlags(int, int)来构造返回的flag。这里我们启用了上下左右两种方向。注：上下为拖动（drag），左右为滑动（swipe）。

如下

public int getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) {
    final int dragFlags = ItemTouchHelper.UP | ItemTouchHelper.DOWN;
    final int swipeFlags = ItemTouchHelper.START | ItemTouchHelper.END;
    return makeMovementFlags(dragFlags, swipeFlags);
}

接下来建立与RecycleView的链接

ItemTouchHelper mItemTouchHelper = new ItemTouchHelper(new ItemTouchHelperCallback());
mItemTouchHelper.attachToRecyclerView(mRecyclerView);

好的接下来就是见证奇迹的时刻了

图2 RecycleView

但是显然不是我们想要的结果，但是还缺少什么呢？Adapter数据并没有发生实质性的变化，所以接下来工作就是去让Adapter内数据产生变化

3.通过接口改变Adapter数据

首先创建接口

public interface IItemHelper {

    void onItemMove(int fromPosition, int toPosition);

    void onItemDismiss(int position);

}

然后在callback中调用

@Override
public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) {
    mRecyclerAdapter.onItemMove(viewHolder.getAdapterPosition(), target.getAdapterPosition());
    return false;
}

@Override
public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction) {
    mRecyclerAdapter.onItemDismiss(viewHolder.getAdapterPosition());
}

最后在Adapter中实现这个接口

@Override
public void onItemMove(int fromPosition, int toPosition) {
    String prev = mItems.remove(fromPosition);
    mItems.add(toPosition > fromPosition ? toPosition - 1 : toPosition, prev);
    notifyItemMoved(fromPosition, toPosition);
}

@Override
public void onItemDismiss(int position) {
    mItems.remove(position);
    notifyItemRemoved(position);
}

接下来就是真正的见证奇迹的时刻了

图3 RecycleView

拖动不知道为什么在模拟器上太难操作了，OMG

写在后面的话

到这里基本上简单使用已经介绍完毕了，对于更深的源码解析和更深层次的使用就放在后面的文章进行分析了。。