RecyclerView:使用ItemTouchHelper交换

本文主要是解决RecyclerView上下移动切换位置时能够移出RecyclerView控件的范围，同时增加了一些开始，结束，限制移动范围的接口，开始部分是分析，伸手党请直接拉到最后

1、基础使用

新项目做的差不多了，产品也开始附加功能了，要求：为了方便客户要增加移动列表位置进行排序的功能。没问题，其实心里正在暗暗得意，早就防着你呢，这次布局使用了RecyclerView，实现排序？太简单了，直接上代码

抽象接口用于操作交换

public interface ItemMoveHelperApi { 
   /**
     * Item 切换位置
     *
     * @param fromPosition 开始位置
     * @param toPosition   结束位置
     */
    void onItemMoved(int fromPosition, int toPosition);
}

实现交换

public class ItemMoveCallBackImpl extends ItemTouchHelper.Callback {

    private ItemMoveHelperApi mHelperApi;

    public ItemMoveCallBackImpl(ItemMoveHelperApi helperApi) {
        this.mHelperApi = helperApi;
    }
    @Override
    public boolean isLongPressDragEnabled() {
        return true;
    }
    @Override
    public boolean isItemViewSwipeEnabled() {
        return false;
    }
    @Override
    public int getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) {
        int dragFlags = ItemTouchHelper.UP | ItemTouchHelper.DOWN;
        int swipeFlags = ItemTouchHelper.START | ItemTouchHelper.END;
        return makeMovementFlags(dragFlags, swipeFlags);
    }
    @Override
    public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) {
        if (mHelperApi != null) {
            mHelperApi.onItemMoved(viewHolder.getAdapterPosition(), target.getAdapterPosition());
        }
        return true;
    }
    @Override
    public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction) {
    }
}

RecyclerView使用

ItemMoveCallBackImpl mMoveCallBack = new ItemMoveCallBackImpl(this);
ItemTouchHelper touchHelper = new ItemTouchHelper(mMoveCallBack);
touchHelper.attachToRecyclerView(recyclerView);

交换实现

@Override
public void onItemMoved(int fromPosition, int toPosition) {
    mAdapter.notifyItemMoved(fromPosition, toPosition);
    //数据交换，如果不写的话，滑动后会变回原来的顺序
    ......
}

2、添加开始结束接口

果然乐极生悲，虽然这个代码一点都没有问题，但是到了实际项目中发现一个尴尬的问题，RecyclerView有下拉刷新，当RecyclerView处于顶部的时候，交换和刷新会有冲突... 没办法，继续查找代码。在查找API的过程中发现了一个方法

/**
 * Called when the ViewHolder swiped or dragged by the ItemTouchHelper is changed.
 * <p/>
 * If you override this method, you should call super.
 *
 * @param viewHolder  The new ViewHolder that is being swiped or dragged. Might be null if
 *                    it is cleared.
 * @param actionState One of {@link ItemTouchHelper#ACTION_STATE_IDLE},
 *                    {@link ItemTouchHelper#ACTION_STATE_SWIPE} or
 *                    {@link ItemTouchHelper#ACTION_STATE_DRAG}.
 * @see #clearView(RecyclerView, RecyclerView.ViewHolder)
 */
public void onSelectedChanged(ViewHolder viewHolder, int actionState) {
    if (viewHolder != null) {
        sUICallback.onSelected(viewHolder.itemView);
    }
}

通过注释和自己代码试验得出结论，这个方法是在移动开始和结束的时候调用，这样一来就简单了，首先修改一下ItemMoveHelperApi 接口，新增2个方法

/**
 * 开始移动
 */
void onMoveStart();
/**
 * 停止移动
 */
void onMoveEnd();

然后在ItemMoveCallBackImpl 中重写onSelectedChanged方法

@Override
public void onSelectedChanged(RecyclerView.ViewHolder viewHolder, int actionState) {
    if (mHelperApi == null) {
        super.onSelectedChanged(viewHolder, actionState);
        return;
    }
    if (viewHolder == null) {
        mHelperApi.onMoveEnd();
    } else {
        mHelperApi.onMoveStart();
    }
    super.onSelectedChanged(viewHolder, actionState);
}

这样就能在onMoveStart中禁止下拉刷新控件，在onMoveEnd重新启动下拉刷新控件并保存当前列表的顺序，这样就不用去每次交换位置都去保存顺序了。

3、限制移动位置

果然程序员的世界和别人不一样（或者说是产品的世界和别人（程序员）的不一样？），在我看来不错的东西人家都能提出缺点(?) RecyclerView的交换移动到顶部的时候是可以移动出去的，这个要改，没办法，改吧，先上代码

@Override
public void onChildDraw(Canvas c, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) {
    dY = getLimitedDy(recyclerView, viewHolder, dY);
    super.onChildDraw(c, recyclerView, viewHolder, dX, dY, actionState, isCurrentlyActive);
}
/**
 * 根据方向和条件获取限制在RecyclerView内部的DY值
 *
 * @param recyclerView 列表
 * @param viewHolder   drag的ViewHolder
 * @param dY           限制前的DY值
 * @return 限制后的DY值
 */
private float getLimitedDy(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dY) {
    RecyclerView.LayoutManager layoutManager = recyclerView.getLayoutManager();
    if (!(layoutManager instanceof LinearLayoutManager)
            || ((LinearLayoutManager) layoutManager).getOrientation() != OrientationHelper.VERTICAL) {
        return dY;
    }
    int position = viewHolder.getLayoutPosition();
    mDragEndPosition = mDragEndPositionFlag ?
            mDragStartPosition : recyclerView.getAdapter().getItemCount() - 1;
    if (position == mDragStartPosition) {
        return dY < 0 ? 0 : dY;
    } else if (position == mDragEndPosition) {
        return dY > 0 ? 0 : dY;
    }
    return dY;
}

方法onChildDraw会在Drag的ViewHolder移动的时候使用，参数dX，dY表示当前View和相邻的ViewHolder在X，Y方向上的位移差，根据Y轴的移动方向判断下个ViewHolder是否参与交换，如果不参与，则dY返回0，ViewHolder就不会像下个位置绘制了。同时根据这个原理加入了限制移动的开始和结束位置的接口

private int mDragStartPosition; //能够拖拽的开始位置

/**
 * 设置拖拽开始位置
 *
 * @param dragStartPosition 开始位置
 */
public void setDragStartPosition(int dragStartPosition) {
    mDragStartPosition = dragStartPosition;
}

private int mDragEndPosition; //能够拖拽的结束位置
private boolean mDragEndPositionFlag; //是否设置了拖拽结束位置

/**
 * 设置拖拽结束的位置
 *
 * @param dragEndPosition 结束位置
 */
public void setDragEndPosition(int dragEndPosition) {
    mDragEndPositionFlag = true;
    mDragEndPosition = dragEndPosition;
}

一般HeaderView和FooterView是不能移动的，但是在RecyclerView是没有这个概念的，有了上面这个接口就可以将HeaderView和FooterView限制在可移动的位置之外

至此所有问题完美解决，最后附上全部代码

public interface ItemMoveHelperApi { 
   /**
     * Item 切换位置
     *
     * @param fromPosition 开始位置
     * @param toPosition   结束位置
     */
    void onItemMoved(int fromPosition, int toPosition);

   /**
    * 开始移动
    */
   void onMoveStart();

   /**
    * 停止移动
    */
   void onMoveEnd();
}

public class ItemMoveCallBackImpl extends ItemTouchHelper.Callback {

    private ItemMoveHelperApi mHelperApi;//移动API的回调接口

    private boolean mDragEnabled = true; //是否能够通过长按切换位置

    private int mDragStartPosition; //能够拖拽的开始位置

    private int mDragEndPosition; //能够拖拽的结束位置

    private boolean mDragEndPositionFlag; //是否设置了拖拽结束位置

    public ItemMoveCallBackImpl(ItemMoveHelperApi helperApi) {
        this.mHelperApi = helperApi;
    }

    @Override
    public boolean isLongPressDragEnabled() {
        return mDragEnabled ;
    }

    @Override
    public boolean isItemViewSwipeEnabled() {
        return false;
    }

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

    @Override
    public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) {
        if (mHelperApi != null) {
            mHelperApi.onItemMoved(viewHolder.getAdapterPosition(), target.getAdapterPosition());
        }
        return true;
    }

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

   @Override
   public void onSelectedChanged(RecyclerView.ViewHolder viewHolder, int actionState) {
       if (mHelperApi == null) {
           super.onSelectedChanged(viewHolder, actionState);
           return;
       }
       if (viewHolder == null) {
           mHelperApi.onMoveEnd();
       } else {
           mHelperApi.onMoveStart();
       }
       super.onSelectedChanged(viewHolder, actionState);
   }

   @Override
   public void onChildDraw(Canvas c, RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) {
       dY = getLimitedDy(recyclerView, viewHolder, dY);
       super.onChildDraw(c, recyclerView, viewHolder, dX, dY, actionState, isCurrentlyActive);
   }
   /**
    * 根据方向和条件获取限制在RecyclerView内部的DY值
    *
    * @param recyclerView 列表
    * @param viewHolder   drag的ViewHolder
    * @param dY           限制前的DY值
    * @return 限制后的DY值
    */
   private float getLimitedDy(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dY) {
    RecyclerView.LayoutManager layoutManager = recyclerView.getLayoutManager();
       if (!(layoutManager instanceof LinearLayoutManager)
               || ((LinearLayoutManager) layoutManager).getOrientation() != OrientationHelper.VERTICAL) {
           return dY;
       }
       int position = viewHolder.getLayoutPosition();
       mDragEndPosition = mDragEndPositionFlag ?
               mDragStartPosition : recyclerView.getAdapter().getItemCount() - 1;
       if (position == mDragStartPosition) {
           return dY < 0 ? 0 : dY;
       } else if (position == mDragEndPosition) {
           return dY > 0 ? 0 : dY;
       }
       return dY;
   }
   /**
    * 设置能否拖拽
    *
    * @param dragEnabled 拖拽标记
    */
   public void setDragEnabled(boolean dragEnabled) {
       mDragEnabled = dragEnabled;
   }
   /**
    * 设置拖拽开始位置
    *
    * @param dragStartPosition 开始位置
    */
   public void setDragStartPosition(int dragStartPosition) {
       mDragStartPosition = dragStartPosition;
   }
   /**
    * 设置拖拽结束的位置
    *
    * @param dragEndPosition 结束位置
    */
   public void setDragEndPosition(int dragEndPosition) {
       mDragEndPositionFlag = true;
       mDragEndPosition = dragEndPosition;
   }
   /**
    * 清除固定结束位置的标记
    */
   public void clearDragEndPosition() {
       mDragEndPositionFlag = false;
   }
}