SharedPreferences 缓存工具类SPUtil

1. 使用support包中SharedPreferencesCompat.apply()方法存储数据,解决apply()在低版本sdk兼容问题

2. 支持针对用户存储,只需修改 SharedPreferences 文件名即可

public class SPUtil {

    public static final String KEY_USER_HOBBY_DIALOG = "key_user_hobby_dialog";//用户兴趣对话框

    // @Retention 定义策略
    // 声明构造器
    @StringDef({KEY_USER_HOBBY_DIALOG,})
    @Retention(RetentionPolicy.SOURCE)
    public @interface SPKey {
    }


    private static final String USER_SP_PREFIX = "SP_USER_";
    public static String userTemp = "userTemp";


    /**
     * 获取 SharedPreferences
     *
     * @param inUserSP 是否跟用户相关
     * @return SharedPreferences
     */
    private static SharedPreferences getSharedPreferences(boolean inUserSP) {
        SharedPreferences sharedPreferences;
        if (inUserSP) {
            String name = USER_SP_PREFIX + userTemp;
            sharedPreferences = AppContext.getInstance().getApplicationContext().getSharedPreferences(name, Context.MODE_PRIVATE);
        } else {
            sharedPreferences = PreferenceManager.getDefaultSharedPreferences(AppContext.getInstance().getApplicationContext());
        }
        return sharedPreferences;
    }


    /**
     * 保存数据的方法,我们需要拿到保存数据的具体类型,然后根据类型调用不同的保存方法
     *
     * @param key    key
     * @param object value
     */

    public static void putDefaultSP(@SPKey String key, Object object) {
        put(false, key, object);
    }

    /**
     * 保存数据的方法,我们需要拿到保存数据的具体类型,然后根据类型调用不同的保存方法
     *
     * @param key    key
     * @param object value
     */
    @SuppressLint("CommitPrefEdits")
    public static void putUserSP(@SPKey String key, Object object) {
        put(true, key, object);
    }

    /**
     * 保存数据的方法,我们需要拿到保存数据的具体类型,然后根据类型调用不同的保存方法
     *
     * @param inUserSP 是否保存在与用户相关的 SharedPreferences
     * @param key      key
     * @param object   value
     */
    @SuppressLint("CommitPrefEdits")
    private static void put(boolean inUserSP, @SPKey String key, Object object) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        SharedPreferences.Editor editor = sp.edit();

        if (object instanceof String) {
            editor.putString(key, (String) object);
        } else if (object instanceof Integer) {
            editor.putInt(key, (Integer) object);
        } else if (object instanceof Boolean) {
            editor.putBoolean(key, (Boolean) object);
        } else if (object instanceof Float) {
            editor.putFloat(key, (Float) object);
        } else if (object instanceof Long) {
            editor.putLong(key, (Long) object);
        } else {
            editor.putString(key, object.toString());
        }
        SharedPreferencesCompat.EditorCompat.getInstance().apply(editor);
    }


    public static Object getFromDefaultSP(@SPKey String key, Object defaultObject) {
        return get(false, key, defaultObject);
    }

    public static Object getFromUserSP(@SPKey String key, Object defaultObject) {
        return get(true, key, defaultObject);
    }

    /**
     * 得到保存数据的方法,我们根据默认值得到保存的数据的具体类型,然后调用相对于的方法获取值
     *
     * @param inUserSP      是否从 跟用户相关的SharedPreferences中 取值
     * @param key           key
     * @param defaultObject defaultObject
     * @return Object
     */
    private static Object get(boolean inUserSP, @SPKey String key, Object defaultObject) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        if (defaultObject instanceof String) {
            return sp.getString(key, (String) defaultObject);
        } else if (defaultObject instanceof Integer) {
            return sp.getInt(key, (Integer) defaultObject);
        } else if (defaultObject instanceof Boolean) {
            return sp.getBoolean(key, (Boolean) defaultObject);
        } else if (defaultObject instanceof Float) {
            return sp.getFloat(key, (Float) defaultObject);
        } else if (defaultObject instanceof Long) {
            return sp.getLong(key, (Long) defaultObject);
        }
        return null;
    }

    public static String getFromDefaultSP(@SPKey String key, String defValue) {
        return get(false, key, defValue);
    }

    public static String getFromUserSP(@SPKey String key, String defValue) {
        return get(true, key, defValue);
    }

    private static String get(boolean inUserSP, @SPKey String key, String defValue) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        return sp.getString(key, defValue);
    }


    /*****************************  boolean  begin***************************/
    public static boolean getFromDefaultSP(@SPKey String key, boolean defValue) {
        return get(false, key, defValue);
    }

    public static boolean getFromUserSP(@SPKey String key, boolean defValue) {
        return get(true, key, defValue);
    }

    private static boolean get(boolean inUserSP, @SPKey String key, boolean defValue) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        return sp.getBoolean(key, defValue);
    }
    /*****************************  boolean  end***************************/


    /*****************************  int  begin***************************/
    public static int getFromDefaultSP(@SPKey String key, int defValue) {
        return get(false, key, defValue);
    }

    public static int getFromUserSP(@SPKey String key, int defValue) {
        return get(true, key, defValue);
    }

    private static int get(boolean inUserSP, @SPKey String key, int defValue) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        return sp.getInt(key, defValue);
    }
    /*****************************  int  end***************************/


    /*****************************  float  begin***************************/
    public static float getFromDefaultSP(String key, float defValue) {
        return  get(false, key, defValue);
    }

    public static float getFromUserSP(@SPKey String key, float defValue) {
        return get(true, key, defValue);
    }

    private static float get(boolean inUserSP, @SPKey String key, float defValue) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        return sp.getFloat(key, defValue);
    }
    /*****************************  float  end***************************/


    /*****************************  long  begin***************************/
    public static long getFromDefaultSP(@SPKey String key, long defValue) {
        return get(false, key, defValue);
    }

    public static long getFromUserSP(@SPKey String key, long defValue) {
        return get(true, key, defValue);
    }

    private static long get(boolean inUserSP, @SPKey String key, long defValue) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        return sp.getLong(key, defValue);
    }
    /*****************************  long  begin***************************/



    public static void removeFromDefaultSP(@SPKey String key) {
        remove(false, key);
    }

    public static void removeFromUserSP(@SPKey String key) {
        remove(true, key);
    }


    /**
     * 移除某个key值已经对应的值
     *
     * @param inUserSP inUserSP
     * @param key      key
     */
    @SuppressLint("CommitPrefEdits")
    private static void remove(boolean inUserSP, @SPKey String key) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        SharedPreferences.Editor editor = sp.edit();
        editor.remove(key);
        SharedPreferencesCompat.EditorCompat.getInstance().apply(editor);
    }


    public static void clearDefaultSP() {
        clear(false);
    }

    public static void clearUserSP() {
        clear(true);
    }

    /**
     * 清除所有数据
     *
     * @param inUserSP inUserSPSP
     */
    @SuppressLint("CommitPrefEdits")
    private static void clear(boolean inUserSP) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        SharedPreferences.Editor editor = sp.edit();
        editor.clear();
        SharedPreferencesCompat.EditorCompat.getInstance().apply(editor);
    }

    public static boolean containsInDefaultSP(@SPKey String key) {
        return contains(false, key);
    }

    public static boolean containsInUserSP(@SPKey String key) {
        return contains(true, key);
    }

    /**
     * 查询某个key是否已经存在
     *
     * @param inUserSP inUserSP
     * @param key      key
     * @return boolean
     */
    private static boolean contains(boolean inUserSP, @SPKey String key) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        return sp.contains(key);
    }

    public static Map<String, ?> getAllFromDefault() {
        return getAll(false);
    }

    public static Map<String, ?> getAllFromUser() {
        return getAll(true);
    }

    /**
     * 返回所有的键值对
     *
     * @param inUserSP inUserSP
     * @return Map
     */
    private static Map<String, ?> getAll(boolean inUserSP) {
        SharedPreferences sp = getSharedPreferences(inUserSP);
        return sp.getAll();
    }
}


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

推荐阅读更多精彩内容