快捷導(dǎo)航

android的RecyclerView實現(xiàn)拖拽排序和側(cè)滑刪除示例

更新時間：2017年02月10日 17:25:42 作者：Qirong yu

在平時開發(fā)應(yīng)用的時候，經(jīng)常會遇到列表排序、滑動刪除的需求。這篇文章主要介紹了android的RecyclerView實現(xiàn)拖拽排序和側(cè)滑刪除示例,有興趣的可以了解一下。

在平時開發(fā)應(yīng)用的時候，經(jīng)常會遇到列表排序、滑動刪除的需求。如果列表效果采用的是 ListView 的話，需要經(jīng)過自定義 View 才能實現(xiàn)效果；但是如果采用的是 RecyclerView 的話，系統(tǒng) API 就已經(jīng)為我們提供了相應(yīng)的功能。

接下來，我們就來看一下怎么用系統(tǒng) API 來實現(xiàn)排序和刪除的效果。

創(chuàng)建 ItemTouchHelper

創(chuàng)建一個 ItemTouchHelper 對象，然后其調(diào)用 attachToRecyclerView 方法：

RecyclerView recyclerView = (RecyclerView) findViewById(R.id.recyclerView);
recyclerView.setLayoutManager(new LinearLayoutManager(this, LinearLayoutManager.VERTICAL, false));
RecyclerViewAdapter adapter = new RecyclerViewAdapter();
ItemTouchHelper helper = new ItemTouchHelper(new MyItemTouchCallback(adapter));
helper.attachToRecyclerView(recyclerView);

在創(chuàng)建 ItemTouchHelper 對象時候，需要我們傳入一個實現(xiàn)了 ItemTouchHelper.Callback 接口的對象。而排序和刪除的邏輯都封裝在了這個 ItemTouchHelper.Callback 的對象里面了。

實現(xiàn) ItemTouchHelper.Callback 接口

創(chuàng)建 MyItemTouchCallback 類，實現(xiàn) ItemTouchHelper.Callback 接口：

public class MyItemTouchCallback extends ItemTouchHelper.Callback {

  private final RecyclerViewAdapter adapter;

  public MyItemTouchCallback(RecyclerViewAdapter adapter) {
    this.adapter = adapter;
  }

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

}

實現(xiàn) ItemTouchHelper.Callback 接口后有三個方法需要重寫：

getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) ：設(shè)置滑動類型的標記。需要設(shè)置兩種類型的 flag ，即 dragFlags 和 swipeFlags ，分別代表著拖拽標記和滑動標記。最后需要調(diào)用 makeMovementFlags(dragFlags, swipeFlags) 方法來合成返回。
onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) ：當用戶拖拽列表某個 item 時會回調(diào)。很明顯，拖拽排序的代碼應(yīng)該在這個方法中實現(xiàn)。
onSwiped(RecyclerView.ViewHolder viewHolder, int direction) ：當用戶滑動列表某個 item 時會回調(diào)。所以側(cè)滑刪除的代碼應(yīng)該在這個方法中實現(xiàn)。

重寫方法

我們先來看看 getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) 方法：

@Override
public int getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) {
  int dragFlag;
  int swipeFlag;
  RecyclerView.LayoutManager layoutManager = recyclerView.getLayoutManager();
  if (layoutManager instanceof GridLayoutManager) {
    dragFlag = ItemTouchHelper.DOWN | ItemTouchHelper.UP
        | ItemTouchHelper.RIGHT | ItemTouchHelper.LEFT;
    swipeFlag = 0;
  } else {
    dragFlag = ItemTouchHelper.DOWN | ItemTouchHelper.UP;
    swipeFlag = ItemTouchHelper.END;
  }
  return makeMovementFlags(dragFlag, swipeFlag);
}

代碼中根據(jù) layoutManager 分為了兩種情況：

如果是 GridLayoutManager ，那么拖拽排序就可以細分為上下左右四個方向了，而且 GridLayoutManager 沒有側(cè)滑刪除的功能；
若是其他的 LayoutManager ，比如說 LinearLayoutManager ，那么拖拽排序就只有上下兩個方向了，并且設(shè)置 swipeFlag 為 ItemTouchHelper.END 類型；
對于其他自定義類型的 LayoutManager 可以自己根據(jù)自身情況補充。

下面就是 onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) 方法：

@Override
public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) {
  int fromPosition = viewHolder.getAdapterPosition();
  int toPosition = target.getAdapterPosition();
  if (fromPosition < toPosition) {
    for (int i = fromPosition; i < toPosition; i++) {
      Collections.swap(adapter.getDataList(), i, i + 1);
    }
  } else {
    for (int i = fromPosition; i > toPosition; i--) {
      Collections.swap(adapter.getDataList(), i, i - 1);
    }
  }
  recyclerView.getAdapter().notifyItemMoved(fromPosition, toPosition);
  return true;
}

之前說過了，onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) 方法是用戶在拖拽 item 的時候會回調(diào)。所以關(guān)于列表排序的代碼應(yīng)該寫在這里。方法參數(shù)中的 viewHolder 代表的是用戶當前拖拽的 item ，而 target 代表的是被用戶拖拽所覆蓋的那個 item 。所以在 onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) 方法中的邏輯就是把 fromPosition 至 toPosition 為止改變它們的位置。

最后就是 onSwiped(RecyclerView.ViewHolder viewHolder, int direction) 方法了：

@Override
public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction) {
  int position = viewHolder.getAdapterPosition();
  if (direction == ItemTouchHelper.END) {
    adapter.getDataList().remove(position);
    adapter.notifyItemRemoved(position);
  }
}

這個方法在用戶進行側(cè)滑刪除操作的時候會回調(diào)，其中的邏輯就是得到當前用戶進行側(cè)滑刪除操作的 item ，然后將其刪除。

到了這里，大功告成了。那么來看看效果吧：

效果圖

改善用戶體驗

我們發(fā)現(xiàn)還有一些不完美的地方：比如當用戶在拖拽排序的時候，可以改變當前拖拽 item 的透明度，這樣就可以和其他 item 區(qū)分開來了。那么，我們需要去重寫 onSelectedChanged(RecyclerView.ViewHolder viewHolder, int actionState) 方法：

@Override
public void onSelectedChanged(RecyclerView.ViewHolder viewHolder, int actionState) {
  super.onSelectedChanged(viewHolder, actionState);
  if (actionState == ItemTouchHelper.ACTION_STATE_DRAG) {
    viewHolder.itemView.setBackgroundColor(Color.BLUE);
  }
}

相對應(yīng)地，當用戶手指從拖拽 item 中抬起的時候，我們需要把 item 的透明度復(fù)原。需要我們重寫 clearView(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) 方法：

@Override
public void clearView(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) {
  super.clearView(recyclerView, viewHolder);
  viewHolder.itemView.setBackgroundColor(0);
}

好了，來看看改進之后的效果：

改進效果圖