MMKVCore 1.3.9

MMKVCore 1.3.9

×

由lingol 维护。

MMKVCore 1.3.9

  • 由
  • guoling

license PRs Welcome Release Version Platform

中文版本请参阅这里

MMKV 是一个在微信应用中使用的高效、小、：易用的 移动端键值存储框架。它目前可在 Android、iOS/macOS、Win32 和 POSIX 上使用。

MMKV for Android

特点

  • 高效。MMKV 使用 mmap 将内存与文件同步，并使用 protobuf 进行值的编解码，充分利用了 Android 的性能。

    • 多进程并发：MMKV 支持进程间的并发读读和读写访问。

  • 易用。您可以直接使用 MMKV。所有更改都会立即保存，无需 sync 或 apply 调用。

  • 小巧.

    • 少数文件：MMKV 包含进程锁、编解码辅助程序和 mmap 逻辑，以及其他内容。它非常整洁。
    • 约 50K 字节的二进制大小：MMKV 每个架构添加约 50K 的应用程序大小，而压缩（APK）时更小。

入门

Maven方式安装

在你的应用模块的build.gradle文件中添加以下行

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

有关其他安装选项，请参阅Android安装。

快速教程

你可以边用边学MMKV。所有更改都会立即保存，无需sync或任何apply调用。
在应用启动时设置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教程中找到。

性能

随机写入int 1000次，我们得到以下图表

有关更多基准数据，请参阅我们的基准。

MMKV for iOS/macOS

特性

  • 高效. MMKV 使用 mmap 保持内存与文件的同步，并使用 protobuf 进行值的编码和解码，充分发挥了 iOS/macOS 的优势，实现了最佳性能。

  • 易于使用. 您可以像使用其他功能一样使用 MMKV，无需配置。所有更改都会立即保存，无需调用 synchronize。

  • 小巧.

    • 文件数量少：MMKV 包含编码/解码助手和 mmap 逻辑，没有其他任何东西。它非常整洁。
    • 二进制大小不到 30K：MMKV 每个架构在 App 大小上的增加不到 30K，在打包（IPA）时会更小。

入门

通过 CocoaPods 安装

  1. 安装 CocoaPods;
  2. 打开终端，cd 到项目目录，运行 pod repo update 使 CocoaPods 了解最新的 MMKV 版本；
  3. 编辑 Podfile，在应用目标中添加 pod 'MMKV'；
  4. 运行 pod install；
  5. 打开 CocoaPods 生成的 .xcworkspace 文件；
  6. 将 #import <MMKV/MMKV.h> 添加到源文件，完成。

有关其他安装选项，请参阅iOS/macOS 设置。

快速教程

可以使用MMKV一边使用一边操作，无需任何配置。所有更改都会立即保存，无需调用synchronize。

- (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还支持多进程访问。完整的教程可以在这里找到。

性能

随机写入int 10000次，我们得到了这张图表

更多基准测试数据，请参阅我们的基准测试。

MMKV for Win32

特点

  • 高效。MMKV使用mmap来保持内存与文件同步，并使用protobuf进行值编码/解码，以充分利用Windows来获得最佳性能。

    • 多进程并发：MMKV 支持进程间的并发读读和读写访问。

  • 易于使用。你可以一边使用MMKV一边操作。所有更改都会立即保存，无需调用save，也无需调用sync。

  • 小巧.

    • 少数文件：MMKV 包含进程锁、编解码辅助程序和 mmap 逻辑，以及其他内容。它非常整洁。
    • 二进制大小约10K：MMKV会在应用大小上增加约10K，如果压缩的话则更少。

入门指南

通过源代码安装

  1. 从git仓库获取源代码

    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> 添加到源文件，我们就可以完成了。

注意

  1. MMKV 默认使用 MT/MTd 运行时进行编译。如果您的项目使用 MD/MDd，则应将 MMKV 的设置更改为与项目匹配（C/C++ -> 代码生成 -> 运行时库），反之亦然。
  2. MMKV 是使用 Visual Studio 2017 开发的，如果您使用不同版本的 Visual Studio，则应更改 平台工具集。

有关其他安装选项，请参阅 Win32 安装。

快速教程

您可以直接使用 MMKV，所有更改都会立即保存，不需要调用 sync 或 save。
在应用启动时设置 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 教程中找到。

MMKV for POSIX

功能

  • 高效。MMKV 使用 mmap 使内存与文件同步，并使用 protobuf 对值进行编码/解码，充分利用 POSIX 以实现最佳性能。

    • 多进程并发：MMKV 支持进程间的并发读读和读写访问。

  • 易于使用。你可以一边使用MMKV一边操作。所有更改都会立即保存，无需调用save，也无需调用sync。

  • 小巧.

    • 少数文件：MMKV 包含进程锁、编解码辅助程序和 mmap 逻辑，以及其他内容。它非常整洁。
    • 二进制大小约 7K：MMKV 在应用大小上增加了约 7K，而在压缩后增加更少。

入门

使用 CMake 进行安装

  1. 从 git 仓库获取源代码

    git clone https://github.com/Tencent/MMKV.git

  2. 编辑您的 CMakeLists.txt 文件，添加以下行

    add_subdirectory(mmkv/POSIX/src mmkv)
target_link_libraries(MyApp
    mmkv)

  3. 将 #include "MMKV.h" 添加到您的源文件，然后完成。

有关其他安装选项，请参阅 POSIX 设置。

快速入门

您可以直接使用 MMKV，所有更改都会立即保存，不需要调用 sync 或 save。
在应用启动时设置 MMKV，例如在 main() 中，添加以下行

#include "MMKV.h"

int main() {
    std::string 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 也支持 多进程访问。完整的教程可以在此找到 POSIX 教程。

许可证

MMKV 使用BSD 3-Clause许可发布。详细信息请查看 LICENSE.TXT。

变更日志

查看变更历史的详细信息请参阅 CHANGELOG.md。

贡献

如果您有兴趣参与贡献，请查看 CONTRIBUTING.md，并加入我们的 腾讯开源计划。

为了明确对成员的期望，MMKV 采用了广泛使用的贡献者协约定义的行为准则，这很好地表达了我们的价值观。更多详情请查看 行为准则。

常见问题及反馈

首先查看 常见问题。如有任何疑问，请随时创建 问题。

个人隐私保护条例

用户隐私受到高度重视：MMKV 不会获取、收集或上传任何个人信息。请参阅 MMKV SDK 个人隐私保护条例 了解详情。