jetpack navigationで遷移後、backをすると、ViewPager2でrestoreStateで落ちる

Question

前提・実現したいこと

jetpack navigationで画面遷移行っており、遷移後、backキーで戻るとrestoreStateで落ちてしまいます。

発生している問題・エラーメッセージ

E/AndroidRuntime: FATAL EXCEPTION: main
    Process: jp.xxx, PID: 23673
    java.lang.IllegalStateException: Fragment no longer exists for key f#0: unique id 7d1fe96a-7e94-418e-812c-cea1e01b93f6
        at androidx.fragment.app.m.d0(FragmentManager.java:784)
        at androidx.viewpager2.adapter.FragmentStateAdapter.restoreState(FragmentStateAdapter.java:549)
        at androidx.viewpager2.widget.ViewPager2.i(ViewPager2.java:350)
        at androidx.viewpager2.widget.ViewPager2.dispatchRestoreInstanceState(ViewPager2.java:375)
        at android.view.ViewGroup.dispatchRestoreInstanceState(ViewGroup.java:3886)
        at android.view.View.restoreHierarchyState(View.java:19845)
        at androidx.fragment.app.Fragment.restoreViewState(Fragment.java:573)
        at androidx.fragment.app.r.l(FragmentStateManager.java:356)
        at androidx.fragment.app.m.C0(FragmentManager.java:1201)
        at androidx.fragment.app.m.a(FragmentManager.java:2236)
        at androidx.fragment.app.m.T(FragmentManager.java:2009)
        at androidx.fragment.app.m.Q0(FragmentManager.java:1965)
        at androidx.fragment.app.m.Q(FragmentManager.java:1861)
        at androidx.fragment.app.m$d.run(FragmentManager.java:413)
        at android.os.Handler.handleCallback(Handler.java:883)
        at android.os.Handler.dispatchMessage(Handler.java:100)
        at android.os.Looper.loop(Looper.java:224)
        at android.app.ActivityThread.main(ActivityThread.java:7520)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:539)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:950)

該当のソースコード

XML

<navigation 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:id="@+id/nav_graph"
    app:startDestination="@id/list_fragment">
    <fragment
        android:id="@+id/list_fragment"
        android:name="jp.xxx.ListFragment"
        android:label="list_fragment"
        tools:layout="@layout/list_fragment" >
        <action
            android:id="@+id/action_list_fragment_to_detail_fragment"
            app:destination="@id/detail_fragment"/>
    </fragment>
    <fragment
        android:id="@+id/detail_fragment"
        android:name="jp.xxx.DetailFragment"
        android:label="detail_fragment"
        tools:layout="@layout/list_fragment">
        <argument
            android:name="url"
            app:argType="string" />
    </fragment>
</navigation>

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:android="http://schemas.android.com/apk/res/android">
    <androidx.coordinatorlayout.widget.CoordinatorLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent">
        <com.google.android.material.appbar.AppBarLayout
            android:layout_width="match_parent"
            android:layout_height="wrap_content">

            <com.google.android.material.tabs.TabLayout
                android:id="@+id/tabs"
                android:layout_width="match_parent"
                android:layout_height="wrap_content"/>
        </com.google.android.material.appbar.AppBarLayout>
        <androidx.viewpager2.widget.ViewPager2
            android:id="@+id/pager"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            app:layout_behavior="@string/appbar_scrolling_view_behavior" />
    </androidx.coordinatorlayout.widget.CoordinatorLayout>
</layout>

class RssListFragment: Fragment(){
    private lateinit var binding: ListFragmentBinding

    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
        // bindingが初期化済みでない場合(2回目、activityの再作成でfragmentを消していない場合)
        if(!::binding.isInitialized) {
            val view = inflater.inflate(R.layout.list_fragment, container, false)
            binding = ListFragmentBinding.bind(view)
        }
        return binding.root
    }
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)

        // pagerアダプタ関連設定
        mListPagerAdapter = ListPagerAdapter(this)

        // pager、tabの設定
        mViewPager = binding.pager
        mViewPager.adapter = mListPagerAdapter
        mTabLayout = binding.tabs
        mTabLayout.tabMode = TabLayout.MODE_SCROLLABLE
        TabLayoutMediator(mTabLayout, mViewPager){tab, position ->
            tab.text = position
        }.attach()
    }
}

class ListPagerAdapter(fragment: Fragment) : FragmentStateAdapter(fragment) {
    init {
        Util.log.d("コンストラクタ")
    }

    override fun createFragment(position: Int): Fragment {
        return ListFragmentContent.newInstance(position)
    }

    override fun getItemCount(): Int {
        return 5
    }

}

試したこと

PagerViewにくっついているrecyclerviewの問題と思われるので、PagerViewを破棄すると
正常に動作することは確認
mViewPager.isSaveEnabled = false
ただし、recyclerviewの位置が一番上に戻ってしまう。

navigationで遷移した場合、destroyがよばれており、stackされていないので、destroyを
よばれないようにしたかったが、やり方がわからなかった。

補足情報（FW/ツールのバージョンなど）

android 10.0
android studio 4.0.1
Android SDK Build-Tools 30.0.1
Xiaomi Redmi Note 9S

Answer 1

実際に同じ問題が起きたことがないのでコードを見ての推測になりますが、Fragmentのbindingの生成コードに問題があるのでそこが影響している可能性が高そうです。

FragmentのViewは画面遷移時に破棄/再生成される可能性があるので、それを意識せずに特定のViewやBindingのインスタンスへの参照をFragment内に保持することはViewのリークや予期せぬエラー（今回のようなケースです）を発生させる原因になります。特に、ご質問のコードのようにonCreateView内でViewの再生成を防ぐようなコードは完全にやってはいけないアンチパターンです。

bindingをFragmentのメンバとして保持する必要があるのであれば、Androidのドキュメントにも書かれているように、onCreateView/onDestroyViewで正しくViewの生成/参照の破棄を行いましょう。

もしくは、bindingをメンバとして保持せずに以下のようにonViewCreated内だけで利用すると、Viewのライフサイクルを考慮しなくていいコードが書けます。

class RssListFragment: Fragment(){

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

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)

        val binding = ListFragmentBinding.bind(view)
        // bindingを利用してView関連の初期設定...
    }
}

Comments

[tamago83]

ありがとうございます。目の前で確認できませんので、修正して、様子見をさせて頂きます。