SharedPreferencesはどう書きますか?

SharedPreferencesの特徴
Androidシロでも知っているSharedPreferencesの使い方は、データを保存するのに最も簡単な方法ですが、うまく処理しないと後期メンテナンスが大きな穴になります.では、SharedPreferencesをどのように処理すればメンテナンスが容易になりますか.まずはその特徴から始めましょう.

Context.を通過する.getSharedPreferences()が取得したSharedPreferencesは、一例

である

SharedPreferences.edit()は毎回新しい編集オブジェクトを作成し、commit()以前の変更はすべて無効であったSharedPreferencesの具体的な実装は公開API内ではなく、作成方法はContextによってのみ取得される.具体的には,ログ印刷によって取得されるオブジェクトは毎回同一であり,同様の方法でedit()ごとに異なるオブジェクトが得られることが分かる.

メンテナンスが困難なSharedPreferences

SharedPreference userPreferences = context.getSharedPreferences("UserInfo", Context.MODE_PRIVATE);
userPreferences.edit()
    .putString("id", "myId")
    .putString("name", "myName")
    .putString("head", "myHead")
    .commit();
Log.e("id", userPreferences.getString("id",""));
Log.e("name", userPreferences.getString("name",""));
Log.e("head", userPreferences.getString("head",""));

上記のSharedPreferencesの保存と読み取りの方法は非常に簡単で、そのためメンテナンスが容易ではありません.Keyを書き間違えたため問題が見つからないかもしれません.もちろん、一般的にはKeyを静的定数として書きます.しかし、プロジェクトが大きくなるにつれて、ユーザー情報を複数修正する必要があり、毎回put()が1つずつ必要になる可能性があり、うんざりしていると書くだけでなく、フィールドを増やしたり減らしたりする必要がある場合にも不便です.
SharedPreferencesはこう書くべきだ
既存の書き方を残して、また方法を規範化できるのが一番いいです.SharedPreferencesのインタフェースの方法は多くないので、包装類のパッケージを書くのは簡単です.

import android.content.SharedPreferences;
import android.support.annotation.Nullable;

import java.util.Map;
import java.util.Set;

/**
 * SharedPreferences    
 * Created by wittytutu on 17-3-29.
 */

public class PreferencesWrapper implements SharedPreferences {

    protected SharedPreferences mPreferences;

    public PreferencesWrapper(SharedPreferences preferences) {
        mPreferences = preferences;
    }

    @Override
    public Map getAll() {
        return mPreferences.getAll();
    }

    @Nullable
    @Override
    public String getString(String key, @Nullable String defValue) {
        return mPreferences.getString(key, defValue);
    }

    @Nullable
    @Override
    public Set getStringSet(String key, @Nullable Set defValues) {
        return mPreferences.getStringSet(key, defValues);
    }

    @Override
    public int getInt(String key, int defValue) {
        return mPreferences.getInt(key, defValue);
    }

    @Override
    public long getLong(String key, long defValue) {
        return mPreferences.getLong(key, defValue);
    }

    @Override
    public float getFloat(String key, float defValue) {
        return mPreferences.getFloat(key, defValue);
    }

    @Override
    public boolean getBoolean(String key, boolean defValue) {
        return mPreferences.getBoolean(key, defValue);
    }

    @Override
    public boolean contains(String key) {
        return mPreferences.contains(key);
    }

    @Override
    public EditorWrapper edit() {
        return new EditorWrapper(mPreferences.edit());
    }

    @Override
    public void registerOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener listener) {
        mPreferences.registerOnSharedPreferenceChangeListener(listener);
    }

    @Override
    public void unregisterOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener listener) {
        mPreferences.unregisterOnSharedPreferenceChangeListener(listener);
    }

    public static class EditorWrapper implements Editor {
        protected Editor mEditor;

        public EditorWrapper(Editor editor) {
            mEditor = editor;
        }

        @Override
        public EditorWrapper putString(String key, @Nullable String value) {
            mEditor.putString(key, value);
            return this;
        }

        @Override
        public EditorWrapper putStringSet(String key, @Nullable Set values) {
            mEditor.putStringSet(key, values);
            return this;
        }

        @Override
        public EditorWrapper putInt(String key, int value) {
            mEditor.putInt(key, value);
            return this;
        }

        @Override
        public EditorWrapper putLong(String key, long value) {
            mEditor.putLong(key, value);
            return this;
        }

        @Override
        public EditorWrapper putFloat(String key, float value) {
            mEditor.putFloat(key, value);
            return this;
        }

        @Override
        public EditorWrapper putBoolean(String key, boolean value) {
            mEditor.putBoolean(key, value);
            return this;
        }

        @Override
        public EditorWrapper remove(String key) {
            mEditor.remove(key);
            return this;
        }

        @Override
        public EditorWrapper clear() {
            mEditor.clear();
            return this;
        }

        @Override
        public boolean commit() {
            return mEditor.commit();
        }

        @Override
        public void apply() {
            mEditor.apply();
        }
    }
}

次の使用は簡単です

public class UserInfoPreferences extends PreferencesWrapper {
    private static final String NAME = "UserInfo";

    public static final KEY_ID = "id"
    public static final KEY_NAME = "name";
    public static final KEY_HEAD = "head";
    public static final KEY_SEX = "sex";

    private static volatile UserInfoPreferences mPreferences;

    public static UserInfoPreferences getInstance(Context context){
        if(mPreferences == null) {
            synchronized (UserInfoPreferences.class){
                if(mPreferences == null) {
                    SharedPreferences preferences = context.getApplicationCtontext().getShaedPreferences(NAME, Context.MODE_PRIVATE);
                    mPreferences = new UserInfoPreferences(preferences);
                }
            }
        }
        return mPreferences;
    }

    public UserInfoPreferences(SharedPreferences preferences) {
        super(preferences);
    }

    //       
    public UserInfo getUserInfo(){
        String id = mPreferences.getString(KEY_ID, "");
        String name = mPreferences.getString(KEY_NAME, "");
        String head = mPreferences.getString(KEY_HEAD, "");
        return new UserInfo(id, name, head);
    }

    @Override
    public Editor edit(){
        return new Editor(mPreferences.edit());
    }

    public static class Editor extends EditorWrapper {
        
        public Editor(SharedPreferences.Editor editor) {
            super(editor);
        }

        //       
        public Editor putUserInfo(String id, String name, String head) {

            mEditor.putString(KEY_ID, id)
                    .putString(KEY_AME, name)
                    .putString(KEY_HEAD, head);
            return this;
        }

        //       
        public Editor clearUserInfo() {

            mEditor.remove(KEY_ID)
                    .remove(KEY_NAME)
                    .remove(KEY_HEAD);
            return this;
        }
    }
}

呼び出しは拡張を容易にし、既存のメソッドも保持します.

UserInfoPreferences preferences = UserInfoPreferences.getInstance(context);
preferences.edit()
    .clearUserInfo()
    .putUserInfo("myId", "myName", "myHead")
    .putInt(KEY_SEX, 0)
    .commit();
UserInfo userInfo = preferences.getUserInfo();
int sex = preferences.getInt(KEY_SEX, 0);

本作品は知識共有署名−非商業的使用−同方式共有4.0国際ライセンス契約によりライセンスされる.転載は作者と原文のリンクを保留してください