windows_setup_cn

MMKV for Windows

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

Windows 安装指南

基本要求

• MMKV 支持 Windows XP 以上平台；
• MMKV 需使用 Visual Studio 2019 或以上进行编译。

安装引入

• 通过子工程（推荐）

  1. 获取 MMKV 源码:

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

  2. 添加工程 Core/core.vcxproj 到你的项目里；

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

  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 2022 开发，如果你在使用其他版本的 Visual Studio，请修改 MMKV 的工具集与主工程一致，再编译.
  3. 如果你确定不需要加密功能，你可以在Core/MMKVPredef.h 文件中打开宏MMKV_DISABLE_CRYPT，以减小一些二进制大小。

• 通过预先编译好 library

  1. 获取 MMKV 源码:

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

  2. 用 Visual Studio 打开工程 Core/core.vcxproj;

  3. 编译工程 (Release 或 Debug, x86 或 x64);

  4. 打开目标文件夹 (Win32/MMKV/{x64}/Release 或 Win32/MMKV/{x64}/Debug);

  5. 复制静态库 mmkv.lib 以及 PDB 文件 mmkv.pdb 到你的库文件夹;

  6. 复制头文件 include/MMKV 到你的头文件夹;

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

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

  注意：

  1. MMKV 默认使用 MT/MTd 运行时库来编译，如果你发现主工程的配置不一样，请修改 MMKV 的配置再编译;
  2. MMKV 使用 Visual Studio 2022 开发，如果你在使用其他版本的 Visual Studio，请修改 MMKV 的工具集与主工程一致，再编译.
  3. 如果你确定不需要加密功能，你可以在Core/MMKVPredef.h 文件中打开宏MMKV_DISABLE_CRYPT，以减小一些二进制大小。

下一步

• Windows 使用文档