【Android】RecyclerViewで文字列リストをソート表示する方法を実例付きで解説

はじめに：RecyclerViewとは

RecyclerViewのソート機能について解説する前に、まずAndroidにおける「RecyclerView」が何なのかを簡単に確認しておきましょう。

RecyclerViewは、従来のListViewをより高度に進化させたUIコンポーネントです。ViewHolderデザインパターンに基づいて動作し、大量のアイテムを効率的に描画できる点が最大の特徴です。グリッド形式でもリスト形式でもアイテムを柔軟に表示できます。

本記事では、学生の氏名と年齢を一覧表示するシンプルな学籍管理アプリを題材に、RecyclerViewのアイテムを文字列（氏名）順に並べ替える方法を段階的に解説していきます。

実装手順

ステップ1：新規プロジェクトの作成

Android Studioを起動し、メニューからFile → New Projectを選択して、必要事項を入力して新しいプロジェクトを作成します。

ステップ2：build.gradleへの依存関係の追加

次に、build.gradleファイルを開き、RecyclerViewライブラリの依存関係を追加します。

apply plugin: 'com.android.application'
android {
    compileSdkVersion 28
    defaultConfig {
        applicationId "com.example.andy.tutorialspoint"
        minSdkVersion 19
        targetSdkVersion 28
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'com.android.support:appcompat-v7:28.0.0'
    implementation 'com.android.support:design:28.0.0'
    implementation 'com.android.support.constraint:constraint-layout:1.1.3'
    implementation 'com.android.support:recyclerview-v7:28.0.0'
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'com.android.support.test:runner:1.0.2'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}

ステップ3：activity_main.xmlの編集

res/layout/activity_main.xmlに以下のコードを記述します。

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout
    xmlns:android="https://schemas.android.com/apk/res/android"
    xmlns:tools="https://schemas.android.com/tools"
    xmlns:app="https://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:layout_behavior="@string/appbar_scrolling_view_behavior"
    tools:showIn="@layout/activity_main"
    tools:context=".MainActivity">
    <android.support.v7.widget.RecyclerView
        android:id="@+id/recycler_view"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:scrollbars="vertical" />
</RelativeLayout>

上記のコードでは、RelativeLayoutを親レイアウトとして、その中にRecyclerViewを配置しています。

ステップ4：MainActivity.javaの実装

続いて、src/MainActivity.javaに以下のコードを追加します。

package com.example.andy.tutorialspoint;
import android.annotation.TargetApi;
import android.os.Build;
import android.os.Bundle;
import android.support.annotation.RequiresApi;
import android.support.design.widget.TabLayout;
import android.support.v4.view.ViewPager;
import android.support.v7.app.AppCompatActivity;
import android.support.v7.widget.DividerItemDecoration;
import android.support.v7.widget.LinearLayoutManager;
import android.support.v7.widget.RecyclerView;
import android.support.v7.widget.Toolbar;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
public class MainActivity extends AppCompatActivity {
    private RecyclerView recyclerView;
    private StudentAdapter studentAdapter;
    private List studentDataList =new ArrayList<>();
    @TargetApi(Build.VERSION_CODES.O)
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        recyclerView = findViewById(R.id.recycler_view);
        studentAdapter=new StudentAdapter(studentDataList);
        RecyclerView.LayoutManager manager=new LinearLayoutManager(this);
        recyclerView.setLayoutManager(manager);
        recyclerView.addItemDecoration(new DividerItemDecoration(this, LinearLayoutManager.VERTICAL));
        recyclerView.setAdapter(studentAdapter);
        StudentDataPrepare();
    }
    @RequiresApi(api = Build.VERSION_CODES.N)
    private void StudentDataPrepare() {
        studentData data=new studentData("sai",25);
        studentDataList.add(data);
        data=new studentData("sai",25);
        studentDataList.add(data);
        data=new studentData("raghu",20);
        studentDataList.add(data);
        data=new studentData("raj",28);
        studentDataList.add(data);
        data=new studentData("amar",15);
        studentDataList.add(data);
        data=new studentData("bapu",19);
        studentDataList.add(data);
        data=new studentData("chandra",52);
        studentDataList.add(data);
        data=new studentData("deraj",30);
        studentDataList.add(data);
        data=new studentData("eshanth",28);
        studentDataList.add(data);
        Collections.sort(studentDataList, new Comparator() {
            @Override
            public int compare(studentData o1, studentData o2) {
                return o1.name.compareTo(o2.name);
            }
        });
    }
}

上記のコードでは、RecyclerViewとStudentAdapterをセットアップしています。アダプターには学生データのArrayList（氏名と年齢を含む）を渡しています。

ソートのポイント

RecyclerViewのアイテムを比較・並べ替えるには、Javaのコレクションフレームワークが提供するCollections.sort()メソッドを使用します。

Collections.sort(studentDataList, new Comparator() {
    @Override
    public int compare(studentData o1, studentData o2) {
        return o1.name.compareTo(o2.name);
    }
});

このコードでは、各要素のnameフィールドをcompareTo()で比較することにより、リスト全体を氏名のアルファベット順にソートしています。

ステップ5：StudentAdapter.javaの作成

次に、src/StudentAdapter.javaを以下のように実装します。

package com.example.andy.tutorialspoint;
import android.support.annotation.NonNull;
import android.support.v7.widget.RecyclerView;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.TextView;
import java.util.List;
class StudentAdapter extends RecyclerView.Adapter {
    List studentDataList;
    public StudentAdapter(List studentDataList) {
        this.studentDataList=studentDataList;
    }
    @NonNull
    @Override
    public MyViewHolder onCreateViewHolder(@NonNull ViewGroup viewGroup, int i) {
        View itemView = LayoutInflater.from(viewGroup.getContext())
        .inflate(R.layout.student_list_row, viewGroup, false);
        return new MyViewHolder(itemView);
    }
    @Override
    public void onBindViewHolder(MyViewHolder viewHolder, int i) {
        studentData data=studentDataList.get(i);
        viewHolder.name.setText(data.name);
        viewHolder.age.setText(String.valueOf(data.age));
    }
    @Override
    public int getItemCount() {
        return studentDataList.size();
    }
    class MyViewHolder extends RecyclerView.ViewHolder {
        TextView name,age;
        public MyViewHolder(View itemView) {
            super(itemView);
            name=itemView.findViewById(R.id.name);
            age=itemView.findViewById(R.id.age);
        }
    }
}

アダプタークラスは、主に以下の4つの要素で構成されています。

• onCreateViewHolder() — ViewHolderを生成し、行ビューを返します。
• onBindViewHolder() — データを生成済みのViewHolderにバインド（紐付け）します。
• getItemCount() — 表示対象リストの件数を返します。
• MyViewHolderクラス — RecyclerView.ViewHolderを継承した内部クラスで、各行のビュー参照を保持します。

ステップ6：student_list_row.xmlの作成

リストの1行分のレイアウトを定義するres/layout/student_list_row.xmlは以下の通りです。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="https://schemas.android.com/apk/res/android"
    android:orientation="horizontal" android:layout_width="match_parent"
    android:weightSum="1"
    android:layout_height="wrap_content">
    <TextView
        android:id="@+id/name"
        android:layout_width="0dp"
        android:layout_weight="0.5"
        android:gravity="center"
        android:textSize="15sp"
        android:layout_height="100dp" />
    <TextView
        android:id="@+id/age"
        android:layout_width="0dp"
        android:layout_weight="0.5"
        android:gravity="center"
        android:textSize="15sp"
        android:layout_height="100dp" />
</LinearLayout>

このリスト項目レイアウトでは、「氏名」と「年齢」を表示するための2つのTextViewを横並びで配置しています。

ステップ7：studentData.javaの作成

最後に、学生データを格納するモデルクラスsrc/studentData.javaを作成します。

package com.example.andy.tutorialspoint;
class studentData {
    String name;
    int age;
    public studentData(String name, int age) {
        this.name=name;
        this.age=age;
    }
}

このクラスは、学生の氏名（String）と年齢（int）を保持するデータオブジェクトを表しています。

アプリの実行と動作確認

ここまでの実装が完了したら、実際にアプリを起動してみましょう。実機のAndroidスマートフォンをPCに接続した状態で、Android StudioのツールバーにあるRun（再生）アイコンをクリックします。接続中のデバイスを選択すると、アプリが端末にインストールされて起動します。

起動直後の画面では、氏名がアルファベットのA（amar）から昇順にソートされた状態で表示されます。

画面を下にスクロールすると、残りの学生データも同じく氏名順に並んでいることが確認できます。

まとめ

本記事では、AndroidのRecyclerViewに表示する文字列データを、Collections.sort()とComparatorを使ってアルファベット順に並べ替える方法を紹介しました。ポイントは以下の3つです。

• RecyclerViewはViewHolderパターンに基づく高性能なリスト／グリッド表示コンポーネントであること
• データの並べ替えはCollections.sort()＋Comparatorで行い、アダプターに渡す前にソートしておくこと
• 年齢など別の条件で並べ替えたい場合は、compare()内の比較対象フィールドを変更すればよいこと

この手法を応用すれば、降順ソートや複数条件でのソートなども簡単に実装できるので、ぜひ試してみてください。