RecyclerView를 DiffUtil.Callback 으로 성능 향상하기

유저가 목록을 스크롤할 때 데이터를 업데이트 해야한다. 필요없으면 안 해도 되지만..

이를 위해서는 서버에서 데이터를 가져와 아이템을 업데이트 해야할 수도 있는데 이런 과정에서 지연이 길어지면 UX에 영향을 미치기 시작해서 가능한 적은 리소스와 함께 빠른 작업이 필요하다.

기존에는 목록의 내용이 변경되면 notifyDataSetChanged()를 호출하여 아이템을 업데이트 해 왔지만 이건 비용이 많이 들기 때문에 DiffUtil를 개발해주었다.

 

DiffUtil?

RecyclerView Support Library v7의 24.2.0버전에 DiffUtil이라는 매우 편리한 유틸리티 클래스가 생겼다.

이 클래스는 두 목록간의 차이점을 찾고 업데이트 되어야 할 목록을 반환해주는 클래스다.

Eugene W. Myers’s의 차이 알고리즘을 이용하여 최소한의 업데이트 수를 계산한다고 한다.

 

어떻게 사용하나?

DiffUtil.Callback은 추상 클래스이며 두 목록 간의 차이를 계산하는 동안 DiffUtil에 의해 콜백 클래스로 사용된다.

4개의 추상 메소드와 1개의 비추상 메소드로 이루어져있고, 이를 확장하고 모든 메소드를 오버라이드해야 한다~

• getOldListSize(): 이전 목록의 개수를 반환
• getNewListSize(): 새로운 목록의 개수를 반환
• areItemsTheSame(int oldItemPosition, int newItemPosition): 두 객체가 같은 항목인지 여부를 결정
• areContentsTheSame(int oldItemPosition, int newItemPosition): 두 항목의 데이터가 같은지 여부를 결정, areItemsTheSame()이 true를 반환하는 경우에만 호출
• getChangePayload(int oldItemPosition, int newItemPosition): 만약 areItemTheSame()이 true를 반환하고 areContentsTheSame()이 false를 반환하면 이 메서드가 호출되어 변경 내용에 대한 페이로드를 가져옴

예제

public class Employee {
    public int id;
    public String name;
    public String role;
}

 

public class EmployeeDiffCallback extends DiffUtil.Callback {
    private final List<Employee> mOldEmployeeList;
    private final List<Employee> mNewEmployeeList;

    public EmployeeDiffCallback(List<Employee> oldEmployeeList, List<Employee> newEmployeeList) {
        this.mOldEmployeeList = oldEmployeeList;
        this.mNewEmployeeList = newEmployeeList;
    }

    @Override
    public int getOldListSize() {
        return mOldEmployeeList.size();
    }

    @Override
    public int getNewListSize() {
        return mNewEmployeeList.size();
    }

    @Override
    public boolean areItemsTheSame(int oldItemPosition, int newItemPosition) {
        return mOldEmployeeList.get(oldItemPosition).getId() == mNewEmployeeList.get(
                newItemPosition).getId();
    }

    @Override
    public boolean areContentsTheSame(int oldItemPosition, int newItemPosition) {
        final Employee oldEmployee = mOldEmployeeList.get(oldItemPosition);
        final Employee newEmployee = mNewEmployeeList.get(newItemPosition);

        return oldEmployee.getName().equals(newEmployee.getName());
    }

    @Nullable
    @Override
    public Object getChangePayload(int oldItemPosition, int newItemPosition) {
        // Implement method if you're going to use ItemAnimator
        return super.getChangePayload(oldItemPosition, newItemPosition);
    }
}

 

DiffUtil.Callback 구현이 완료되면 아래 설명 된대로 RecyclerViewAdapter의 목록 변경사항을 업데이트!

public class CustomRecyclerViewAdapter extends RecyclerView.Adapter<CustomRecyclerViewAdapter.ViewHolder> {
  ...
       public void updateEmployeeListItems(List<Employee> employees) {
        final EmployeeDiffCallback diffCallback = new EmployeeDiffCallback(this.mEmployees, employees);
        final DiffUtil.DiffResult diffResult = DiffUtil.calculateDiff(diffCallback);

        this.mEmployees.clear();
        this.mEmployees.addAll(employees);
        diffResult.dispatchUpdatesTo(this);
    }
}

 

DiffUtil.dispactUpdatesTo(RecyclerView.Adapter adapter)를 호출 하여 업데이트할 Adapter를 전달한다.

diff계산에서 반환된 DiffResult 객체가 변경사항을 Adapter에 전달하고 어댑터가 변경 사항에 대해 알림을 받는다.

getChangePayload()에서 반환 된 객체는 notifyItemRangeChanged(position, count, payload)를 DiffResult에서 호출하여 결론적으로 onBindViewHolder(… List payloads) 메서드가 호출되어 목록이 업데이트 된다.

이때 업데이트될 목록은 정말 업데이트가 필요한 아이템만 호출되어 불필요한 업데이트는 하지 않는다.

@Override
public void onBindViewHolder(ProductViewHolder holder, int position, List<Object> payloads) {
  // Handle the payload
}

 

DiffUtil은 RecyclerView.Adapter의 다양한 데이터 업데이트 메서드를 사용하여 알립니다.

• notifyItemMoved()
• notifyItemRangeChanged()
• notifyItemRangeInserted()
• notifyItemRangeRemoved()

 

중요

목록이 많으면 작업에 상당한 시간이 걸릴 수 있으므로 백그라운드 스레드에서 실행하고 DiffUtil.DiffResult를 가져와서 메인스레드(UI스레드)의 RecyclerView에 적용하는 게 좋다.

또한 구현 제약으로 목록의 최대 크기는 2²⁶개로 제한되어 있다고 한다.

 

성능

DiffUtil은 두 목록 간의 추가 및 제거 작업의 최소 수를 찾기 위해 O(N) 공간이 필요하다.

예상되는 성능은 O(N + D²)입니다.

• N: 추가 및 제거 된 항목의 총 수
• D: 스크립트 길이

 

https://developer.android.com/reference/android/support/v7/util/DiffUtil.html

https://github.com/AnkitSinhal/DiffUtilExample