Android一步步带你在RecyclerView上面实现"拖放"和"滑动删除"功能

先给大家展示下大概效果图：

android上面有许多的教程, 库和示例, 在recyclerview上面实现"拖放"和"滑动删除"功能. 尽管有更新, 更好的方法可用, 但是大多数人依然使用旧的view.ondraglistener和roman nurik的swipetodismiss方式. 除了经常使用gesturedetector和onintercepttouchevent之外, 几乎很少有人使用新的api, 要不然的话, 实现就复杂. 事实上真的有十分简单的方式在recyclerview上面添加这两个功能. 它只要求一个类, 而且这个类已经是android支持包的一部分.

itemtouchhelper

itemtouchhelper是一个强大的通用程序, 在recyclerview上面添加"拖放"和"滑动删除"时, 你所需要做的所有事情, 它都会负责处理. 它是recyclerview.itemdecoration的子类, 这意味着它可以轻易地添加到任何已经存在的layoutmanager和adapter上面! 它不会影响添加到item上的动画, 并且支持类别严格的"拖", 以及"放"时的动画, 还可以支持更多.

准备:

首先, 我们所需要的是添加recyclerview的依赖:

 compile 'com.android.support:recyclerview-v7:25.3.0'

使用itemtouchhelper和itemtouchhelper.callback:

为了使用itemtouchhelper, 你将创建一个itemtouchhelper.callback, 这是一个接口, 允许你监听"move"和"swipe"事件, 而且你可以通过callback来控件已选中view的状态, 并且可以改变该view的默认动画. 如果只是想要一个基础实现, 你可以使用simplecallback这个帮助类, 但是为了学习callback的工作原理, 我们将会自己实现一个.

为了激活基本的"拖放"和"滑动删除", 我们必须覆盖的主要方法是:

getmovementflags(recyclerview, viewholder)
onmove(recyclerview, viewholder, viewholder)
onswiped(viewholder, int)

我们也要使用这两个方法:

islongpressdragenabled()
isitemviewswipeenabled()

我们一个一个地看一下:

@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);
}

itemtouchhelper允许你轻易地决定事件的方向.你必须实现getmovementflags(recyclerview, recyclerview.viewholder)方法来指明"拖"和"滑动"所支持的方向, 并且使用itemtouchhelper.makemovementflags(int, int)来构建返回标签. 在此我们在两个不同的方向激活"拖"和"滑动".

@override
public boolean islongpressdragenabled() {
 return true;
}

itemtouchhelper能够用来实现"没有滑动的拖动"或者"没有拖动的滑动", 所以你必须精确地指明想要支持的动作. 如果你想要在recyclerview的item上支持"长按启动拖放"事件, 你就必须实现islongpressdragenabled()返回true. 此外, itemtouchhelper.startdrag(recyclerview.viewholder)可以从"操作"中启动"拖放", 这一点会在之后详述.

@override
public boolean isitemviewswipeenabled() {
 return true;
}

要想要view内部的任意触摸事件都可以启动"滑动"动作, 就简单地在isitemviewswipeenabled()返回true. 此外, itemtouchhelper.startswipe(recyclerview.viewholder)能够手动地启动"滑动"事件.

然后, onmove()和onswiped()方法需要实现, 来通知负责更新基础数据的东西. 所以, 首先, 我们要创建一个接口, 以允许我们传递"拖放"和"滑动删除"事件的回调.

public interface itemtouchhelperadapter {
 void onitemmove(int fromposition, int toposition);
 void onitemdismiss(int position);
}

从当前示例来讲, 要实现这些的最简单的方式, 是将我们的recyclerview.adapter实现这个接口:

public class recyclerlistadapter extends 
  recyclerview.adapter<itemviewholder> 
  implements itemtouchhelperadapter {
// ... code from gist
@override
public void onitemdismiss(int position) {
 mitems.remove(position);
 notifyitemremoved(position);
}
@override
public boolean onitemmove(int fromposition, int toposition) {
 if (fromposition < toposition) {
  for (int i = fromposition; i < toposition; i++) {
   collections.swap(mitems, i, i + 1);
  }
 } else {
  for (int i = fromposition; i > toposition; i--) {
   collections.swap(mitems, i, i - 1);
  }
 }
 notifyitemmoved(fromposition, toposition);
 return true;
}

调用notifyitemremoved(int)和notifyitemmoved(int, int)是非常重要的, 由此, adapter会更新数据. 请注意, 这也很重要, 我们改变item的position是在每一次view被切换到新的index, 而不是在"放"事件之后.

现在我们回来构建simpleitemtouchhelpercallback, 因为我们依然必须覆盖onmove()和onswiped()方法. 首先, 为adapter添加构建器和变量:

private final itemtouchhelperadapter madapter;
public simpleitemtouchhelpercallback(
  itemtouchhelperadapter adapter) {
 madapter = adapter;
}

然后覆盖剩下的事件并通知adapter:

@override
public boolean onmove(recyclerview recyclerview, 
  recyclerview.viewholder viewholder, 
  recyclerview.viewholder target) {
 madapter.onitemmove(viewholder.getadapterposition(), 
   target.getadapterposition());
 return true;
}
@override
public void onswiped(recyclerview.viewholder viewholder, 
  int direction) {
 madapter.onitemdismiss(viewholder.getadapterposition());
}

这个callback应该看起来像这样:

public class simpleitemtouchhelpercallback extends itemtouchhelper.callback {
 private final itemtouchhelperadapter madapter;
 public simpleitemtouchhelpercallback(itemtouchhelperadapter adapter) {
  madapter = adapter;
 }
 @override
 public boolean islongpressdragenabled() {
  return true;
 }
 @override
 public boolean isitemviewswipeenabled() {
  return true;
 }
 @override
 public int getmovementflags(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, viewholder viewholder, 
   viewholder target) {
  madapter.onitemmove(viewholder.getadapterposition(), target.getadapterposition());
  return true;
 }
 @override
 public void onswiped(viewholder viewholder, int direction) {
  madapter.onitemdismiss(viewholder.getadapterposition());
 }
}

当callback准备好之后, 我们创建itemtouchhelper并调用attachtorecyclerview(recyclerview)方法:

itemtouchhelper.callback callback = 
 new simpleitemtouchhelpercallback(adapter);
itemtouchhelper touchhelper = new itemtouchhelper(callback);
touchhelper.attachtorecyclerview(recyclerview);

当你运行的时候, 结果应该看起来像这样:

总结

这是一个itemtouchhelper极简单的实现. 但是我们应该清楚, 在recyclerview上面实现基本的"拖放"和"滑动删除", 使用第三方和库是完全没有必要的.

示例代码请点击这里.

以上所述是小编给大家介绍的android一步步带你在recyclerview上面实现"拖放"和"滑动删除"功能，希望对大家有所帮助