安卓項目實戰之SharedPreferences工具類封裝

SpUtils.java代碼如下：

public class SpUtils {

    private static SpUtils instance;
    private static SharedPreferences sp;

    private SpUtils(Context context, String name) {
        sp = context.getSharedPreferences(name, Context.MODE_PRIVATE);
    }

    /**
     * 初始化SharedPreferencesUtil,只需要初始化一次，建議在Application中初始化
     *
     * @param context 上下文對象
     * @param name    SharedPreferences Name
     */
    public static void getInstance(Context context, String name) {
        if (instance == null) {
            instance = new SpUtils(context, name);
        }
    }

    /**
     * 保存數據的方法，我們需要拿到保存數據的具體類型，然後根據類型調用不同的保存方法
     *
     * @param key
     * @param object
     */
    public static void putValue(String key, Object object) {
        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.apply(editor);
    }

    /***
     * 批量存儲數據的方法
     * @param map
     */
    public static void putManyValue(Map<String,Object> map) {
        SharedPreferences.Editor editor = sp.edit();
        // 循環遍歷map
        for (Map.Entry<String,Object> entry : map.entrySet()) {
            // 獲取鍵
            String key = entry.getKey();
            // 獲取值
            Object object = entry.getValue();
            // 判斷值的類型然後存儲
            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.apply(editor);
    }

    /**
     * 得到保存數據的方法，我們根據默認值得到保存的數據的具體類型，然後調用相對於的方法獲取值
     *
     * @param key
     * @param defaultObject
     * @return
     */
    public static Object getValue(String key, Object defaultObject) {
        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;
    }
    /**
     * 移除某個key值已經對應的值
     *
     * @param key
     */
    public static void remove(String key) {
        SharedPreferences.Editor editor = sp.edit();
        editor.remove(key);
        SharedPreferencesCompat.apply(editor);
    }
    /**
     * 清除所有數據
     */
    public static void clearAll() {
        SharedPreferences.Editor editor = sp.edit();
        editor.clear();
        SharedPreferencesCompat.apply(editor);
    }
    /**
     * 查詢某個key是否已經存在
     *
     * @param key
     * @return
     */
    public static boolean contains(String key) {
        return sp.contains(key);
    }
    /**
     * 返回所有的鍵值對
     *
     * @return
     */
    public static Map<String, ?> getAll() {
        return sp.getAll();
    }
    /**
     * 創建一個解決SharedPreferencesCompat.apply方法的一個兼容類
     * 裏面所有的commit操作使用了SharedPreferencesCompat.apply進行了替代，目的是儘可能的使用apply代替commit
     * 首先說下爲什麼，因爲commit方法是同步的，並且我們很多時候的commit操作都是UI線程中，畢竟是IO操作，儘可能異步；
     * 所以我們使用apply進行替代，apply異步的進行寫入；
     * 由於在apply是在API 9以後引入，所以有了這個兼容；
     */
    private static class SharedPreferencesCompat {
        private static final Method sApplyMethod = findApplyMethod();
        /**
         * 反射查找apply的方法
         *
         * @return
         */
        @SuppressWarnings({ "unchecked", "rawtypes" })
        private static Method findApplyMethod() {
            try {
                Class clz = SharedPreferences.Editor.class;
                return clz.getMethod("apply");
            } catch (NoSuchMethodException e) {
            }
            return null;
        }
        /**
         * 如果找到則使用apply執行，否則使用commit
         *
         * @param editor
         */
        public static void apply(SharedPreferences.Editor editor) {
            try {
                if (sApplyMethod != null) {
                    sApplyMethod.invoke(editor);
                    return;
                }
            } catch (IllegalArgumentException e) {
            } catch (IllegalAccessException e) {
            } catch (InvocationTargetException e) {
            }
            editor.commit();
        }
    }
}

如何使用

1，初始化SharedPreferencesUtil,只需要初始化一次，建議在Application中初始化

public class MyApplication extends Application {

    private static MyApplication instance;

    @Override
    public void onCreate() {
        super.onCreate();
        instance = this;
        // 在設置文件名參數時，不要帶 “.xml” 後綴，android會自動添加
        SpUtils.getInstance(this,"myapp");
    }

    public static MyApplication getInstance(){
        return instance;
    }

}

取值：
參數1：爲要獲取的value值對應的key
參數2：必須指定，當參數1指定的key不存在時，默認返回的結果，此處的參數2必須給定值，並且和接收結果的數據類型保持一致，及時獲取String類型的值，參數2也必須指定，此處指定的目的主要是表名要獲取何種類型的值，通過查看工具類的getValue方法我們也知道，返回結果的類型就是通過參數2的類型來動態判斷的。

String result = (String)SpUtils.getValue("ignore","");

設值：
參數1：key
參數2：value
該方法沒有返回值。

SpUtils.putValue("ignore","2.0.1");