AndroidでSharedPreferences（共有プリファレンス）を取得してデータを保存・読み出す方法

はじめに

Androidアプリ開発では、ユーザー名やメールアドレス、各種設定値など、少量のデータを端末内に保存しておきたい場面が多くあります。こうしたデータの永続化に最適なのがSharedPreferences（共有プリファレンス）です。本記事では、SharedPreferencesを使ってデータを保存・取得・クリアする方法を、サンプルコードとともにステップごとに解説します。

SharedPreferencesとは

SharedPreferencesは、キーと値（Key-Valueペア）の形式でデータをXMLファイルとして保存する仕組みです。文字列・数値・真偽値などのプリミティブ型データを手軽に読み書きできるため、設定値や前回の入力内容の保持などに広く活用されています。

実装手順

ステップ1：新規プロジェクトを作成する

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

ステップ2：レイアウトファイル（activity_main.xml）を編集する

res/layout/activity_main.xml に以下のコードを追加します。メールアドレスと名前を入力する2つのEditTextと、「Save（保存）」「Clear Data（データ消去）」「Retrieve Data（データ取得）」の3つのボタンを縦に並べたシンプルな構成です。

<?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:orientation="vertical"
    android:padding="16dp"
    tools:context=".MainActivity">

    <EditText
        android:id="@+id/etEmail"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="20dp"
        android:ems="10"
        android:hint="Email"
        android:inputType="textEmailAddress" />

    <EditText
        android:id="@+id/etName"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:ems="10"
        android:hint="Name"
        android:inputType="text" />

    <Button
        android:layout_marginTop="50dp"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:onClick="Save"
        android:text="Save" />

    <Button
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:onClick="Clear"
        android:text="Clear Data" />

    <Button
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:onClick="Retrieve"
        android:text="Retrieve Data" />

</LinearLayout>

ステップ3：MainActivity.java を実装する

src/MainActivity.java に以下のコードを追加します。

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

public class MainActivity extends AppCompatActivity {

    EditText etName, etEmail;
    SharedPreferences sharedPreferences;

    public static final String myPreference = "myPref";
    public static final String Name = "nameKey";
    public static final String Email = "emailKey";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        etName = findViewById(R.id.etName);
        etEmail = findViewById(R.id.etEmail);
        sharedPreferences = getSharedPreferences(myPreference, Context.MODE_PRIVATE);
        if (sharedPreferences.contains(Name)) {
            etName.setText(sharedPreferences.getString(Name, ""));
        }
        if (sharedPreferences.contains(Email)) {
            etEmail.setText(sharedPreferences.getString(Email, ""));
        }
    }

    public void Clear(View view) {
        etName.setText("");
        etEmail.setText("");
        Toast.makeText(MainActivity.this, "Cleared", Toast.LENGTH_LONG).show();
    }

    public void Retrieve(View view) {
        sharedPreferences = getSharedPreferences(myPreference, Context.MODE_PRIVATE);
        if (sharedPreferences.contains(Name)) {
            etName.setText(sharedPreferences.getString(Name, ""));
        }
        if (sharedPreferences.contains(Email)) {
            etEmail.setText(sharedPreferences.getString(Email, ""));
        }
        Toast.makeText(MainActivity.this, "Retrieved", Toast.LENGTH_LONG).show();
    }

    public void Save(View view) {
        String name = etName.getText().toString();
        String email = etEmail.getText().toString();
        SharedPreferences.Editor editor = sharedPreferences.edit();
        editor.putString(Name, name);
        editor.putString(Email, email);
        editor.apply();
        Toast.makeText(MainActivity.this, "Saved", Toast.LENGTH_LONG).show();
    }
}

コードのポイントを整理しておきましょう。

• getSharedPreferences(ファイル名, モード)：指定した名前のSharedPreferencesを取得します。MODE_PRIVATEを指定すると、このアプリからのみアクセス可能になります。
• Saveメソッド：edit()でEditorオブジェクトを取得し、putString()でキーと値をセット、apply()で非同期に保存します。
• Retrieveメソッド：contains()でキーの存在を確認し、getString()で保存された値を読み出してEditTextに表示します。
• Clearメソッド：画面上の入力欄を空にします。

ステップ4：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.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を使えば、わずかなコード量でアプリ内にデータを永続化できます。なお、MODE_PRIVATEで作成したSharedPreferencesは原則として自アプリからしか参照できないため、他アプリのSharedPreferencesへ直接アクセスすることはできません。アプリ間でデータを共有したい場合は、ContentProviderやContentResolverの活用を検討してください。