SharePreferences保存数据（附带工具类）

概述

SharedPreferences是一个轻量级的存储类，特别适合用于保存软件配置参数。
在我们开发应用需要保存一些配置参数，这时候SharedPreferences就是一个不错的选择。

1.储存于硬盘上的xml键值对。
2.轻量级数据储存，数据多了容易引起性能问题
3.xml文件所在目录位于/data/data//shared_prefs/，可以有多个文件。

原理

1.ContextImpl记录着SharedPreferences的重要数据

1.sSharedPrefsCache:以包名为key, 二级key是以SP文件, 以SharedPreferencesImpl为value的嵌套map结构. 这里需sSharedPrefsCache是静态类成员变量, 每个进程是保存唯一一份, 且由ContextImpl.class锁保护.
2.mSharedPrefsPaths:记录所有的SP文件, 以文件名为key, 具体文件为value的map结构
3.mPreferencesDir:是指SP所在目录, 是指/data/data//shared_prefs/

2.Context.getSharedPreferences(name, mode)获取SharedPreferences，只要是Context都能获取

1.先从mSharedPrefsPaths查询是否存在相应文件
2.如果文件不存在, 则创建新的xml文件; 如果目录也不存在, 则先创建目录创建目录/data/data/package name/shared_prefs/
3.检查mode
MODE_WORLD_READABLE和MODE_WORLD_WRITEABLE 在android N开始就会抛出异常，防止外部应用读写该文件
MODE_MULTI_PROCESS 是多进程方式使用文件，由于有内存缓存的缘故这种模式下不怎么能保证进程安全，后续google不再支持。代替的方式有ContentProvider。

4.创建同名的.bak备份文件用于发生异常时, 可通过备份文件来恢复数据.
5.将xml文件加载到内存中，这个操作的线程是新开的，但是会阻塞getXXX()和setxxx()以及edit()方法。
6.一旦完全加载到内存, 后续的getXXX()则是直接访问内存

3.读取

1.在xml文件全部内加载到内存中之前，读取操作是阻塞的
2.在xml文件全部内加载到内存中之后，是直接读取内存中的数据

4.写入

1.获取一个Editor
2.putXXX的时候，只是将数据写入到内存中的一个mModified Map中
3.执行commit 或 apply操作

1.commit：

1.将mModified的数据更新到SPI的mMap中
2.当没有key发生改变, 则直接返回; 否则将mMap全部信息写入文件, 如果写入成功则删除备份文件,如果写入失败则删除mFile
3.每次commit是把全部数据更新到文件, 所以每个文件的数据量必须保证足够精简

2.apply：

1.apply跟commit的最大区别 在于apply的写入文件操作是在单线程的线程池来完成.而commit是在当前线程阻塞运行的。
2.apply方法开始的时候, 会把一个任务awaitCommit，放入一个任务队列中QueuedWork
3.单线程池会不断从QueuedWork取任务然后执行。
QueuedWork在这里存在的价值主要是用于在Stop Service, finish BroadcastReceiver过程用于 判定是否处理完所有的异步SP操作.

4.总结

1.apply因为是异步的没有返回值, commit是同步的有返回值能知道修改是否提交成功
2.多并发的提交commit时，需等待正在处理的commit数据更新到磁盘文件后才会继续往下执行，从而降低效率; 而apply只是原子更新到内存，后调用apply函数会直接覆盖前面内存数据，从一定程度上提高很多效率。 3.edit()每次都是创建新的EditorImpl对象.

5.优化

1.sp里面不要存储特别大的key/value, 有助于减少卡顿/anr
2.不要高频地使用apply和commit, 尽可能地批量提交。因为每次提交就是xml文件的全部重写
3.commit直接在主线程操作, 要注意
4.不要使用MODE_MULTI_PROCESS，多线程不应该使用SPI
5.高频写操作的key与高频读操作的key可以适当地拆分文件, 由于减少同步锁竞争
6.不要一上来就执行getSharedPreferences().edit()，因为getSharedPreferences()是在其他线程进行但是会阻塞.edit()。
7.不要连续多次edit(), 应该获取一次获取edit(),然后多次执行putxxx(), 减少内存波动。

使用SharePreferences保存数据

**
使用SharedPreferences保存数据，其背后是用xml文件存放数据，文件存放在/data/data//shared_prefs目录下。例如：

     SharedPreferences sharedPreferences =getSharedPreferences("mltest", Context.MODE_PRIVATE);
      Editor editor = sharedPreferences.edit();//获取编辑器
      editor.putString("name", "四种模式");
      editor.putInt("age", 4);
      editor.commit();//提交修改

getSharedPreferences(name,mode)方法的第一个参数用于指定该文件的名称，名称不用带后缀，后缀会由Android自动加上。方法的第二个参数指定文件的操作模式，共有四种操作模式，分别是：

Context.MODE_PRIVATE = 0 
Context.MODE_APPEND = 32768 
Context.MODE_WORLD_READABLE = 1 
Context.MODE_WORLD_WRITEABLE = 2

四种模式说明：

**Context.MODE_PRIVATE：**为默认操作模式，代表该文件是私有数据，只能被应用本身访问，在该模式下，写入的内容会覆盖原文件的内容，如果想把新写入的内容追加到原文件中。可以使用Context.MODE_APPEND
**Context.MODE_APPEND：**模式会检查文件是否存在，存在就往文件追加内容，否则就创建新文件。
Context.MODE_WORLD_READABLEContext.MODE_WORLD_WRITEABLE用来控制其他应用是否有权限读写该文件。
**MODE_WORLD_READABLE：**表示当前文件可以被其他应用读取；
**MODE_WORLD_WRITEABLE：**表示当前文件可以被其他应用写入。`

项目中我们根据自己的需要选择合适的模式

**

使用SharePreferences读取数据

**

SharedPreferences sharedPreferences = getSharedPreferences("ljq", Context.MODE_PRIVATE);
String name = sharedPreferences.getString("name", "");
int age = sharedPreferences.getInt("age", 1);
//sharedPreferences.getString("name", "");

第二个参数为缺省值，如果preference中不存在该key，将返回缺省值

工具类

我们一般都会把这种封装为工具类

 public class SPUtils {
    /**
     * 保存在手机里面的文件名
     */
    public static final String FILE_NAME = "share_data";

    /**
     * 保存数据的方法，我们需要拿到保存数据的具体类型，然后根据类型调用不同的保存方法
     *
     * @param context
     * @param key
     * @param object
     */
    public static void put(Context context, String key, Object object)
    {

        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 context
     * @param key
     * @param defaultObject
     * @return
     */
    public static Object get(Context context, String key, Object defaultObject)
    {
        SharedPreferences sp = context.getSharedPreferences(FILE_NAME,
                Context.MODE_PRIVATE);

        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 context
     * @param key
     */
    public static void remove(Context context, String key)
    {
        SharedPreferences sp = context.getSharedPreferences(FILE_NAME,
                Context.MODE_PRIVATE);
        SharedPreferences.Editor editor = sp.edit();
        editor.remove(key);
        SharedPreferencesCompat.apply(editor);
    }

    /**
     * 清除所有数据
     * @param context
     */
    public static void clear(Context context)
    {
        SharedPreferences sp = context.getSharedPreferences(FILE_NAME,
                Context.MODE_PRIVATE);
        SharedPreferences.Editor editor = sp.edit();
        editor.clear();
        SharedPreferencesCompat.apply(editor);
    }

    /**
     * 查询某个key是否已经存在
     * @param context
     * @param key
     * @return
     */
    public static boolean contains(Context context, String key)
    {
        SharedPreferences sp = context.getSharedPreferences(FILE_NAME,
                Context.MODE_PRIVATE);
        return sp.contains(key);
    }

    /**
     * 返回所有的键值对
     *
     * @param context
     * @return
     */
    public static Map<String, ?> getAll(Context context)
    {
        SharedPreferences sp = context.getSharedPreferences(FILE_NAME,
                Context.MODE_PRIVATE);
        return sp.getAll();
    }

    /**
     * 创建一个解决SharedPreferencesCompat.apply方法的一个兼容类
     *
     * @author zhy
     *
     */
    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();
        }
    }

使用方法

超级简单的使用方法

一句代码存放

SPUtils.put(this, "name","小明");

一句代码取出来

SPUtils.get(this, "name","");