README

MMKV——基于 mmap 的高性能通用 key-value 组件
MMKV 是基于 mmap 内存映射的 key-value 组件，底层序列化/反序列化使用 protobuf 实现，性能高，稳定性强。从 2015 年中至今在微信上使用，其性能和稳定性经过了时间的验证。目前已支持 Android / iOS / macOS / Windows / POSIX / HarmonyOS NEXT，并提供实验性的 Kotlin Multiplatform 支持。

 Kotlin Multiplatform 指南

v2.4.3 的 Kotlin Multiplatform 包为实验性功能，目前支持 Android 与 iOS；
后续版本可能调整 API 或产物结构。在共享模块中引入：

kotlin
kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("com.tencent:mmkv-kmp:2.4.3")
        }
    }
}


支持 Android、iosArm64、iosSimulatorArm64 和 iosX64。初始化与打包说明请参考 Kotlin Multiplatform 文档。

 MMKV 源起
在微信客户端的日常运营中，时不时就会爆发特殊文字引起系统的 crash，参考文章，文章里面设计的技术方案是在关键代码前后进行计数器的加减，通过检查计数器的异常，来发现引起闪退的异常文字。在会话列表、会话界面等有大量 cell 的地方，希望新加的计时器不会影响滑动性能；另外这些计数器还要永久存储下来——因为闪退随时可能发生。这就需要一个性能非常高的通用 key-value 存储组件，我们考察了 SharedPreferences、NSUserDefaults、SQLite 等常见组件，发现都没能满足如此苛刻的性能要求。考虑到这个防 crash 方案最主要的诉求还是实时写入，而 mmap 内存映射文件刚好满足这种需求，我们尝试通过它来实现一套 key-value 组件。

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

更详细的设计原理参考 MMKV 原理。

 Android 指南
 安装引入
推荐使用 Maven：

gradle
dependencies {
    implementation 'com.tencent:mmkv:2.4.3'
    // replace "2.4.3" with any available version
}

从 v2.0.0 起, MMKV 去掉了 32-bit 架构的支持、API level 22 及以下的支持, 如有这类需求，请使用 v1.3.x LTS 版本。  
更多安装指引参考 Android Setup。

 快速上手
MMKV 的使用非常简单，所有变更立马生效，无需调用 sync、apply。
在 App 启动时初始化 MMKV，设定 MMKV 的根目录（files/mmkv/），例如在 Application 里：

Java
public void onCreate() {
    super.onCreate();

    String rootDir = MMKV.initialize(this);
    System.out.println("mmkv root: " + rootDir);
    //……
}


MMKV 提供一个全局的实例，可以直接使用：

Java
import com.tencent.mmkv.MMKV;
//……

MMKV kv = MMKV.defaultMMKV();

kv.encode("bool", true);
boolean bValue = kv.decodeBool("bool");

kv.encode("int", Integer.MIN_VALUE);
int iValue = kv.decodeInt("int");

kv.encode("string", "Hello from mmkv");
String str = kv.decodeString("string");

MMKV 支持多进程访问，更详细的用法参考 Android Tutorial。

 性能对比
循环写入随机的int 1k 次，我们有如下性能对比：  
!  
更详细的性能对比参考 Android Benchmark。

 iOS/macOS 指南
 安装引入
推荐使用 CocoaPods：

  1. 安装 CocoaPods；
  2. 打开命令行, cd 到你的项目工程目录, 输入 pod repo update 让 CocoaPods 感知最新的 MMKV 版本；
  3. 打开 Podfile, 添加 pod 'MMKV' 到你的 app target 里面；
  4. 在命令行输入 pod install；
  5. 用 Xcode 打开由 CocoaPods 自动生成的 .xcworkspace 文件；
  6. 添加头文件 import ，就可以愉快地开始你的 MMKV 之旅了。

更多安装指引参考 iOS/macOS Setup。

 快速上手
MMKV 的使用非常简单，无需任何配置，所有变更立马生效，无需调用 synchronize。在 App 启动时初始化 MMKV（设定 MMKV 的根目录），例如在-[MyApp application: didFinishLaunchingWithOptions:]里：

objective-c
- (BOOL)application:(UIApplication )application didFinishLaunchingWithOptions:(NSDictionary )launchOptions {
    // init MMKV in the main thread
    [MMKV initializeMMKV:nil];

    //...
    return YES;
}


MMKV 提供一个全局的实例，可以直接使用：

objec