KotlinでAndroidアプリのSharedPreferencesデータを削除する方法を解説

この記事では、Kotlinを使ってAndroidアプリのSharedPreferencesデータを削除する方法を、実際のサンプルコードとともにわかりやすく解説します。

デモの概要

アプリ起動時に選手名と国名をSharedPreferencesへ保存し、ボタンをタップすると国名のデータだけを削除します。削除前後の値を画面に表示することで、削除処理の動作を視覚的に確認できるシンプルなサンプルです。

手順1：新規プロジェクトを作成する

Android Studioを起動し、メニューから「File」→「New Project」を選択します。必要な項目を入力して、新しいプロジェクトを作成してください。

手順2：レイアウトファイルを編集する（res/layout/activity_main.xml）

以下のコードをactivity_main.xmlに追加します。保存済みの値を表示するTextView、「Delete Shared Preference」ボタン、削除後の結果を表示するTextViewを縦方向に並べた構成です。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="https://schemas.android.com/apk/res/android"
    xmlns:tools="https://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:gravity="center_horizontal"
    android:orientation="vertical"
    android:padding="8dp"
    tools:context=".MainActivity">
    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="100dp"
        android:layout_marginBottom="100dp"
        android:textAlignment="center"
        android:textColor="@android:color/holo_green_dark"
        android:textSize="32sp"
        android:textStyle="bold" />
    <TextView
        android:id="@+id/textView"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginBottom="20dp"
        android:textAlignment="center"
        android:textColor="@android:color/background_dark"
        android:textSize="20sp"
        android:textStyle="bold" />
    <Button
        android:id="@+id/button"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Delete Shared Preference" />
    <TextView
        android:id="@+id/tvAfterChange"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="10dp"
        android:textAlignment="center"
        android:textColor="@android:color/holo_red_light"
        android:textSize="20sp"
        android:textStyle="bold" />
</LinearLayout>

手順3：MainActivity.ktに処理を記述する

src/MainActivity.ktに以下のコードを追加します。onCreate()内でSharedPreferencesにデータを書き込み、ボタンがクリックされたタイミングでeditor.remove()を呼び出し、指定したキーのデータを削除しています。

import android.content.Context
import android.content.SharedPreferences
import android.os.Bundle
import android.widget.Button
import android.widget.TextView
import androidx.appcompat.app.AppCompatActivity

class MainActivity : AppCompatActivity() {
    lateinit var textView: TextView
    lateinit var tvAfterDelete: TextView
    lateinit var sharedPreferences: SharedPreferences
    lateinit var editor: SharedPreferences.Editor
    lateinit var button: Button

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        textView = findViewById(R.id.textView)
        tvAfterDelete = findViewById(R.id.tvAfterChange)
        button = findViewById(R.id.button)
        title = "KotlinApp"

        sharedPreferences = getPreferences(Context.MODE_PRIVATE)
        editor = sharedPreferences.edit()
        editor.putString(resources.getString(R.string.sharedPref_key_player), "Cristiano Ronaldo")
        editor.putString(resources.getString(R.string.sharedPref_key_country), "Portugal")
        editor.apply()

        val player = sharedPreferences.getString(resources.getString(R.string.sharedPref_key_player), "")
        val country = sharedPreferences.getString(resources.getString(R.string.sharedPref_key_country), "")
        textView.text = "SharedPreferences Values\nPlayer : $player\nCountry : $country"

        button.setOnClickListener {
            editor.remove(resources.getString(R.string.sharedPref_key_country))
            editor.apply()
            val playerNow = sharedPreferences.getString(resources.getString(R.string.sharedPref_key_player), "")
            val countryNow = sharedPreferences.getString(resources.getString(R.string.sharedPref_key_country), "")
            tvAfterDelete.text = "SharedPreferences Values - After Removing Country\nPlayer : $playerNow\nCountry : $countryNow"
        }
    }
}

ポイント：特定のキーだけを削除したい場合はremove(キー名)を、SharedPreferences内の全データを一括で消去したい場合はclear()を使用します。どちらの場合も、変更を確定させるために必ずapply()（またはcommit()）を呼び出すのを忘れないようにしましょう。

手順4：文字列リソースを追加する（res/values/strings.xml）

SharedPreferencesのキーとして使用する文字列をstrings.xmlに定義します。

<string name="sharedPref_key_player">player_name</string>
<string name="sharedPref_key_country">country_name</string>

手順5：AndroidManifest.xmlを確認する

androidManifest.xmlに以下のコードを記述します。SharedPreferencesの操作には特別なパーミッションは不要です。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android" package="app.com.q10">
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

アプリを実行して動作を確認する

それでは、アプリを実行してみましょう。実機のAndroid端末をPCに接続していることを前提とします。Android Studioでプロジェクト内のアクティビティファイルを開き、ツールバーのRunアイコンをクリックしてください。デバイスの選択画面が表示されるので、接続したモバイルデバイスを選択します。アプリが起動すると、まず保存済みのSharedPreferencesの値が画面に表示されます。

「Delete Shared Preference」ボタンをタップすると、国名（country_name）のデータが削除され、削除後のSharedPreferencesの値が画面下部に赤字で表示されます。選手名のデータはそのまま残っていることも確認できます。