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

この記事では、AndroidアプリでSharedPreferencesに保存したデータを削除する方法を、実際のサンプルコードとともにステップ形式で解説します。SharedPreferencesはアプリの設定値やユーザー情報などをキーバリュー形式で手軽に保存できる仕組みですが、不要になったデータは適切に削除することが重要です。

SharedPreferencesのデータ削除の基本

SharedPreferencesからデータを削除するには、Editorオブジェクトのremove(String key)メソッドを使用します。指定したキーに紐づく値のみを削除したい場合はremove()を、すべてのデータを一括で消去したい場合はclear()メソッドを使います。変更を反映させるためには、最後にapply()またはcommit()を呼び出すことを忘れないようにしましょう。

実装手順

ステップ1：新規プロジェクトの作成

Android Studioを開き、「File」→「New Project」を選択して、必要な情報を入力して新しいプロジェクトを作成します。

ステップ2：レイアウトファイル（res/layout/activity_main.xml）の編集

以下のコードをactivity_main.xmlに追加します。画面中央に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"
    android:orientation="vertical"
    android:padding="8dp"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/textView"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginBottom="20dp"
        android:textAlignment="center"
        android:textSize="20sp"
        android:textStyle="bold" />

    <Button
        android:id="@+id/button"
        android:layout_width="match_parent"
        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:textSize="20sp"
        android:textStyle="bold" />

</LinearLayout>

ステップ3：文字列リソース（res/values/strings.xml）の追加

SharedPreferencesで使用するキー名をstrings.xmlに定義しておくことで、キーの管理がしやすくなります。

<resources>
    <string name="app_name">Sample</string>
    <string name="sharedPref_key_player">player_name</string>
    <string name="sharedPref_key_country">country_name</string>
</resources>

ステップ4：MainActivity.javaの実装

次に、srcフォルダ内のMainActivity.javaに以下のコードを記述します。起動時に「選手名」と「国名」をSharedPreferencesへ保存し、ボタンが押されると国名のデータをremove()メソッドで削除します。

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

public class MainActivity extends AppCompatActivity {

    TextView textView, tvAfterDelete;
    SharedPreferences sharedPreferences;
    SharedPreferences.Editor editor;
    Button button;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        textView = findViewById(R.id.textView);
        tvAfterDelete = findViewById(R.id.tvAfterChange);
        button = findViewById(R.id.button);

        // SharedPreferencesの初期化とデータ保存
        sharedPreferences = getPreferences(Context.MODE_PRIVATE);
        editor = sharedPreferences.edit();
        editor.putString(getResources().getString(R.string.sharedPref_key_player), "Cristiano Ronaldo");
        editor.putString(getResources().getString(R.string.sharedPref_key_country), "Portugal");
        editor.apply();

        // 保存された値の取得と表示
        String country = sharedPreferences.getString(
                getResources().getString(R.string.sharedPref_key_player), "");
        String city = sharedPreferences.getString(
                getResources().getString(R.string.sharedPref_key_country), "");

        textView.setText("SharedPreferences Values\n");
        textView.setText(textView.getText() + "Country : " + country + "\nCity : " + city);

        // ボタン押下時にデータを削除
        button.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                editor.remove(getResources().getString(R.string.sharedPref_key_country));
                editor.apply();

                String countryNow = sharedPreferences.getString(
                        getResources().getString(R.string.sharedPref_key_player), "");
                String cityNow = sharedPreferences.getString(
                        getResources().getString(R.string.sharedPref_key_country), "");

                tvAfterDelete.setText("SharedPreferences Values - After Removing City\n");
                tvAfterDelete.setText(tvAfterDelete.getText()
                        + "Country : " + countryNow + "\nCity : " + cityNow);
            }
        });
    }
}

ステップ5：AndroidManifest.xmlの確認

最後に、androidManifest.xmlが以下のようになっていることを確認してください。

<manifest xmlns:android="https://schemas.android.com/apk/res/android"
    package="app.com.sample">

    <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端末をパソコンに接続した状態で、Android Studioのツールバーにある「Run」アイコンをクリックします。デバイスの選択画面が表示されたら、接続中のスマートフォンを選択してください。

アプリが起動すると、まず保存済みのSharedPreferencesの値（Country : Cristiano Ronaldo、City : Portugal）が画面上部に表示されます。「Delete Shared Preference」ボタンをタップすると、remove()メソッドによって国名のデータが削除され、下部のTextViewに削除後の状態が表示されます。削除対象のキーの値は空文字列として取得されることが確認できます。

まとめ

SharedPreferencesの個別データを削除するポイントは以下の3つです。

• editor.remove(キー名)：指定したキーのデータのみを削除する
• editor.clear()：すべてのデータを一括削除する場合に使用する
• apply()の呼び出し忘れに注意：apply()を呼ばないと変更が反映されない

ユーザーのログアウト処理やキャッシュのクリアなど、実際のアプリ開発でも頻繁に使われるテクニックなので、ぜひマスターしておきましょう。