MMVK替换SP实现本地数据持有化

引言

最近将项目中的sharedpreference替换了微信开源的mmkv框架，记录下两者之前的性能对比和mmvk的简单封装使用

MMKV原理

• 内存准备
  通过 mmap 内存映射文件，提供一段可供随时写入的内存块，App 只管往里面写数据，由操作系统负责将内存回写到文件，不必担心 crash 导致数据丢失。
• 数据组织
  数据序列化方面我们选用 protobuf 协议，pb 在性能和空间占用上都有不错的表现。
• 写入优化
  考虑到主要使用场景是频繁地进行写入更新，我们需要有增量更新的能力。我们考虑将增量 kv 对象序列化后，append 到内存末尾。
• 空间增长
  使用 append 实现增量更新带来了一个新的问题，就是不断 append 的话，文件大小会增长得不可控。我们需要在性能和空间上做个折中。

替换原因

• SharedPreference缺点
  https://www.jianshu.com/p/c4fa942d8153 请阅读这位博主的博客

• MMKV优点

1，数据加密。 在 Android 环境里，数据加密是非常必须的，SP实际上是把键值对放到本地文件中进行存储。如果要保证数据安全需要自己加密，MMKV 使用了 AES CFB-128 算法来加密/解密。

2，多进程共享。系统自带的 SharedPreferences 对多进程的支持不好。现有基于 ContentProvider 封装的实现，虽然多进程是支持了，但是性能低下，经常导致 ANR。考虑到 mmap 共享内存本质上是多进程共享的，MMKV 在这个基础上，深入挖掘了Android 系统的能力，提供了可能是业界最高效的多进程数据共享组件。

3，匿名内存。 在多进程共享的基础上，考虑到某些敏感数据(例如密码)需要进程间共享，但是不方便落地存储到文件上，直接用 mmap 不合适。而Android 系统提供了 Ashmem 匿名共享内存的能力，它在 进程退出后就会消失，不会落地到文件上，非常适合这个场景。MMKV 基于此也提供了 Ashmem(匿名共享内存) MMKV 的功能。

4，效率更高。MMKV 使用protobuf进行序列化和反序列化，比起SP的xml存放方式，更加高效。

5，支持从 SP迁移，如果你之前项目里面都是使用SP，现在想改为使用MMKV，只需几行代码即可将之前的SP实现迁移到MMKV。

支持的数据类型

1，支持以下 Java 语言基础类型：

 boolean、int、long、float、double、byte[]

2，支持以下 Java 类和容器：

String、Set< String >

任何实现了Parcelable的类型

使用

1.添加依赖库

dependencies {
 implementation 'com.tencent:mmkv:1.0.23'
}

2.在application中初始化

MMKV.initialize(this); 

3.获取mmkv实例

正常单一业务储存
MMKV kv = MMKV.defaultMMKV();

如果不同业务需要区别存储，也可以单独创建自己的实例：
MMKV mmkv = MMKV.mmkvWithID("MyID");

默认支持单进程的，如果业务需要多进程访问，则需要加上标志位 MMKV.MULTI_PROCESS_MODE：
MMKV mmkv = MMKV.mmkvWithID("InterProcessKV", MMKV.MULTI_PROCESS_MODE);

自定义跟目录，MMKV 默认把文件存放在$(FilesDir)/mmkv/目录。你可以在 App 启动时自定义根目录：
String dir = getFilesDir().getAbsolutePath() + "/mmkv_2";
String rootDir = MMKV.initialize(dir);

class SpUtils private constructor() {
    private var mv: MMKV = MMKV.defaultMMKV()

    /**
     * 保存数据的方法，我们需要拿到保存数据的具体类型，然后根据类型调用不同的保存方法
     *
     * @param key
     * @param object
     */
    fun encode(key: String?, `object`: Any) {
        if (`object` is String) {
            mv.encode(key, `object`)
        } else if (`object` is Int) {
            mv.encode(key, `object`)
        } else if (`object` is Boolean) {
            mv.encode(key, `object`)
        } else if (`object` is Float) {
            mv.encode(key, `object`)
        } else if (`object` is Long) {
            mv.encode(key, `object`)
        } else if (`object` is Double) {
            mv.encode(key, `object`)
        } else if (`object` is ByteArray) {
            mv.encode(key, `object`)
        } else {
            mv.encode(key, `object`.toString())
        }
    }

    fun encodeSet(key: String?, sets: Set?) {
        mv.encode(key, sets)
    }

    fun encodeParcelable(key: String?, obj: Parcelable?) {
        mv.encode(key, obj)
    }

    /**
     * 得到保存数据的方法，我们根据默认值得到保存的数据的具体类型，然后调用相对于的方法获取值
     */
    fun decodeInt(key: String?): Int {
        return mv.decodeInt(key, 0)
    }

    fun decodeDouble(key: String?): Double {
        return mv.decodeDouble(key, 0.00)
    }

    fun decodeLong(key: String?): Long {
        return mv.decodeLong(key, 0L)
    }

    fun decodeBoolean(key: String?): Boolean {
        return mv.decodeBool(key, false)
    }

    fun decodeFloat(key: String?): Float {
        return mv.decodeFloat(key, 0f)
    }

    fun decodeBytes(key: String?): ByteArray {
        return mv.decodeBytes(key)
    }

    fun decodeString(key: String?): String {
        return mv.decodeString(key, "")
    }

    fun decodeStringSet(key: String?): Set {
        return mv.decodeStringSet(key, emptySet())
    }

    fun  decodeParcelable(key: String?, tClass: Class?): T {
        return mv.decodeParcelable(key, tClass)
    }

    /**
     * 移除某个key对
     *
     * @param key
     */
    fun removeKey(key: String?) {
        mv.removeValueForKey(key)
    }

    /**
     * 清除所有key
     */
    fun clearAll() {
        mv.clearAll()
    }
    /**
     * 从sp中迁移到mmvk
     */
    fun testImportSharedPreferences(context: Context){
        val old_man = context.getSharedPreferences("myData", Context.MODE_PRIVATE)
        // 迁移旧数据
        mv.importFromSharedPreferences(old_man);
        // 清空旧数据
        old_man.edit().clear().commit();
    }



    companion object {
        private var mInstance: SpUtils? = null

        /**
         * 初始化MMKV,只需要初始化一次，建议在Application中初始化
         *
         */
        val instance: SpUtils?
            get() {
                if (mInstance == null) {
                    synchronized(SpUtils::class.java) {
                        if (mInstance == null) {
                            mInstance = SpUtils()
                        }
                    }
                }
                return mInstance
            }
    }

}