sharedpreferencesでアプリを一度閉じた後もデータを保持し続けたい

Question

実現したいこと

sharedpreferencesでデータを保存し、アプリを一度閉じても保存されたデータが読み込まれるようにしたい。

前提

sharedpreferencesでデータを保存しようとしているが、アプリを一度閉じた後にもう一度見てみるとデータが初期化されている。
具体的には駅の名前を保存しようとしている。駅の名前を入力したときにstation1Name変数がnullだったら代入し、変数の中身を表示しているテキストボックスの横にあるデリートボタンを押すと変数の中身をnullに変更するようになっている。それぞれapply()はしているため保存はされているはず。

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

特にエラーは発生していない

該当のソースコード

package com.example.CompetitionApp

import android.content.Context
import android.os.Bundle
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import androidx.fragment.app.Fragment
import com.example.CompetitionApp.R
import com.example.CompetitionApp.databinding.FragmentHomeBinding

private const val ARG_PARAM1 = "param1"
private const val ARG_PARAM2 = "param2"

class HomeFragment : Fragment() {
    // TODO: Rename and change types of parameters
    private var param1: String? = null
    private var param2: String? = null

    private var _binding: FragmentHomeBinding? = null
    private val binding get() = _binding!!

    //データ保存の準備
    val sharedPref = getActivity()?.getSharedPreferences(
        getString(R.string.preference_file_key), Context.MODE_PRIVATE)
    val editor = sharedPref ?.edit()

    //変数を定義
    var station1Name: String? = sharedPref?.getString("Station1Name", "NoData")

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        arguments?.let {
            param1 = it.getString(ARG_PARAM1)
            param2 = it.getString(ARG_PARAM2)
        }
    }

    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View {
        _binding = FragmentHomeBinding.inflate(layoutInflater, container, false)
        val view = binding.root

        // ボタンクラスのインスタンス作成
        val btnListener = BtnListener()

        // リスナを設定
        binding.searchbutton.setOnClickListener(btnListener)

        binding.stationsearch

        if(station1Name != null){
            binding.station1.text = station1Name
        }

        return view
    }

    //binding 解放
    override fun onDestroyView() {
        super.onDestroyView()
        _binding = null
    }

    companion object {
        fun newInstance(param1: String, param2: String) =
            HomeFragment().apply {
                arguments = Bundle().apply {
                    putString(ARG_PARAM1, param1)
                    putString(ARG_PARAM2, param2)
                }
            }
    }

    //ボタンが押されたときの設定
    private inner class BtnListener: View.OnClickListener{
        override fun onClick(v: View) {
            when(v.id){
                binding.searchbutton.id -> {
                    //検索ボタンの処理
                    val searchstation: String = binding.stationsearch.getText().toString()
                    //入力がなければ何もしない
                    if(searchstation != ""){
                        //新しく入力された値を代入
                        if(station1Name == null){
                            station1Name = searchstation
                            editor?.putString("Station1Name", station1Name)
                            editor?.apply()
                            binding.station1.text = station1Name
                        }
                    }
                }

                //デリートボタンが押された時の処理
                binding.station1del.id -> {
                    station1Name = null

                    editor?.putString("Station1Name", station1Name)
                    editor?.apply()

                    binding.station1.text = getString(R.string.nodata)
                }
            }
        }
    }
}

試したこと

データが消えてしまう条件がアプリを閉じたときのみであることを確かめたが、この場合どうすればいいのかは調べても出てこず、全く見当がつかない。

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

・ほかのfragmentに移動して戻ってきた後
・バックグラウンドに行った後
・実行しているエミュレータをスリープにしてもう一度起動した後
以上の3パターンはデータが残っていることを確認している。

Answer 1

そもそも SharedPreference オブジェクト自体を得られてないのではないでしょうか。

val sharedPref = getActivity()?.getSharedPreferences(

Fragment オブジェクトの生成時はまだ Activity とリンクしていませんので、 getActivity() は null を返します。
sharedPref が null なら editor も null になり、 putString も apply も実行されません。

・ほかのfragmentに移動して戻ってきた後
・バックグラウンドに行った後
・実行しているエミュレータをスリープにしてもう一度起動した後

は、 SharedPreference に保存・再生されたのでは無く、 Fragment 自体が残っていて、各 EditText や TextView の値が Fragment によって保存・再生されたのでは無いでしょうか。

※こちらの環境により、パッケージを変えています

package com.teratail.q_rdjw8xeirai92w

import android.content.Context
import android.os.Bundle
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import androidx.fragment.app.Fragment
import com.teratail.q_rdjw8xeirai92w.databinding.FragmentHomeBinding

class HomeFragment : Fragment() {
  companion object {
    //要らないものは消しておく. パラメータは互換性のため.
    fun newInstance(param1: String, param2: String) = HomeFragment()

    private const val PREFERENCE = "preference_file" //リソースから取る程のものでもなさそう
    private const val PREF_STATION1_NAME = "Station1Name"
    private const val CLEAR_VALUE = "NoData"
  }

  private var _binding: FragmentHomeBinding? = null
  private val binding get() = _binding!!

  //onCreateView は生成のみ
  override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View {
    _binding = FragmentHomeBinding.inflate(layoutInflater, container, false)
    return binding.root
  }

  //それぞれの処理はこちらに
  override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    super.onViewCreated(view, savedInstanceState)

    val sharedPref = requireActivity().getSharedPreferences(PREFERENCE, Context.MODE_PRIVATE)

    //最期の設定値を取り込み(無ければ "NoData")
    binding.station1.text = sharedPref.getString(PREF_STATION1_NAME, CLEAR_VALUE);

    //検索ボタンの処理
    binding.searchbutton.setOnClickListener {
      val searchstation = binding.stationsearch.getText().toString()
      if(searchstation != ""){
        //保存
        sharedPref.edit().putString(PREF_STATION1_NAME, searchstation).apply() //Editor は随時取り出し
        binding.station1.text = searchstation
      }
    }

    //削除ボタンの処理
    binding.station1del.setOnClickListener {
      //クリア
      sharedPref.edit().remove(PREF_STATION1_NAME).apply()
      binding.station1.text = CLEAR_VALUE
    }
  }

  override fun onDestroyView() {
    _binding = null
    super.onDestroyView()
  }
}

Comments

[gogatsu]

　jimbe様、詳しい回答をいただき、ありがとうございました。いただいたプログラムを実行した結果、考えていた通りの結果を得ることができ、アプリを閉じた後もデータが保存されていました。
　自分なりに元のものといただいたプログラムを比べ、いろいろ実行してみた結果、
private const val PREFERENCE = "preference_file"
private const val PREF_STATION1_NAME = "Station1Name"
private const val CLEAR_VALUE = "NoData"
の部分は他のfragmentでもここで保存したものを使用したいため、もともとのstring.xmlから持ってくる形にしようと思います。

　しかし、わからなかったことがいくつかあるため、質問をさせてください。
1,
paramに関係すること。
private var param1: String? = null
private var param2: String? = null

super.onCreate(savedInstanceState)
arguments?.let {
param1 = it.getString(ARG_PARAM1)
param2 = it.getString(ARG_PARAM2)
}
などの部分を、なぜ
fun newInstance(param1: String, param2: String) = HomeFragment()
の一行でまとめられるかがわからない。

2,
private inner class BtnListener: View.OnClickListener{}
内で記述していたボタンが押されたときの処理について、なぜこれがViewの初期化のためのイベント内で処理できるのかがわからない。

3,
onViewCreatedの一番最初の行にある、
super.onViewCreated(view, savedInstanceState)
がどのような意味なのかが分からない。

　以上の3点について、差し支えなければお時間のある時にご回答いただけると幸いです。よろしくお願いいたします。

[jimbe]

>他のfragmentでもここで保存したものを使用したい

なるほど。事情はそれぞれですのでコードは幾らでも弄ってください^^
ただ、他のフラグメントでも使うなら、 private を外して他から定義を使うことも出来ます。
”NoData” は表示する文字列ですので国際化等の観点からリソースにするのが正解ですが、 Preference の名前等は言ってしまえば他と区別出来れば何でも良い類ですので、リソースにする意味はありません。
(定義を使い回すなら書くのはココでは無く Activity のほうが良さそうですが。)

1 の生成部分ですが、恐らくこの HomeFragment は AndroidStudio でプロジェクトを生成した時のコードを改造されているものと思います。
AndroidStudio でプロジェクトを生成する際に選択する雛形はそれぞれの機能のサンプルも兼ねていて、フラグメントが関係する雛形ではフラグメントの生成に getInstance を使ってパラメータを2つ指定するような形を作り出します。この2つのパラメータは特別フラグメントに必要なわけでは無く、単に『フラグメントの生成時に何かデータを渡したいならこのように出来ます』というサンプルとしてあるだけです。
ですが質問のコードは param1/param2 を使っていません。従ってそれに関する部分を削除しました。
ただし、 getInstance メソッドのパラメータを削除してしまうと getInstance を使っている方も修正しないといけませんから、回答としては呼ぶ側の修正も載せないとコードとして完結しません。しかし質問には呼ぶ側のコードはご提示されていませんので修正・提示することは不可能です。
従って、呼ぶ側の修正はしなくてすむように getInstance メソッドのパラメータだけは残しました。

2 の OnClickListener ですが、これは"定義"であって"処理"ではありません。
これは kotlin の書き方・見え方にも問題があるのですが、
setOnClickListener { ～ }
という書き方は
setOnClickListener( { ～ } )
と同じ意味で、 kotlin ではパラメータの最後のラムダ式は () の外に書けるという文法(?)があるのです。

{ ～ }
は(型推論により)
View.OnClickListener { ～ }
と同じですし、もちろんこれは
View.OnClickListener( { ～ } )
のことです。
kotlin ではこのように要らないモノはどんどん省略することで記述量を減らすことが良いとされています。
これは自然言語でも一文で全てを説明するのではなく文脈によって一部を省略したりするのと同じと思いますが、一方で一部だけを見ると何のことを言っているのか分からなくなり易いとも言えると思います。

3 の継承元の呼び出しですが、今回は必ずしも必要ありません。
ですがクラスによっては継承元のクラスでも何か処理をしている場合があり、その場合は override 元のメソッドを呼ばなければなりません。( onDestroyView がそうですね。)
呼ぶ必要が有るか無いかはドキュメントに書いてあったりしますが、一々メソッド毎に確認するよりはいっそ書いておけば問題無いということも言えます。

[gogatsu]

ご回答ありがとうございました。

1について、もともと書かれていたコードは消したら何か起こりそうで怖くて消せない...という感じがあり残していましたが、ただのサンプルだとは思っていませんでした...確認不足です。
2について、ラムダ式については持っている書籍で読んだことがありましたが、いまいちよくわからないまま進めていました。省略の仕方がよくわかっていないため、もう一度読み直そうと思います。
3について、クラスと継承についての知識もまだほとんどないに等しいため、勉強していこうと思います。

[gogatsu]

jimbe様、質問にも詳しく答えていただき、本当にありがとうございました。

[jimbe]

クリックリスナの書き方(の遷移)についての記事がありましたので貼っておきます

【Kotlin】何気なく書いているsetOnClickListenerについて
https://qiita.com/tacotopas/items/aa7f4f4e01a534be6bba

[gogatsu]

ありがとうございます！
よく読んで理解できるように頑張ります。