【Android】FragmentStateAdapterを使ったViewPager2の実装 - 駆け出しエンジニアぱかぱかの成長記録

こんにちは！ぱかぱかです！
今日は現在開発を進めている飲食店記録アプリ「グルメノート」の画面作成第１弾で、FragmentStateAdapterを使ったViewPager2の実装についてまとめたいと思います！
本当は開発を始める前にクラス図を整理しておきたかったのですが、手を動かしたくなったので画面を少し作り始めてしまいました…

今回作成するもの

今回はグルメノートアプリの骨格になる、タブで画面を切り替えるレイアウトを作成していきます。
成果物は以下のような感じです。

スワイプやタブのアイコンタップでタブを切り替えることができます。
タブ内にはフラグメントで異なるレイアウトを入れたいと思います。（今回は背景色だけ）

初めはRecyclerView.Adapterを使った実装で頑張ろうとしていたのですが、タブごとにレイアウトをマルっと変えたいならFragmentで管理した方がやりやすそう？と思ったのでFragmentStateAdapterを採用して実装していきます。
TabLayoutとViewPagerの紐付けも一緒に行うことで、タブバーの領域もカスタマイズしていきます。

レイアウトファイルの作成

今回は3つの画面（行きたい店画面・行った店画面・お気に入り店画面）をタブによって切り替えられるようにします。
以下のようなレイアウトファイルを3つ作成しました。

背景色と表示される文字列だけ、画面ごとに変えています。

<?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="match_parent"
    android:background="#98fb98">

    <TextView
        android:text="@string/wish_restaurant"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintBottom_toBottomOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

Fragmentの作成

次にレイアウトをonCreateView()に返すFragmentを作成します。
これも3つの画面についてそれぞれ作成します。

class WishRestaurantFragment: Fragment() {
    override fun onCreateView(
        inflater: LayoutInflater,
        container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        return inflater.inflate(R.layout.fragment_wish_restaurant,container,false)
    }
}

Adapterの作成

AdapterはFragmentStateAdapterを使用しました。
FragmentStateAdapterではgetItemCountとcreateFragmentの実装が求められます。

createFragment	Fragmentを新しいページとして供給
getItemCount	アダプターが作成するページの数を返す

class TabFragmentAdapter(fragment: FragmentActivity): FragmentStateAdapter(fragment) {
    companion object {
        const val TAB_NUMBER:Int = 3
    }

    override fun getItemCount(): Int {
        return TAB_NUMBER
    }

    override fun createFragment(position: Int): Fragment {
        return when (position) {
            0 -> WishRestaurantFragment()
            1 -> VisitedRestaurantFragment()
            2 -> FavoriteRestaurantFragment()
            else -> WishRestaurantFragment()
        }
    }
}

TabLayoutとViewPager2の追加

activity_main.xmlにTabLayoutとViewPager2を追加します。
TabLayoutは上のタブ名とアイコンが表示されている部分で、ViewPager2はスライドで表示が変わる画面本体になります。

<?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"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <com.google.android.material.tabs.TabLayout
        android:id="@+id/tabs"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:contentDescription="@string/tab_layout"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent" />

    <androidx.viewpager2.widget.ViewPager2
        android:layout_width="0dp"
        android:layout_height="0dp"
        android:id="@+id/pager"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/tabs"
        app:layout_constraintBottom_toBottomOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

データクラスの作成

タブバーの表示に使うデータはクラス化してしまいます。
今回はひとまず以下を持つことにしました。
・shortTitle：タブバーに表示するタイトル
・icon：タブバーに表示するアイコン

data class TabItem(
    val shortTitle: String,
    val icon: Drawable?
)

Activityの作成

先ほどのデータクラスに表示したい文字列や画像を格納してリストに入れつつ、TabLayoutMediator#attachでTabLyoutとViewPager2を紐づけTabLayout部分を表示します。
またViewPager2にTabFragmentAdapterを設定してあげることで、positionごとに表示されるFragmentが切り替わるようになります。

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // ページで利用するデータを準備
        val data = listOf(
            TabItem(getString(R.string.wish_restaurant), ContextCompat.getDrawable(this, R.drawable.tab_wish)),
            TabItem(getString(R.string.visited_restaurant), ContextCompat.getDrawable(this, R.drawable.tab_visited)),
            TabItem(getString(R.string.favorite_restaurant), ContextCompat.getDrawable(this, R.drawable.tab_favorite))
        )

        val tabs =findViewById<TabLayout>(R.id.tabs)
        val pager = findViewById<ViewPager2>(R.id.pager)

        // ViewPagerとFragmentの紐付け
        pager.adapter = TabFragmentAdapter(this)

        // TabLayout/ViewPagerの紐付け
        TabLayoutMediator(tabs, pager) {
            tab, position ->
            tab.apply {
                text = data[position].shortTitle
                contentDescription = "Page ${position + 1}"
                icon = data[position].icon
            }
        }.attach()
    }
}