MMKV 是基于 mmap 内存映射的 key-value 组件,底层序列化/反序列化使用 protobuf 实现,性能高,稳定性强。从 2015 年中至今在微信上使用,其性能和稳定性经过了时间的验证.
起源
微信作为一个即时通讯项目,需要记录数据比较多.需要频繁的操作记录的数据,需要一个性能强悍的存储组件,他们考察了 SharedPreferences、NSUserDefaults、SQLite 等常见组件,发现都没能满足如此苛刻的性能要求。考虑到这个防 crash 方案最主要的诉求还是实时写入,而 mmap 内存映射文件刚好满足这种需求,就尝试通过它来实现一套 key-value 组件。MMKV 就应运而生了.
MMKV 原理
- 内存准备
通过mmap 内存映射文件,提供一段可供随时写入的内存块,App 只管往里面写数据,由操作系统负责将内存回写到文件,不必担心 crash 导致数据丢失。 - 数据组织
数据序列化方面我们选用 protobuf 协议,pb 在性能和空间占用上都有不错的表现。 - 写入优化
考虑到主要使用场景是频繁地进行写入更新,我们需要有增量更新的能力。我们考虑将增量 kv 对象序列化后,append 到内存末尾。 - 空间增长
使用 append 实现增量更新带来了一个新的问题,就是不断 append 的话,文件大小会增长得不可控。我们需要在性能和空间上做个折中。
支持的数据类型
- 支持以下 Java 语言基础类型:
boolean、int、long、float、double、byte[] - 支持以下 Java 类和容器:
String、Set<String>,任何实现了Parcelable的类型
性能对比
重复读写操作 1k 次 MMKV 和 SharedPreferences、SQLite 性能对比( 机型:华为 Mate 20 Pro,版本:Android 10)
单进程.png
多进程.png
要求
- MMKV 支持 API level 16 以上平台;
- MMKV 需使用 NDK r16b 或以上进行编译 (通过源码引入 MMKV 的话)
使用
1. 引用
// 从 v1.2.8 起, MMKV 迁移到 Maven Central
implementation 'com.tencent:mmkv:1.2.12'
2. 在 App 启动时初始化 MMKV
package com.wu.material.application
import android.util.Log
import androidx.multidex.MultiDexApplication
import com.tencent.mmkv.MMKV
import com.wu.material.util.MmkvUtils
/**
* @author wkq
*
* @date 2022年03月17日 16:59
*
*@des Application 初始化操作
*
*/
class MaterialApplication : MultiDexApplication() {
override fun onCreate() {
super.onCreate()
//初始化腾讯MMKV(数据存储)
MMKV.initialize(this)
//自定义路径
//var dir = this.getFilesDir().getAbsolutePath() + "/mmkv"
//MMKV.initialize(context, dir )
}
}
注意:
一些 Android 设备(API level 19)在安装/更新 APK 时可能出错, 导致 libmmkv.so 找不到。然后就会遇到 java.lang.UnsatisfiedLinkError
之类的 crash。有个开源库 ReLinker 专门解决这个问题,你可以用它来加载 MMKV
String dir = getFilesDir().getAbsolutePath() + "/mmkv";
MMKV.initialize(dir, new MMKV.LibLoader() {
@Override
public void loadLibrary(String libName) {
ReLinker.loadLibrary(MyApplication.this, libName);
}
});
3.数据存储
/**
* 存储常规数据
*/
fun put(key: String, content: Any?): Boolean {
if (TextUtils.isEmpty(key) || content == null) return false
var mmkv = MMKV.defaultMMKV();
try {
if (content is String) {
mmkv.encode(key, content!!)
} else if (content is Double) {
mmkv.encode(key, content!!)
} else if (content is Float) {
mmkv.encode(key, content!!)
} else if (content is Int) {
mmkv.encode(key, content!!)
} else if (content is Parcelable) {
mmkv.encode(key, content!!)
} else if (content is ByteArray) {
mmkv.encode(key, content!!)
} else if (content is Long) {
mmkv.encode(key, content!!)
} else if (content is Boolean) {
mmkv.encode(key, content!!)
} else {
return false
}
} catch (exception: Exception) {
return false
}
return true
}
/**
* 存储set集合
*/
fun putSet(key: String, content: Set<String>): Boolean {
if (TextUtils.isEmpty(key) || content == null) return false
var mmkv = MMKV.defaultMMKV();
mmkv.encode(key, content!!)
return true
}
4.数据获取
// 获取数据 int 0 Double 0.0 float 0
/**
* 获取String 数据
*/
fun getString(key: String): String {
var mmkv = MMKV.defaultMMKV();
return mmkv.decodeString(key) ?: ""
String.format("", "%s /天")
}
fun getString(key: String, defult: String): String {
var mmkv = MMKV.defaultMMKV();
if (TextUtils.isEmpty(mmkv.decodeString(key))) return defult
return mmkv.decodeString(key) ?: ""
}
fun getDouble(key: String): Double {
var mmkv = MMKV.defaultMMKV();
return mmkv.decodeDouble(key)
}
fun getDouble(key: String, defult: Double): Double {
var mmkv = MMKV.defaultMMKV();
if (mmkv.decodeDouble(key) == 0.0) return defult
return mmkv.decodeDouble(key)
}
fun getFloat(key: String): Float {
var mmkv = MMKV.defaultMMKV();
return mmkv.decodeFloat(key)
}
fun getFloat(key: String, defult: Float): Float {
var mmkv = MMKV.defaultMMKV();
if (mmkv.decodeDouble(key) == 0.0) return defult
return mmkv.decodeFloat(key)
}
fun getInt(key: String): Int {
var mmkv = MMKV.defaultMMKV();
return mmkv.decodeInt(key)
}
fun getInt(key: String, defult: Int): Int {
var mmkv = MMKV.defaultMMKV();
if (mmkv.decodeInt(key) == 0) return defult
return mmkv.decodeInt(key)
}
fun getByteArray(key: String): ByteArray? {
var mmkv = MMKV.defaultMMKV()
return mmkv.decodeBytes(key) ?: null
}
fun getByteArray(key: String, defult: Int): ByteArray? {
var mmkv = MMKV.defaultMMKV();
return mmkv.decodeBytes(key) ?: null
}
fun getParcelable(key: String, clazz: Class<Parcelable>): Parcelable? {
var mmkv = MMKV.defaultMMKV()
return mmkv.decodeParcelable(key, clazz) ?: null
}
fun getSet(key: String): Set<String>? {
var mmkv = MMKV.defaultMMKV()
return mmkv.decodeStringSet(key) ?: null
}
5.数据删除
// 删除数据
fun remove(key: String) {
var mmkv = MMKV.defaultMMKV()
mmkv.removeValueForKey(key)
}
// 删除多个数据
fun remove(vararg key: String) {
var mmkv = MMKV.defaultMMKV()
var keys = arrayOfNulls<String>(key.size)
key.forEachIndexed { index, content ->
keys.set(index, content)
}
mmkv.removeValuesForKeys(keys)
}
6.数据清理
// 清理所有数据
fun clearAll() {
var mmkv = MMKV.defaultMMKV()
mmkv.clearAll()
}
总结
MMKV 是腾讯出品的基于mmap内存映射文件技术的一种数据存储的组件,相对于SharedPreferences SQlite 兼容性更好,存读取速度更快.支持常规的各种数据类型.