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閱讀 230,321評論 6 543
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,559評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,442評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,835評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,581評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,922評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,931評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,096評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,639評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,374評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,591評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,104評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,789評論 3 349
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,196評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,524評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,322評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,554評論 2 379

推薦閱讀更多精彩內容