본문 바로가기
안드로이드 자바

[Android][Java]RecyclerView-Selection 라이브러리 사용

by teamnova 2022. 12. 22.
728x90

안녕하세요

오늘은 RecyclerView-selection 라이브러리를 사용해서 이미지 선택기를 구현해 보겠습니다

RecyclerView-selection 라이브러리는 사용자의 입력을 사용하여 리사이클러뷰의 아이템을 선택 할 수 있도록 합니다. 이 때, 시각적 표현을 제어할 수도 있습니다. 

 

흐름을 정리하면 다음과 같습니다. 

1. 리사이클러뷰 어댑터를 생성할 때, PhotoAdapter.getPhotoList() 를 사용해서 외부저장소에 있는 이미지를 가져옵니다.

2. SelectionTracker를 빌드합니다.
2. onBindViewHolder() 에서 아이템에 이미지와 slectionTracker를 붙혀줍니다.

 

먼저 모듈의 build.gradle 항목의 dependency를 추가합니다. 

dependencies {
    implementation "androidx.recyclerview:recyclerview:1.2.1"
    // For control over item selection of both touch and mouse driven selection
    implementation "androidx.recyclerview:recyclerview-selection:1.1.0"
}

ItemDetailsLookup 클래스를 상속받는 클래스를 구현 합니다.

import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.support.v7.widget.RecyclerView;
import android.util.Log;
import android.view.MotionEvent;
import android.view.View;

import androidx.recyclerview.selection.ItemDetailsLookup;
/**
 * 2 아이템 디테일 룩업 구현
 * ItemDetailsLookup<T> 클래스는 사용자의 선택과 관련된 항목에 대한 정보를 제공합니다.
 * MotionEvent를 기반하여 선택된 내용을 ViewHolder에 매핑합니다. *
 * */
public class PhotoDetailsLookUp extends ItemDetailsLookup<Long> {

    private RecyclerView recyclerView;
    public PhotoDetailsLookUp(RecyclerView recyclerView){
        Log.d("PhotoDetailsLookUp", "PhotoDetailsLookUp: ");
        this.recyclerView = recyclerView;
    }
    /**상속받은 ItemDetailsLookup의 메서드를 재정의합니다.
     * */
    @Nullable
    @Override
    public ItemDetails<Long> getItemDetails(@NonNull MotionEvent motionEvent) {
        Log.d("PhotoDetailsLookUp", "getItemDetails: ");
        View view = recyclerView.findChildViewUnder(motionEvent.getX(), motionEvent.getY());
        if (view != null) {
            LookUpViewHolder viewHolder = (LookUpViewHolder) recyclerView.getChildViewHolder(view);
            return viewHolder.getItemDetails();
        }
        return null;
    }
}

 

다음은 adapter 클래스 입니다

public class PhotoAdapter extends RecyclerView.Adapter<LookUpViewHolder> {
    private final String TAG=this.getClass().getSimpleName();
    private List<Photo> photoList;
    private Context context;

    @Nullable
    private SelectionTracker<Long> selectionTracker;

    /**
     * //1 photoAdapter 생성자
     * */
    protected PhotoAdapter(Context context) {
        Log.d(TAG, "PhotoAdapter: ");
        this.context = context;
        setHasStableIds(true);
        photoList = getPhotoList(context);
        notifyDataSetChanged();
    }

    @NonNull
    @Override
    public LookUpViewHolder onCreateViewHolder(@NonNull ViewGroup viewGroup, int position) {
        View view = LayoutInflater.from(viewGroup.getContext()).inflate(R.layout.view_photo,viewGroup,false);
        return new LookUpViewHolder(view);
    }

    @Override
    /**
     * 7. Adapter 에서 이제 selectionTracker 를 참조할 수 있게 되었습니다.
     * 뷰홀더가 바인딩 되는 시점에 selectionTracker 의 정보를 읽어 선택내용에 대한 UI를 결정할 수 있습니다.
     * */
    public void onBindViewHolder(@NonNull LookUpViewHolder lookUpViewHolder, int position) {
        Log.d(TAG, "onBindViewHolder: ");
        Photo photo = photoList.get(position);
        lookUpViewHolder.setPhoto(photo);
        lookUpViewHolder.setSelectionTracker(selectionTracker);
    }

    @Override
    public int getItemCount() {
        return photoList.size();
    }

    @Override
    //2. 아이템 지정
    public long getItemId(int position) {
        return position;
    }

    private List<Photo> getPhotoList(Context context){
        Log.d(TAG, "getPhotoList: ");
        String[] projection = new String[]{MediaStore.Images.Media.DISPLAY_NAME,MediaStore.Images.Media.DATA};
        Cursor cursor = context.getContentResolver().query(MediaStore.Images.Media.EXTERNAL_CONTENT_URI,
                projection,
                null,
                null,
                null);

        ArrayList<Photo> photoList = new ArrayList<>();
        while(cursor.moveToNext()){
            String name = cursor.getString(cursor.getColumnIndex(projection[0]));
            String path = cursor.getString(cursor.getColumnIndex(projection[1]));;
            Photo photo = new Photo(name, path);
            photoList.add(photo);
        }
        Log.d(TAG, "getPhotoList: while 후");
        cursor.close();
        return photoList;
    }
    /**
     * 6. SelectionTracker 를 만들었다면, Adapter 에 setter 를 만들어SelectionTracker 를 넘겨줍니다.
     * */
    public void setSelectionTracker(SelectionTracker<Long> selectionTracker) {
        Log.d(TAG, "setSelectionTracker: SelectionTracker 를 만들었다면, Adapter 에 setter 를 만들어SelectionTracker 를 넘겨줍니다.");
        this.selectionTracker = selectionTracker;
    }
}

adapter 구현시 필요한 ViewHolder

public class PhotoAdapter extends RecyclerView.Adapter<LookUpViewHolder> {
    private final String TAG=this.getClass().getSimpleName();
    private List<Photo> photoList;
    private Context context;

    @Nullable
    private SelectionTracker<Long> selectionTracker;

    /**
     * //1 photoAdapter 생성자
     * */
    protected PhotoAdapter(Context context) {
        Log.d(TAG, "PhotoAdapter: ");
        this.context = context;
        setHasStableIds(true);
        photoList = getPhotoList(context);
        notifyDataSetChanged();
    }

    @NonNull
    @Override
    public LookUpViewHolder onCreateViewHolder(@NonNull ViewGroup viewGroup, int position) {
        View view = LayoutInflater.from(viewGroup.getContext()).inflate(R.layout.view_photo,viewGroup,false);
        return new LookUpViewHolder(view);
    }

    @Override
    /**
     * 7. Adapter 에서 이제 selectionTracker 를 참조할 수 있게 되었습니다.
     * 뷰홀더가 바인딩 되는 시점에 selectionTracker 의 정보를 읽어 선택내용에 대한 UI를 결정할 수 있습니다.
     * */
    public void onBindViewHolder(@NonNull LookUpViewHolder lookUpViewHolder, int position) {
        Log.d(TAG, "onBindViewHolder: ");
        Photo photo = photoList.get(position);
        lookUpViewHolder.setPhoto(photo);
        lookUpViewHolder.setSelectionTracker(selectionTracker);
    }

    @Override
    public int getItemCount() {
        return photoList.size();
    }

    @Override
    //2. 아이템 지정
    public long getItemId(int position) {
        return position;
    }

    private List<Photo> getPhotoList(Context context){
        Log.d(TAG, "getPhotoList: ");
        String[] projection = new String[]{MediaStore.Images.Media.DISPLAY_NAME,MediaStore.Images.Media.DATA};
        Cursor cursor = context.getContentResolver().query(MediaStore.Images.Media.EXTERNAL_CONTENT_URI,
                projection,
                null,
                null,
                null);

        ArrayList<Photo> photoList = new ArrayList<>();
        while(cursor.moveToNext()){
            String name = cursor.getString(cursor.getColumnIndex(projection[0]));
            String path = cursor.getString(cursor.getColumnIndex(projection[1]));;
            Photo photo = new Photo(name, path);
            photoList.add(photo);
        }
        Log.d(TAG, "getPhotoList: while 후");
        cursor.close();
        return photoList;
    }
    /**
     * 6. SelectionTracker 를 만들었다면, Adapter 에 setter 를 만들어SelectionTracker 를 넘겨줍니다.
     * */
    public void setSelectionTracker(SelectionTracker<Long> selectionTracker) {
        Log.d(TAG, "setSelectionTracker: SelectionTracker 를 만들었다면, Adapter 에 setter 를 만들어SelectionTracker 를 넘겨줍니다.");
        this.selectionTracker = selectionTracker;
    }
}

이미지정보를 갖는 Photo class

public class Photo {
    private String name;
    private String path;
    public Photo(String name, String path) {
        this.name = name;
        this.path = path;
    }
    public String getName() {
        return name;
    }
    public String getPath() {
        return path;
    }
}

MainActivity.class

public class MainActivity extends AppCompatActivity {
    public final String TAG = MainActivity.class.getSimpleName();
    private static final int REQ_CODE_PERMISSION = 0;

    RecyclerView recyclerView;
    PhotoAdapter photoAdapter;
    SelectionTracker<Long> selectionTracker;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        /**
         *  외부저장소에 대한 접근권한요청
         * */
        ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.READ_EXTERNAL_STORAGE}, REQ_CODE_PERMISSION );
    }
    /**
     *  권한 요청의 결과를 다시 호출합니다. 이 메서드는 requestPermissions에 대한 모든 호출에 대해 호출됩니다.
     * */
    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults);
        if(requestCode == REQ_CODE_PERMISSION){
            for(int grantResult :grantResults){
                if(grantResult == PackageManager.PERMISSION_DENIED){ // 권한 거부시 finish();
                    finish();
                    return;
                }
            }
            setupUI(); // UI 초기화
        }
    }

    private void setupUI(){ Log.d(TAG, "setupUI: UI셋팅시작");
        setContentView(R.layout.activity_main);
        recyclerView = findViewById(R.id.recycler_view);
        photoAdapter = new PhotoAdapter(this);
        recyclerView.setAdapter(photoAdapter);
        recyclerView.setLayoutManager(new GridLayoutManager(this, 3));
        setupSelectionTracker();
        photoAdapter.setSelectionTracker(selectionTracker);
    }
    /**
     * 5 SelectionTracker 만들기
     * Warning : SelectionTracker 는 반드시 RecyclerView 에 Adapter 가 참조된 이후에 만들어야 합니다.
     * 그렇지 않으면 IllegalArgumentException 이 발생됩니다.
     * *selectionId : 선택내용 대한 Id를 지정합니다.
     * recyclerView : 선택내용을 추적할 RecyclerView 를 지정합니다.
     * keyProvider : 캐시를 위한 선택되는 아이템의 Key 제공자
     * itemDetailsLookup : RecyclerView 아이템의 대한 정보
     * storage : saved state 에서 키를 저장하기 위한 전략
     * */
    private void setupSelectionTracker(){
        Log.d(TAG, "setupSelectionTracker: ");
        selectionTracker = new SelectionTracker.Builder<>(
                "selection_id",
                recyclerView,
                new StableIdKeyProvider(recyclerView), //1. ItemKeyProvider 를 상속받은 StableIdKeyProvider 를 빌드 합니다.
                new PhotoDetailsLookUp(recyclerView),
                StorageStrategy.createLongStorage()).
                withSelectionPredicate(SelectionPredicates.<Long>createSelectAnything())
                .build();
        /**withSelectionPredicate :
         * 어떠한 선택을 할지 결정할 수 있게 합니다. Selection 라이브러리에서
         * 제공하는 SelectionPredicates.createSelectionAnything()을 쓸 수도 있고,
         * 자신만의 SelectionPredicate 를 만들 수도 있습니다.
         * */

        /**4. selectionTracker 에 SelectionObserver 를 등록하여 선택이 변경될 때 알림을 받습니다
         *
         * */
        selectionTracker.addObserver(new SelectionTracker.SelectionObserver() {
            @Override
            public void onItemStateChanged(@NonNull Object key, boolean selected) {
                super.onItemStateChanged(key, selected);
            }
            @Override
            public void onSelectionRefresh() {
                super.onSelectionRefresh();
            }
            @Override
            public void onSelectionChanged() {
                super.onSelectionChanged();
            }
            @Override
            public void onSelectionRestored() {
                super.onSelectionRestored();
            }
        });

    }

    @Override
    protected void onResume() {
        super.onResume();
    }
}

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.ConstraintLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">
    <android.support.v7.widget.RecyclerView
            android:layout_width="match_parent"
            android:id="@+id/recycler_view"
            android:layout_height="match_parent"/>
</android.support.constraint.ConstraintLayout>

view_photo // 이미지 레이아웃

<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.ConstraintLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:app="http://schemas.android.com/apk/res-auto"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" >
    <ImageView android:layout_width="0dp"
               android:id="@+id/image"
               app:layout_constraintDimensionRatio="1:1"
               app:layout_constraintStart_toStartOf="parent"
               app:layout_constraintEnd_toEndOf="parent"
               app:layout_constraintTop_toTopOf="parent"
               app:layout_constraintBottom_toBottomOf="parent"
               android:layout_height="0dp"/>
    <ImageView android:layout_width="24dp"
               android:id="@+id/checkbox"
               app:layout_constraintEnd_toEndOf="parent"
               app:layout_constraintTop_toTopOf="parent"
               android:layout_margin="8dp"
               android:layout_height="24dp"/>
</android.support.constraint.ConstraintLayout>