KotlinでRecyclerViewを表示するミニマムサンプル

はじめに

本記事はKotlinでRecyclerViewを表示するミニマムサンプルです。
Androidで再利用可能なViewをリストで表示する際はRecyclerViewというウィジェットが使われます。

実行環境

この記事は以下の動作環境で動作確認しています。

  • Android Studio3.6.2
  • kotlin 1.3.61

準備

build.gradleにRecyclerViewを追加します。

dependencies {
    implementation "androidx.recyclerview:recyclerview:1.1.0"

登場人物

  • Activity
    • RecyclerViewを乗っける土台
  • RecyclerView
    • リストを表示するウィジット
  • ViewHolder
    • リスト一個分のView
  • Adapter
    • RecyclerViewとViewHolderの仲介役。ViewHolder管理していい感じにRecyclerViewにバインドしてくれる。

表示までのステップ

1.RecyclerViewのlayoutファイル作成
2.ViewHolder(リスト一行分)のlayout作成
3.Adapter・ViewHolder作成
4.ActivityでRecylerViewを生成

一個ずつ見ていきましょう。

表示までのステップ

RecyclerViewのlayoutファイル作成

RecyclerViewを表示したいActivityの上にRecyclerViewを乗っけます。(フラグメントを使いたい場合はフラグメントでも同じです。)

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.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">

    <androidx.recyclerview.widget.RecyclerView
        android:id="@+id/main_recycler_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />
</androidx.constraintlayout.widget.ConstraintLayout>

ViewHolder(リスト一行分)のlayout作成

次に一行分のレイアウトを作ります。
今回はこんな感じにします。ここは作りたいリストの内容次第です。

※文字直打ちだったりしますがミニマムなのでご容赦ください。

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.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"
    android:layout_margin="12dp">

    <ImageView
        android:id="@+id/hoge_image_view"
        android:layout_width="100dp"
        android:layout_height="100dp"
        android:src="@mipmap/ic_launcher"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintStart_toStartOf="parent"/>

    <TextView
        android:id="@+id/hoge_title_text_view"
        android:layout_width="0dp"
        android:layout_height="wrap_content"
        android:layout_marginLeft="12dp"
        android:text="hogeTitle"
        android:textSize="24dp"
        app:layout_constraintTop_toTopOf="@id/hoge_image_view"
        app:layout_constraintStart_toEndOf="@id/hoge_image_view"
        app:layout_constraintEnd_toEndOf="parent"/>

    <TextView
        android:id="@+id/hoge_contents_text_view"
        android:layout_width="0dp"
        android:layout_height="0dp"
        android:text="hogeContents"
        android:layout_marginTop="12dp"
        app:layout_constraintTop_toBottomOf="@id/hoge_title_text_view"
        app:layout_constraintStart_toStartOf="@id/hoge_title_text_view"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintBottom_toBottomOf="parent"/>

</androidx.constraintlayout.widget.ConstraintLayout>

Adapter・ViewHolder作成

以降順番はあんまり関係ありませんが、今回は最初にAdapterを用意します。
RecyclerViewを生成する際にAdapterのセットが必要になるからです。

class MainAdapter internal constructor(private var rowDataList: List<RowData>) : RecyclerView.Adapter<MainViewHolder>() {

    /**
     * ViewHolder作るメソッド
     * 最初しか呼ばれない。
     * ここでViewHolderのlayoutファイルをインフレーとして生成したViewHolderをRecyclerViewに返す。
     * @param parent
     * @param viewType
     * @return
     */
    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): MainViewHolder {
        val view = LayoutInflater.from(parent.context).inflate(R.layout.view_holder_main, parent, false)
        return MainViewHolder(view)
    }

    /**
     * ViewHolderとRecyclerViewをバインドする
     * 一行のViewに対して共通でやりたい処理をここで書く。今回はテキストのセットしかしてないけど。
     * @param holder
     * @param position
     */
    override fun onBindViewHolder(holder: MainViewHolder, position: Int) {
        val rowData = rowDataList[position]
        holder.hogeTitle.text = rowData.hogeTitle
        holder.hogeContents.text = rowData.hogeContents
    }

    /**
     * リストの行数
     * @return
     */
    override fun getItemCount(): Int {
        return rowDataList.size
    }
}

class MainViewHolder(itemView: View) : ViewHolder(itemView) {
    var hogeTitle: TextView = itemView.findViewById(R.id.hoge_title_text_view)
    var hogeContents: TextView = itemView.findViewById(R.id.hoge_contents_text_view)
}

ActivityでRecylerViewを生成

ActivityでRecyclerViewを生成します。
生成したらAdapterをセットします。
※今回はサンプルなので20行分データを生成してAdapterの初期化の際に渡しています。

class MainActivity : AppCompatActivity() {
    private var page = 1
    private var mainAdapter: MainAdapter? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setContentView(R.layout.activity_main)

        val recyclerView = findViewById<RecyclerView>(R.id.main_recycler_view)
        // RecyclerViewのレイアウトサイズを変更しない設定をONにする
        // パフォーマンス向上のための設定。
        recyclerView.setHasFixedSize(true)
        // RecyclerViewにlayoutManagerをセットする。
        // このlayoutManagerの種類によって「1列のリスト」なのか「2列のリスト」とかが選べる。
        val layoutManager: RecyclerView.LayoutManager = LinearLayoutManager(this)
        recyclerView.layoutManager = layoutManager
        // Adapter生成してRecyclerViewにセット
        mainAdapter = MainAdapter(createRowData(page))
        recyclerView.adapter = mainAdapter
    }

    /**
     * 20行追加する
     */
    private fun createRowData(page: Int): List<RowData> {
        val dataSet: MutableList<RowData> = ArrayList()
        var i = 1
        while (i < page * 20) {
            val data = RowData()
            data.hogeTitle = "hogeTitle" + Integer.toString(i)
            data.hogeContents = "hogeContents" + Integer.toString(i)
            val add = dataSet.add(data)
            i += 1
        }
        return dataSet
    }

    /**
     * 一行分のデータ
     */
    inner class RowData {
        var hogeTitle: String? = null
        var hogeContents: String? = null
    }
}

ここまでできたらビルドしてみます。
以下のように表示できました。

おわりに

  • リスト型の再利用可能なViewを表示したい時はRecyclerViewを使う。
  • RecyclerViewを使うためにはAdapterとViewHolderが必要。