安卓项目实战之好用的SharedPreferences工具类封装

版权声明：转载必须注明本文转自郭子轩的博客 https://blog.csdn.net/gpf1320253667/article/details/83152507

SpUtils.java代码如下：

public class SpUtils {
    /**
     * 保存在手机里面的文件名，在这里要特别注意，因为在Android中已经确定了SharedPreferences是以xml形式保存，
     * 所以，在填写文件名参数时，不要给定“.xml”后缀，android会自动添加。只要直接写上文件名即可
     */
    // 未用到，本例创建SharedPreferences的方式为默认方式，默认配置文件名为preferences.xml，
    // MODE_PRIVATE：表示该配置文件只能被自己的应用程序访问
    public static final String FILE_NAME = "share_data";

    private static SpUtils mInstance;
    private SharedPreferences sp;


    public static SpUtils getInstance() {
        if (mInstance == null) {
            synchronized (SpUtils.class) {
                if (mInstance == null) {
                    mInstance = new SpUtils();
                }
            }
        }
        return mInstance;
    }

    private SpUtils() {
        // SharedPreferences对象获取方式2：每个应用都有一个默认的配置文件preferences.xml，使用getDefaultSharedPreferences获取。
        sp = PreferenceManager.getDefaultSharedPreferences(MyApplication.context);
    }

    /**
     * 保存数据的方法，我们需要拿到保存数据的具体类型，然后根据类型调用不同的保存方法
     *
     * @param key
     * @param object
     */
    public void putValue(String key, Object object) {
        // SharedPreferences对象获取方式1：自定义配置文件名称
        // SharedPreferences sp = context.getSharedPreferences(FILE_NAME, Context.MODE_PRIVATE);
        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 key
     * @param defaultObject
     * @return
     */
    public 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 void remove(String key) {
        SharedPreferences.Editor editor = sp.edit();
        editor.remove(key);
        SharedPreferencesCompat.apply(editor);
    }
    /**
     * 清除所有数据
     */
    public void clearAll() {
        SharedPreferences.Editor editor = sp.edit();
        editor.clear();
        SharedPreferencesCompat.apply(editor);
    }
    /**
     * 查询某个key是否已经存在
     *
     * @param key
     * @return
     */
    public boolean contains(String key) {
        return sp.contains(key);
    }
    /**
     * 返回所有的键值对
     *
     * @return
     */
    public 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();
        }
    }
}

其中在创建SharedPreference对象时使用了默认配置文件的创建方式，为了避免内存泄漏等问题，Context对象传入Application实例，MyApplication.java代码如下：

public class MyApplication extends Application {

    public static Context context;

    @Override
    public void onCreate() {
        super.onCreate();
        context = this;
    }
}

如何使用

取值：参数1：为要获取的value值对应的key
参数2：必须指定，当参数1指定的key不存在时，默认返回的结果，此处的参数2必须给定值，并且和接收结果的数据类型保持一致，及时获取String类型的值，参数2也必须指定，此处指定的目的主要是表名要获取何种类型的值，通过查看工具类的getValue方法我们也知道，返回结果的类型就是通过参数2的类型来动态判断的。

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

设值：参数1：key
参数2：value
该方法没有返回值。

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