MMKV 是基于 mmap 内存映射的 key-value 组件,底层序列化 / 反序列化使用 protobuf 实现,性能高,稳定性强。从 2015 年中至今,在 iOS 微信上使用已有近 3 年,其性能和稳定性经过了时间的验证。近期也已移植到 Android 平台,一并开源。
MMKV 源起
在微信客户端的日常运营中,时不时就会爆发特殊文字引起系统的 crash,参考文章,文章里面设计的技术方案是在关键代码前后进行计数器的加减,通过检查计数器的异常,来发现引起闪退的异常文字。在会话列表、会话界面等有大量 cell 的地方,希望新加的计时器不会影响滑动性能;另外这些计数器还要永久存储下来 ------ 因为闪退随时可能发生。这就需要一个性能非常高的通用 key-value 存储组件,我们考察了 SharedPreferences、NSUserDefaults、SQLite 等常见组件,发现都没能满足如此苛刻的性能要求。考虑到这个防 crash 方案最主要的诉求还是实时写入,而 mmap 内存映射文件刚好满足这种需求,我们尝试通过它来实现一套 key-value 组件。
MMKV 原理
- 内存准备 通过 mmap 内存映射文件,提供一段可供随时写入的内存块,App 只管往里面写数据,由操作系统负责将内存回写到文件,不必担心 crash 导致数据丢失。
数据组织 数据序列化方面我们选用 protobuf 协议,pb 在性能和空间占用上都有不错的表现。
- 写入优化 考虑到主要使用场景是频繁地进行写入更新,我们需要有增量更新的能力。我们考虑将增量 kv 对象序列化后,append 到内存末尾。
- 空间增长 使用 append 实现增量更新带来了一个新的问题,就是不断 append 的话,文件大小会增长得不可控。我们需要在性能和空间上做个折中。
Android 安装指南(android_setup_cn · Tencent/MMKV Wiki · GitHub
)
基本要求
- MMKV 支持 API level 16 以上平台;
- MMKV 需使用 NDK r16b 或以上进行编译 (通过源码引入 MMKV 的话)
安装引入
从 v1.2.8 起, MMKV 迁移到 Maven Central。老版本 (<= v1.2.7) 仍然在 JCenter。 在 App 模块的 build.gradle 文件里添加:
python
dependencies {
implementation 'com.tencent:mmkv:1.3.2'
// replace "1.3.2" with any available version
}
Gradle 在编译工程的时候会自动从 maven 仓库下载 AAR 包。
MMKV 默认以静态库形式链接 libc++。这个库如果动态链接,会额外占用 2MB 空间(解压后)。如果你已经有其他库引入了 libc++_shared.so,并且你确保他们的库没有版本兼容问题,你可以使用动态链接 libc++ 的 MMKV,以进一步减少安装包大小:
python
dependencies {
implementation 'com.tencent:mmkv-shared:1.3.2'
// replace "1.3.2" with any available version
}
性能对比
循环写入随机的 int 1k 次,我们有如下性能对比:
image.png
MMKV 支持多进程访问。
快速上手
实现应用的存储功能通常在App启动时就要开始初始化其对象,所以我们在自定义 Application 内对 MMKV 初始化。
kotlin
class GlobalApplication : Application() {
override fun onCreate() {
super.onCreate()
// 初始化
String rootDir = MMKV.initialize(this) // 返回mmkv的默认存储路径(files/mmkv/)
}
}
MMKV 默认把文件存放在$(FilesDir)/mmkv/目录。可以在 MMKV初始化时自定义根目录
dart
String dir = getFilesDir().getAbsolutePath() + "/mmkv";
String rootDir = MMKV.initialize(dir);
MMKV 创建实例:
kotlin
// 获取 MMKV 默认全局实例,一般选用这个,本文也是选择这个进行实例创建
val mmkv = MMKV.defaultMMKV()
// 根据设置 id 来自定义 MMKV 对象。比如根据业务来区分的存取实例
val mmkv = MMKV.mmkvWithID("ID")
// 开启多进程访问。默认是单线程
val mmkv = MMKV.mmkvWithID("ID",MMKV.MULTI_PROCESS_MODE)
写数据:
bash
kv.encode("bool", true);
kv.encode("int", Integer.MIN_VALUE);
kv.encode("string", "Hello from mmkv");
读数据:
dart
boolean bValue = kv.decodeBool("bool");
int iValue = kv.decodeInt("int");
String str = kv.decodeString("string");
删除数据:
dart
删除单个key:removeValueForKey(String key)
删除多个key:removeValuesForKeys(String[] arrKeys)
清空所有数据:clearAll()
从 SharedPreferences 迁移到 MMKV
为了演示怎么迁移,我们重头再来,在准备部分的代码基础上临时创建 SharedPreferences 储存数据。
kotlin
val sp = getSharedPreferences("test", Context.MODE_PRIVATE)
val edit = sp.edit()
// 为了验证顺利迁移,我们初始值设置为10
edit.putInt("number",10);
edit.apply()
MMKV 提供了 importFromSharedPreferences 方法让我们方便进行 SP 数据的迁移,只要提供需要迁移的 SP 实例就能非常快速完成实例。 MMKV 实现了 SharedPreferences,Editor两个接口,所以在迁移之后SP的操作代码可以不用更改。
kotlin
val oldData = getSharedPreferences("test",Context.MODE_PRIVATE)
mmkv.importFromSharedPreferences(oldData)
oldData.edit().clear().apply()