ItemTouchHelper实现RecyclerView拖动排序和滑动删除

前言

最近在项目中有需求使用RecyclerView的滑动删除或者左滑显示删除按钮，类似QQ消息列表滑动效果一样
在网上有许多大神贡献出来的实现这种效果的项目，最近在学习自定义View,想着能不能自己倒腾出来一个了。结果没出一会儿就在网上看到Google针对RecyclerView是有提供一个专门的工具类，看了一下官网资料，看了一些网上的资料就开始搞事了=。=

ItemTouchHelper 源码介绍

按照官网介绍这就是为RecyclerView专门定制的。按照我一贯的逻辑，先进源码看看再说
首先看看其继承关系:

public class ItemTouchHelper extends RecyclerView.ItemDecoration
        implements RecyclerView.OnChildAttachStateChangeListener

我们都知道RecyclerView.ItemDecoration是用来一个用来修饰RecyclerView的子item的抽象类，也就知道它的作用是什么了。
再来看看构造方法:

/**
     * Creates an ItemTouchHelper that will work with the given Callback.

     * @param callback The Callback which controls the behavior of this touch helper.
     */
    public ItemTouchHelper(Callback callback) {
        mCallback = callback;
    }

需要传入一个CallBack对象，我们先来看看这个callback对象是什么东西：

public abstract static class Callback {

     ............
         //拖动
         public abstract boolean onMove(RecyclerView recyclerView,
                ViewHolder viewHolder, ViewHolder target);
         //滑动
         public abstract void onSwiped(ViewHolder viewHolder, int direction);
.........
}

一个ItemTouchHelper内部的抽象类，在下面看到源码已经提供了一个简单的实现类SimpleCallback，任然是一个抽象类，但是使用他已经足够实现我的需求了，或者自己再添加其他功能也是可以的
再往下看见一个GestureDetector的实现类:

private class ItemTouchHelperGestureListener extends GestureDetector.SimpleOnGestureListener

还有就是

private class RecoverAnimation implements AnimatorListenerCompat

这两个暂时先没有具体的研究性。看到底了，对了还没看到是如何和RecyclerView绑定的呢，往上翻翻，才注意到原来是在这里：

public void attachToRecyclerView(@Nullable RecyclerView recyclerView) {
        if (mRecyclerView == recyclerView) {
            return; // nothing to do
        }
        if (mRecyclerView != null) {
            destroyCallbacks();
        }
        mRecyclerView = recyclerView;
        if (mRecyclerView != null) {
            final Resources resources = recyclerView.getResources();
            mSwipeEscapeVelocity = resources
                    .getDimension(R.dimen.item_touch_helper_swipe_escape_velocity);
            mMaxSwipeVelocity = resources
                    .getDimension(R.dimen.item_touch_helper_swipe_escape_max_velocity);
            setupCallbacks();
        }
    }

这里先判断现有的mRecyclerView和传入的recyclerView是否是同一个，如果是同一个什么都不做，再判断mRecyclerView是否存在，不存在则销毁Callback。判断后则是将传入的recyclerView赋给mRecyclerView，然后调用setupCallbacks()方法:

private void setupCallbacks() {
        ViewConfiguration vc = ViewConfiguration.get(mRecyclerView.getContext());
        mSlop = vc.getScaledTouchSlop();
        mRecyclerView.addItemDecoration(this);
        mRecyclerView.addOnItemTouchListener(mOnItemTouchListener);
        mRecyclerView.addOnChildAttachStateChangeListener(this);
        initGestureDetector();
    }

只是对进行一些基础的初始化操作，然后调用initGestureDetector（）方法创建了ItemTouchHelperGestureListener的实例

private void initGestureDetector() {
        if (mGestureDetector != null) {
            return;
        }
        mGestureDetector = new GestureDetectorCompat(mRecyclerView.getContext(),
                new ItemTouchHelperGestureListener());
    }

其他还有许多其他方法，包括移动，滑动，删除，绘制，动画等等，具体多的就不说了。看了也记不住=。=

RecyclerView拖动排序和滑动删除

说了那么多，接下来就是实战时间了。直接贴代码，相信结合代码中的注释一看就能明白了
首先是自定义的ItemTouchHelper

/**
     * dragDirs - 表示拖拽的方向，有六个类型的值：LEFT、RIGHT、START、END、UP、DOWN
       swipeDirs - 表示滑动的方向，有六个类型的值：LEFT、RIGHT、START、END、UP、DOWN
     */
    ItemTouchHelper.Callback callback=new ItemTouchHelper.SimpleCallback(ItemTouchHelper.UP|ItemTouchHelper.DOWN,ItemTouchHelper.RIGHT) {
        /**
         *
         * @param recyclerView　绑定的RecyclerView
         * @param viewHolder 需要拖动的ViewHolder
         * @param target　　目标位置的ViewHolder
         * @return
         */
        @Override
        public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) {
            int from=viewHolder.getAdapterPosition();
            int to=target.getAdapterPosition();
            /**
             * 这里拖动的想法是往下拖动则把中间的所有item上移
             * 往下则把所有的item下移
             * 如果想实现拖动前后位置item的交换　　即只需要交换两个位置的item
             */
            if (from<to){
                //中间上移
                for (int i=from;i < to;i++){
                    Collections.swap(list,i,i+1);
                }
            }else {
                for (int i=from;i>to;i--){
                    Collections.swap(list,i,i-1);
                }
            }
            adapter.notifyItemMoved(from,to);
            //return true表示执行移动
            return true;
        }

        /**
         *
         * @param viewHolder 滑动的RecyclerView
         * @param direction 滑动的方向
         */
        @Override
        public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction) {
            int position=viewHolder.getAdapterPosition();
            list.remove(position);
            adapter.notifyItemRemoved(position);
        }

        @Override
        public void onChildDraw(Canvas c, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) {
            super.onChildDraw(c, recyclerView, viewHolder, dX, dY, actionState, isCurrentlyActive);
            if(actionState == ItemTouchHelper.ACTION_STATE_SWIPE) {
                //滑动时改变Item的透明度
                final float alpha = 1 - Math.abs(dX) / (float)viewHolder.itemView.getWidth();
                viewHolder.itemView.setAlpha(alpha);
                viewHolder.itemView.setTranslationX(dX);
            }
        }
    };

然后结合RecyclerView使用:

 protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.swipedelete_dragchange_recyclerview);
        ButterKnife.bind(this);
        list=new ArrayList<>();
        for (int i=0;i<50;i++){
            list.add("RecyclerView Item　"+i);
        }
        adapter=new MyRecyclerViewAdapter(this,list);
        swipeDeleteDragChangeRecyclerview.setLayoutManager(new LinearLayoutManager(this));
        swipeDeleteDragChangeRecyclerview.setItemAnimator(new DefaultItemAnimator());
        swipeDeleteDragChangeRecyclerview.setHasFixedSize(true);
        ItemTouchHelper helper=new ItemTouchHelper(callback);
        helper.attachToRecyclerView(swipeDeleteDragChangeRecyclerview);
        swipeDeleteDragChangeRecyclerview.setAdapter(adapter);

    }

目前就写了这么一些，以后有深入研究或者有其他实现方法也会更新。
源码地址