SharedPreferences

前言

SharePreference简称SP，是Android中一种简易的轻量级存储方式。SP采用key-value（键值对）形式来存储数据，最终以xml格式的文件来持久化到存储介质上。默认的存储位置在data/data/<包名>/shared_prefs目录下，当用户卸载此应用数据时，SP保存的数据会一并清除。

使用场景

• 保存应用偏好设置（登录状态、业务开关、临时标志位等）。
• 保存格式简单的，数据量较小的数据信息。

简单使用

//获取sp对象，传入int类型mode
val sp = getSharedPreferences("test",Context.MODE_PRIVATE)
val editor = sp.edit() 
editor.putString("name", "12313kaihuang")
//commit writes its data to persistent storage immediately, whereas apply will handle it in the background
editor.apply() 

val name: String? = sp.getString("name", null)
Log.d(TAG, "initButton: name = $name")

获取sp对象有两种方式，一种是通过ComtextImpl.getPreferences方法，第二种是通过PreferenceManager.getDefaultSharedPreferences(context)，不过目前（API 30）已经过时了。

get方法可传入的mode：

• MODE_PRIVATE 代表文件私有，仅本应用程序可以访问。
• MODE_APPEND 会检查文件是否存在，若存在则往文件追加内容，否则创建新文件。
• MODE_WORLD_READABLE 除了本应用访问外还可以被其它应用程序读取）
• MODE_WORLD_WRITEABLE除了本应用访问外还可以被其它应用程序读取和写入

源码分析

时间关系先记录后面再加注释

getShareperence

public SharedPreferences getSharedPreferences(String name, int mode) {
        // At least one application in the world actually passes in a null
        // name.  This happened to work because when we generated the file name
        // we would stringify it to "null.xml".  Nice.
        if (mPackageInfo.getApplicationInfo().targetSdkVersion <
                Build.VERSION_CODES.KITKAT) {
            if (name == null) {
                name = "null";
            }
        }

        File file;
        synchronized (ContextImpl.class) {
            if (mSharedPrefsPaths == null) {
                mSharedPrefsPaths = new ArrayMap<>();
            }
            file = mSharedPrefsPaths.get(name);
            if (file == null) {
                file = getSharedPreferencesPath(name);
                mSharedPrefsPaths.put(name, file);
            }
        }
        return getSharedPreferences(file, mode);
    }

总结

commit()和apply()的区别

• commit操作是把全部的数据更新到文件，同步执行，需要确保put进去的value数据量不要太大。
• apply操作是先讲修改提交到内存，再异步执行写入文件。
• 多并发的提交commit时，需等待正在处理的commit数据更新到磁盘文件后才能继续向下执行，影响效率。而apply只是原子更新到内存，后调用apply函数会直接覆盖前面内存数据，从一定程度上提高了效率。

Sharedpreferences保存数据量不易过大
否则会带来几个问题：

• 第一次从sp中获取值的时候，有可能会阻塞主线程，使界面卡顿、掉帧。

• 解析sp的时候会产生大量的临时对象，导致频繁GC，引起界面卡顿。

• 这些key和value会存在内存中，占用内存。
  

• 高频写操作的key与高频读操作的key可以适当地拆分文件，由于减少同步锁竞争。

• 不要连续多次edit()，应该获取一次edit()，多次put操作，减少内存波动。

• 不要高频使用apply，尽可能批量提交。

• 不是进程安全的。

• 从Android N开始，不再支持MODE_WORLD_READABLE & MODE_WORLD_WRITEABLE；

参考文章

• Android 持久化组件-SharedPreferences 详解