SharedPreferences该怎样写

转载自SharedPreferences该怎样写

SharedPreferences 特点

即便是 Android 小白都知道的 SharedPreferences 的用法,这是保存数据最简便的方法,但是不处理好的话后期维护将是一个巨大的坑。那么该如何处理 SharedPreferences 才方便维护呢。先从它的特点开始入手吧。

● 通过 Context.getSharedPreferences() 获取的 SharedPreferences 是一个单例 SharedPreferences.edit() 每次都会创建一个新的编辑对象, commit() 之前一切改动都无效

SharedPreferences 的具体实现并不在公开 API 内,创建方法只有通 Context 获取。具体实现我们不去研究,通过 Log 打印每次获取的对象都是同一个,同样的方法可知道每次 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() , 除了写着厌烦看着难受,当遇到需要增加或减少字段时也非常不便。

SharedPreferences 该这么写

如果能保留原有写法,又能规范方法那是最好不过了,看下SharedPreferences 的接口方法并不多,很容易就写个包装类封装下。** PreferencesWrapper 是装饰模式,这里作用是替代继承,因为没法直接继承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);
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,671评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,442评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,524评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,623评论 1 275
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,642评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,584评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,953评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,621评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,865评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,608评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,698评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,378评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,958评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,940评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,173评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,419评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,425评论 2 342

推荐阅读更多精彩内容