MMKV——基于 mmap 的高性能通用 key-value 组件

MMKV 是基于 mmap 内存映射的 key-value 组件,底层序列化/反序列化使用 protobuf 实现,性能高,稳定性强。从 2015 年中至今在微信上使用,其性能和稳定性经过了时间的验证。近期也已移植到 Android / macOS / Win32 / POSIX 平台,一并开源。

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:

dependencies {
    implementation 'com.tencent:mmkv-static:1.2.10'
    // replace "1.2.10" with any available version
}

从 v1.2.8 起, MMKV 迁移到 Maven Central。老版本 (<= v1.2.7) 仍然在 JCenter。
更多安装指引参考 Android Setup

快速上手

MMKV 的使用非常简单,所有变更立马生效,无需调用 syncapply。 在 App 启动时初始化 MMKV,设定 MMKV 的根目录(files/mmkv/),例如在 Application 里:

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

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

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

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/MMKV.h>,就可以愉快地开始你的 MMKV 之旅了。

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

快速上手

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

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

    //...
    return YES;
}

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

MMKV *mmkv = [MMKV defaultMMKV];
    
[mmkv setBool:YES forKey:@"bool"];
BOOL bValue = [mmkv getBoolForKey:@"bool"];
    
[mmkv setInt32:-1024 forKey:@"int32"];
int32_t iValue = [mmkv getInt32ForKey:@"int32"];
    
[mmkv setString:@"hello, mmkv" forKey:@"string"];
NSString *str = [mmkv getStringForKey:@"string"];

MMKV 支持多进程访问,更详细的用法参考 iOS/macOS Tutorial

性能对比

循环写入随机的int 1w 次,我们有如下性能对比:

更详细的性能对比参考 iOS/macOS Benchmark

Win32 指南

安装引入

推荐使用子工程:

  1. 获取 MMKV 源码:

    git clone https://github.com/Tencent/MMKV.git
    
  2. 添加工程 Win32/MMKV/MMKV.vcxproj 到你的项目里;

  3. 设置你的主工程依赖于 MMKV 工程;

  4. 添加目录 $(OutDir)include 到你主工程的 C/C++ -> 常规 -> 附加包含目录;

  5. 添加目录 $(OutDir) 到你主工程的 链接器 -> 常规 -> 附加库目录;

  6. 添加 MMKV.lib 到你主工程的 链接器 -> 输入 -> 附加依赖项;

  7. 添加头文件 #include <MMKV/MMKV.h>,就可以愉快地开始你的 MMKV 之旅了。

注意:

  1. MMKV 默认使用 MT/MTd 运行时库来编译,如果你发现主工程的配置不一样,请修改 MMKV 的配置再编译;
  2. MMKV 使用 Visual Studio 2017 开发,如果你在使用其他版本的 Visual Studio,请修改 MMKV 的工具集与主工程一致,再编译.

更多安装指引参考 Win32 Setup

快速上手

MMKV 的使用非常简单,所有变更立马生效,无需调用 savesync。 在 App 启动时初始化 MMKV,设定 MMKV 的根目录,例如在 main() 里:

#include <MMKV/MMKV.h>

int main() {
    std::wstring rootDir = getYourAppDocumentDir();
    MMKV::initializeMMKV(rootDir);
    //...
}

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

auto mmkv = MMKV::defaultMMKV();

mmkv->set(true, "bool");
std::cout << "bool = " << mmkv->getBool("bool") << std::endl;

mmkv->set(1024, "int32");
std::cout << "int32 = " << mmkv->getInt32("int32") << std::endl;

mmkv->set("Hello, MMKV for Win32", "string");
std::string result;
mmkv->getString("string", result);
std::cout << "string = " << result << std::endl;

MMKV 支持多进程访问,更详细的用法参考 Win32 Tutorial

https://github.com/Tencent/MMKV/blob/master/README_CN.md

------------------越是喧嚣的世界,越需要宁静的思考------------------ 合抱之木,生于毫末;九层之台,起于垒土;千里之行,始于足下。 积土成山,风雨兴焉;积水成渊,蛟龙生焉;积善成德,而神明自得,圣心备焉。故不积跬步,无以至千里;不积小流,无以成江海。骐骥一跃,不能十步;驽马十驾,功在不舍。锲而舍之,朽木不折;锲而不舍,金石可镂。蚓无爪牙之利,筋骨之强,上食埃土,下饮黄泉,用心一也。蟹六跪而二螯,非蛇鳝之穴无可寄托者,用心躁也。
原文地址:https://www.cnblogs.com/feng9exe/p/15243014.html