[Android] SharedPreferencesを使ってEditTextに入力したテキストを保持する-Androidアプリ個人開発者の実践的アドバイス集

SharedPreferencesは、簡易的なデータをキーと値のペアで格納する軽量なデータストレージです。
 
アプリケーションの停止、再起動後もデータが保持されます。本記事では、この機能を使い、EditTextに一度入力したテキストをアプリケーション再起動後も保持する実装を紹介します。
 
 
 
## SharedPreferencesの特徴
 
- `SharedPreferences`はキーと値のペアでデータを保存します。
 
- 値は任意のデータ型（boolean、int、float、long、Stringなど）を指定できるため、アプリ内での状態やユーザープリファレンスなどを保持できます。

- 定義したクラス外からもアクセスできます。つまり、SharedPreferencesのキーと値をアクティビティAに定義したとして、アクティビティBからアクセスできますし、フラグメントでも同じことができます。

## SharedPreferencesのキーを準備する

まず、各コンポーネントからアクセスするためのキーを定義します。
  
設計思想によってどこにキーを保管するかは変わると思うのですが、私の場合は`enum class`を定義し、そこにキーを格納しました。これにより、安全かつ視覚的にも整理しやすくなります。

enum classの作り方としては、Android StudioでKotlinクラスファイルを作成し、そこに以下のようなenum classを定義します。

```kotlin
enum class SharedPreferencesKey {
 ETKEY1,
 ETKEY2,
 ETKEY3
} 
```
 
 
 
## SharePreferencesのキーに設定された値を取得する

`getSharedPreferences()`メソッドを使用してSharedPreferencesオブジェクトを取得します。
  
```kotlin
sharedPreferences = requireContext().getSharedPreferences("MyPrefs", Context.MODE_PRIVATE)

```
  
`Context.MODE_PRIVATE`はアクセスモードを指定するフラグであり、他のアプリからのアクセスを制限します。

次に、`sharedPreferences.getString`でキーの値を参照します。第二引数は値が格納されていなかった場合に返されるデフォルト値です。

EditTextはEditable!型を格納する必要があるため、`Editable.Factory.getInstance().newEditable()`で新しいEditableオブジェクトを生成し、EditText.textに格納しています。
 
```kotlin  
EditText.text = Editable.Factory.getInstance().newEditable(sharedPreferences.getString(SharedPreferencesKey.ETKEY1.name, ""))
```

## SharePreferencesに値を格納する

`edit()`メソッドと`apply()`メソッドを使い、SharedPreferencesの値を更新します。edit()メソッドは値の更新や削除の操作をします。
  
値の更新時、String型であればputStringを使います。
  
値の反映にはapply()メソッドかcommit()メソッドを使います。apply()メソッドは非同期で実行されるため推奨されております。一方で、commit()メソッドは同期的に実行されるためアプリケーションの低下が懸念されますが、エラーハンドリングができます。設計思想や制御フローなどによってどちらを選択するか決めるのが良いでしょう。
  
ここでは以下のようにapply()メソッドを使った例を示します。
  
  
```kotlin
val editor = sharedPreferences.edit()
editor.putString(SharedPreferencesKey.ETKEY1.name, "HOGE")
editor.apply()
```

## EditTextに入力したテキストを保持するには？

まずEditTextに入力されたテキストを「SharePreferencesに格納」し、次にEditTextを持つアクティビティやフラグメントが起動したときに「SharePreferencesのキーに設定された値を取得」し、EditText.textに書き込めば良いです。
 
どのタイミングでテキストをSharePreferencesのキーに設定するかですが、それはアプリケーションによって異なると思います。
 
例えば、私の[素数判定](https://play.google.com/store/apps/details?id=io.github.hirotakatakayama.primenumberjudgment)アプリであれば、数値がEditTextに入力された段階ではまだSharePreferencesに格納せず、素数判定ボタンをタップされた段階で格納します。そのため、ボタンの`setOnClickListener`内でSharePreferencesに格納するコードを記述しました。
 
アクティビティやフラグメント生成時にSharePreferencesのキーに設定された値を取得するには、`onCreate`か`onViewCreated`内に先ほど紹介したgetSharedPreferencesを使ったコードを記述します。
 
 
kotlinでのコード例は以下のとおりです。最初の実行では何も値が格納されていないため、デフォルト値である空文字（""）が入ります。
 
```kotlin
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
 ...
 sharedPreferences = requireContext().getSharedPreferences("MyPrefs", Context.MODE_PRIVATE)
 EditText.text = Editable.Factory.getInstance().newEditable(sharedPreferences.getString(SharedPreferencesKey.ETKEY1.name, ""))

Button.setOnClickListener {
        val editor = sharedPreferences.edit()
        editor.putString(SharedPreferencesKey.ETKEY1.name, "HOGE")
        editor.apply()
    }
}
```

[Android] SharedPreferencesを使ってEditTextに入力したテキストを保持する

0 件のコメント:

コメントを投稿

このブログを検索

ラベル

自己紹介

人気の投稿

不正行為を報告

リリースしたAndroidアプリ