ノラプログラマーの技術メモ

ネットで調べても出てこなかった情報を載せていきたい技術系ブログ。

【androidアプリ開発】SharedPreferencesに配列を保存する方法

概要

androidアプリ開発でデータベース(SQLite)に登録するまでもない情報をSharedPreferencesに登録することは多いと思う。主にアプリの設定値などだ。

このSharedPreferencesに配列を保存してみた。

環境

手順

１．GJONライブラリをインポートする

String配列などはそのままSharedPreferencesに保存できないので、JSON形式に変換してから保存する。読み込む際はJSONから再び配列形式に変換する。この変換に使うのがGSONだ。

GSONはgoogleが開発したJSON変換ライブラリらしい。下記のサイトから「gson-2.3.1.jar」をダウンロードして、プロジェクトファイルの「app/libs」フォルダの中にコピーしておく。

◆GSONのjarファイルをダウンロード
The Central Repository Search Engine

ライブラリはlibsフォルダに入れておくだけで読み込まれる。便利。

２．ボタンで設定値を読み書きしてみる

メインactivityのソースコードは以下の通り。型を決めないArrayListを利用してobject形式でデータを扱うようにしている。

package net.applien.gson;

import android.content.Context;
import android.content.SharedPreferences;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;
import android.view.Menu;
import android.view.MenuItem;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;
import android.widget.Toast;
import com.google.gson.Gson;
import java.util.ArrayList;


public class MainActivity extends AppCompatActivity {

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

        // ----- 横込ボタン
        Button read_button = (Button)findViewById(R.id.read_button);
        read_button.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                // 設定値を読み込む
                SharedPreferences pref = getSharedPreferences("TEST", Context.MODE_PRIVATE);
                String json = pref.getString("key", "");

                // JSON形式を配列に保存する
                ArrayList strings = new ArrayList();
                Gson gson = new Gson();
                strings = gson.fromJson(json, ArrayList.class);

                // テキストビューに表示する
                TextView textview = (TextView) findViewById(R.id.textview);
                for (int i = 0; i < strings.size(); i++) {
                    textview.append((String) strings.get(i) + "\n");
                }
            }
        });

        // ----- 保存ボタン
        Button save_button = (Button)findViewById(R.id.save_button);
        save_button.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                // 配列を作成する
                ArrayList strings = new ArrayList();
                strings.add("value01");
                strings.add("value02");
                strings.add("value03");

                // 配列をJSON形式に変換する
                Gson gson = new Gson();
                String json = gson.toJson(strings);

                // 設定値を保存する
                SharedPreferences pref = getSharedPreferences("TEST", Context.MODE_PRIVATE);
                pref.edit().putString("key", json).commit();

                Toast.makeText(v.getContext(), "保存しました", Toast.LENGTH_SHORT).show();
            }
        });
    }

    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        // Inflate the menu; this adds items to the action bar if it is present.
        getMenuInflater().inflate(R.menu.menu_main, menu);
        return true;
    }

    @Override
    public boolean onOptionsItemSelected(MenuItem item) {
        // Handle action bar item clicks here. The action bar will
        // automatically handle clicks on the Home/Up button, so long
        // as you specify a parent activity in AndroidManifest.xml.
        int id = item.getItemId();

        //noinspection SimplifiableIfStatement
        if (id == R.id.action_settings) {
            return true;
        }

        return super.onOptionsItemSelected(item);
    }
}

レイアウトのxmlはこんな感じ。

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools" android:layout_width="match_parent"
    android:layout_height="match_parent" android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    android:paddingBottom="@dimen/activity_vertical_margin" tools:context=".MainActivity">

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical" >

        <TextView
            android:id="@+id/textview"
            android:layout_width="match_parent"
            android:layout_height="wrap_content" />
        <Button
            android:id="@+id/save_button"
            android:text="save"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content" />
        <Button
            android:id="@+id/read_button"
            android:text="read"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content" />

    </LinearLayout>
</RelativeLayout>

保存ボタンを押すと配列を設定値に保存し、読み込みボタンを押すとtextviewにその内容を表示させます。以上ー。