onSaveInstanceStateで画面回転時の状態の保存と復元【Android・Kotlin】

今回のAndroidサンプルプロジェクトでは、フラグメントを2つ作り、onSaveInstanceStateを使ったアクティビティの状態の復元を行った。


画像の拡大

ButtonFragment

ButtonFragmentを次のようにして作成した。

class ButtonFragment : Fragment() {
    private var listener: OnFragmentInteractionListener? = null

    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        val view = inflater.inflate(R.layout.fragment_button, container, false)
        view.findViewById<Button>(R.id.button)
            .setOnClickListener {
                listener?.onButtonClicked()
            }

        return view
    }


    override fun onAttach(context: Context) {
        super.onAttach(context)
        if (context is OnFragmentInteractionListener) {
            listener = context
        } else {
            throw RuntimeException(context.toString() + " must implement OnFragmentInteractionListener")
        }
    }

    override fun onDetach() {
        super.onDetach()
        listener = null
    }



    interface OnFragmentInteractionListener {
        fun onButtonClicked()
    }

}

ButtonFragmentfragmentに1つだけButtonをもつ。クリックイベントはインタフェースを介してホストアクティビティへ通知できるようにしている。

TextFragment

TextFragmentButtonFragmentでボタンがクリックされる毎にカウントアップを表示させるためのフラグメントだ。また、カウンターはファクトリーメソッドを使ってホストアクティビティから初期値を設定できるようにしている。

private const val COUNTER_KEY = "counter"

class TextFragment : Fragment() {

    private var mCounter = 0
    private lateinit var counterTextView: TextView

    fun update() {
        mCounter++
        counterTextView.text = mCounter.toString()
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        arguments?.let {
            mCounter = it.getInt(COUNTER_KEY)
        }
    }

    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        val view = inflater.inflate(R.layout.fragment_text, container, false)
        counterTextView = view.findViewById(R.id.textView)
        counterTextView.text = mCounter.toString()
        return view
    }


    companion object {
        @JvmStatic
        fun newInstance(counter: Int) =
            TextFragment().apply {
                arguments = Bundle().apply {
                    putInt(COUNTER_KEY, counter)
                }
            }
    }
}

update()メソッドは後ほどMainActivityから呼び出すことになる。

Fragmentをレイアウトファイルに設置する

今回はButtonFragmentを直接レイアウトファイルに設置し、TextFragmentMainActivityから動的に設置する。

まずButtonFragmentを設置しよう。Paletteからfragmentを探してドラッグアンドドロップする。

<fragment
		android:layout_width="0dp"
		android:layout_height="0dp" android:name="com.apppppp.trysavedinstancestate.ButtonFragment"
		android:id="@+id/buttonFragment" android:layout_marginTop="8dp"
		app:layout_constraintTop_toTopOf="@+id/guideline2" app:layout_constraintStart_toStartOf="parent"
		android:layout_marginStart="8dp" app:layout_constraintEnd_toEndOf="parent" android:layout_marginEnd="8dp"
		android:layout_marginBottom="8dp" app:layout_constraintBottom_toBottomOf="parent"
		tools:layout="@layout/fragment_button"/>


画像の拡大

図のようにlayout属性に@layout/fragment_buttonを忘れずに指定しよう。これを設定しないとコンパイルエラーとなってしまうのだ。

つぎにTextFragmentを動的に追加するためFrameLayoutを使ったコンテナを作成する。

<FrameLayout
		android:layout_width="0dp"
		android:layout_height="0dp" app:layout_constraintTop_toTopOf="parent"
		android:layout_marginTop="8dp" app:layout_constraintStart_toStartOf="parent"
		android:layout_marginStart="8dp" android:layout_marginEnd="8dp" app:layout_constraintEnd_toEndOf="parent"
		android:id="@+id/container" android:layout_marginBottom="8dp"
		app:layout_constraintBottom_toTopOf="@+id/buttonFragment">

</FrameLayout>

このコンテナに動的にTextFragmentを追加するプログラムを見てみよう。MainActivityを次のように記述する。

private const val TEXT_FRAGMENT_TAG = "textFragment"

class MainActivity : AppCompatActivity(), ButtonFragment.OnFragmentInteractionListener {

    override fun onButtonClicked() {
        val fragment = supportFragmentManager.findFragmentByTag(TEXT_FRAGMENT_TAG) as TextFragment
        fragment.update()
    }

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

        if (supportFragmentManager.findFragmentByTag(TEXT_FRAGMENT_TAG) == null) {
            supportFragmentManager.beginTransaction()
                .add(R.id.container, TextFragment.newInstance(100), TEXT_FRAGMENT_TAG)
                .commit()
        }
    }
}

注目すべきところはfragmentにTAGをつけてsupportFragmentManager.findFragmentByTagのように、どこからでも参照可能なようにしている。もし返り値がnullであるならば、まだフラグメントが生成されていないことなので、トランザクションを使用してフラグメントを新規作成している。

override fun onButtonClicked() {
	val fragment = supportFragmentManager.findFragmentByTag(TEXT_FRAGMENT_TAG) as TextFragment
	fragment.update()
}

状態の保存

ここまでのプログラムを実際に実行してみよう。カウンターの初期値に100が表示され、ボタンをクリックする毎に1づつカウントアップされるのが確認できることだろう。

しかし画面を回転するとどうだろうか?カウントアップの表示が初期化されてしまった。


画像の拡大

実は画面が回転されるとAndroidシステムがレイアウトの再ロードを行う必要があるために、アクティビティが破棄され再作成される仕様となっているのだ。詳しくは下記サイトを参考に。

そこで解決策の1つとしてonSaveInstanceState()コールバックメソッドを使った状態の保存を実装する。onSaveInstanceState()はアクティビティが破棄される前に呼び出されるメソッドだ。そのメソッド内でBundleオブジェクトを使った状態の保存を行う。保存した値はonCreate()またはonRestoreInstanceState()で受け取ることができる。

今回はカウンターの値を保存しておきたいので、TextFragmentに次のようにonSaveInstanceState()を実装した。

override fun onSaveInstanceState(outState: Bundle) {
	outState.putInt(COUNTER_KEY, mCounter)
	super.onSaveInstanceState(outState)
}

そしてonCreateメソッドを次のように書き換えた。

mCounter = savedInstanceState?.getInt(COUNTER_KEY)
			?: arguments?.getInt(COUNTER_KEY)
			?: 0

エルビス演算子を使ってsavedInstanceStateに値がなければargumentsから値を呼び出し、それでも値がなければカウンターに初期値として0を設定している。

この状態でプログラムを再度実行してみよう。ボタンを何回か押してカウントアップさせたあと画面を回転してみるとどうなるだろうか?見事、カウントの値を保持したまま再表示させることができた。


画像の拡大

まとめ

最後にこの記事で以下の内容を行ってきたことをおさらいしておこう。

  • フラグメントからイベントをホストアクティビティに通知した。
  • ファクトリーメソッドを使ってフラグメントへ初期値を渡した。
  • フラグメントをTAGを使って管理した。
  • アクティビティからフラグメントを動的に追加した。
  • onSaveInstanceStateを使って画面回転時における状態の保存と復元を行った。

デスクワークの負担を減らすアイテム

作業効率をアップさせるには姿勢が大事です!実際に使ってみてどれもオススメなのでよかったら参考に!

Bestandノートパソコンスタンド 11 '' -16 '' Macbook Air Pro/富士通と互換性のある放熱性に優れたアルミニウム合金PCスタンド-シルバー
Bestandノートパソコンスタンド 11 '' -16 '' Macbook Air Pro/富士通と互換性のある放熱性に優れたアルミニウム合金PCスタンド-シルバー

ノートパソコンの高さをあげると、長時間のデスクワークでも作業者の負担を軽減する事が可能です。 アルミニウム製品、純正品、高品質、高級感があ ります。 対応機種:MacBook、MacBook Air、MacBook Pro、富士通と対応11"-16"ノートパソコン スタンド.

Amazon
AKRacing ゲーミングチェア Pro-X V2 GREY
AKRacing ゲーミングチェア Pro-X V2 GREY

AKRacingハイエンドゲーミングチェア。大きめの座面でゆったりとした座り心地。張地を経年劣化に強い高耐久仕様のPUレザーに変更したアップグレードモデル 寸法:背もたれ幅55cm/奥行55cm/高さ95cm、座面下高さ:32~39cm、座面厚さ:13cm、重量:25kg

Amazon
Kensington ExpertMouse ワイヤレストラックボール K72359JP
Kensington ExpertMouse ワイヤレストラックボール K72359JP

接続方式/Bluetooth、2.4GHz USB付属品/レシーバー、パームレスト、日本語取扱説明書 サイズ(本体):W130×D157×H65mm 対応OS:2.4GHzUSB:Windows10/8.1/8/7、MacOS10.8以降/Bluetooth4.0LE:Windows10/8.1、MacOS10.8以降

AmazonRakuten

Anrdoidアプリ開発にオススメの書籍

こちらの本は、図や絵が多くてわかりやすく、Androidアプリ開発初心者でも理解しやすい内容。基本的なことはしっかりおさえられるので、この手の本は一冊読んでおくと良と思う。

基本からしっかり身につくAndroidアプリ開発入門
基本からしっかり身につくAndroidアプリ開発入門

圧倒的な多数のユーザーが使っているヤフーのアプリ。その制作の最前線にいる黒帯エンジニアが、ユーザーが使いやすいアプリの大切な基本をしっかりと解説します。

KindleAmazonRakuten

Kotlinの実践的な使い方が学べる内容の本で、プログラミング技術をもっと磨きたい人向け。センスの良いプログラミングがたくさん紹介されていて、個人的には「目からうろこ」の連続だった本。

Kotlinプログラミング
Kotlinプログラミング

Kotlinは、Javaとの相互運用を可能にし、Android OSでGoogleがフルサポートする静的型プログラミング言語です。この言語は、Javaだけでは十全ではない(Javaだけでは実装に手間がかかりすぎる)、軽量かつ豊かな表現形式や、他言語ではすでに実装されている最新の機能を盛り込んでいます。

KindleAmazonRakuten

Amazonでお得に購入するなら、Amazonギフト券がオススメ!

\Amazonギフトがお得/

コンビニ・ATM・ネットバンキングで¥5,000以上チャージすると、プライム会員は最大2.5%ポイント、通常会員は最大2%ポイントがもらえます!
Amazonギフト券

\この記事をシェアする/