中文版本请参看这里
MMKV is an efficient, small, easy-to-use mobile key-value storage framework used in the WeChat application. It's currently available on Android, iOS/macOS, Win32 and POSIX.
MMKV for Android
Features
-
Efficient. MMKV uses mmap to keep memory synced with file, and protobuf to encode/decode values, making the most of Android to achieve best performance.
- Multi-Process concurrency: MMKV supports concurrent read-read and read-write access between processes.
-
Easy-to-use. You can use MMKV as you go. All changes are saved immediately, no
sync, noapplycalls needed. -
Small.
- A handful of files: MMKV contains process locks, encode/decode helpers and mmap logics and nothing more. It's really tidy.
- About 50K in binary size: MMKV adds about 50K per architecture on App size, and much less when zipped (apk).
Getting Started
Installation Via Maven
Add the following lines to build.gradle on your app module:
dependencies {
implementation 'com.tencent:mmkv-static:1.2.10'
// replace "1.2.10" with any available version
}
Starting from v1.2.8, MMKV has been migrated to Maven Central. Older versions (<= v1.2.7) are still available on JCenter.
For other installation options, see Android Setup.
Quick Tutorial
You can use MMKV as you go. All changes are saved immediately, no sync, no apply calls needed.
Setup MMKV on App startup, say your Application class, add these lines:
public void onCreate() {
super.onCreate();
String rootDir = MMKV.initialize(this);
System.out.println("mmkv root: " + rootDir);
//……
}
MMKV has a global instance, that can be used directly:
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 also supports Multi-Process Access. Full tutorials can be found here Android Tutorial.
Performance
Writing random int for 1000 times, we get this chart:
For more benchmark data, please refer to our benchmark.
MMKV for iOS/macOS
Features
-
Efficient. MMKV uses mmap to keep memory synced with file, and protobuf to encode/decode values, making the most of iOS/macOS to achieve best performance.
-
Easy-to-use. You can use MMKV as you go, no configurations needed. All changes are saved immediately, no
synchronizecalls needed. -
Small.
- A handful of files: MMKV contains encode/decode helpers and mmap logics and nothing more. It's really tidy.
- Less than 30K in binary size: MMKV adds less than 30K per architecture on App size, and much less when zipped (ipa).
Getting Started
Installation Via CocoaPods:
- Install CocoaPods;
- Open terminal,
cdto your project directory, runpod repo updateto make CocoaPods aware of the latest available MMKV versions; - Edit your Podfile, add
pod 'MMKV'to your app target; - Run
pod install; - Open the
.xcworkspacefile generated by CocoaPods; - Add
#import <MMKV/MMKV.h>to your source file and we are done.
For other installation options, see iOS/macOS Setup.
Quick Tutorial
You can use MMKV as you go, no configurations needed. All changes are saved immediately, no synchronize calls needed. Setup MMKV on App startup, in your -[MyApp application: didFinishLaunchingWithOptions:], add these lines:
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// init MMKV in the main thread
[MMKV initializeMMKV:nil];
//...
return YES;
}
MMKV has a global instance, that can be used directly:
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 also supports Multi-Process Access. Full tutorials can be found here.
Performance
Writing random int for 10000 times, we get this chart:
For more benchmark data, please refer to our benchmark.
MMKV for Win32
Features
-
Efficient. MMKV uses mmap to keep memory synced with file, and protobuf to encode/decode values, making the most of Windows to achieve best performance.
- Multi-Process concurrency: MMKV supports concurrent read-read and read-write access between processes.
-
Easy-to-use. You can use MMKV as you go. All changes are saved immediately, no
save, nosynccalls needed. -
Small.
- A handful of files: MMKV contains process locks, encode/decode helpers and mmap logics and nothing more. It's really tidy.
- About 10K in binary size: MMKV adds about 10K on application size, and much less when zipped.
Getting Started
Installation Via Source
-
Getting source code from git repository:
git clone https://github.com/Tencent/MMKV.git -
Add
Win32/MMKV/MMKV.vcxprojto your solution; -
Add
MMKVproject to your project's dependencies; -
Add
$(OutDir)includeto your project'sC/C++->General->Additional Include Directories; -
Add
$(OutDir)to your project'sLinker->General->Additional Library Directories; -
Add
MMKV.libto your project'sLinker->Input->Additional Dependencies; -
Add
#include <MMKV/MMKV.h>to your source file and we are done.
note:
- MMKV is compiled with
MT/MTdruntime by default. If your project usesMD/MDd, you should change MMKV's setting to match your project's (C/C++->Code Generation->Runtime Library), or vise versa. - MMKV is developed with Visual Studio 2017, change the
Platform Toolsetif you use a different version of Visual Studio.
For other installation options, see Win32 Setup.
Quick Tutorial
You can use MMKV as you go. All changes are saved immediately, no sync, no save calls needed.
Setup MMKV on App startup, say in your main(), add these lines:
#include <MMKV/MMKV.h>
int main() {
std::wstring rootDir = getYourAppDocumentDir();
MMKV::initializeMMKV(rootDir);
//...
}
MMKV has a global instance, that can be used directly:
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 also supports Multi-Process Access. Full tutorials can be found here Win32 Tutorial.
MMKV for POSIX
Features
-
Efficient. MMKV uses mmap to keep memory synced with file, and protobuf to encode/decode values, making the most of POSIX to achieve best performance.
- Multi-Process concurrency: MMKV supports concurrent read-read and read-write access between processes.
-
Easy-to-use. You can use MMKV as you go. All changes are saved immediately, no
save, nosynccalls needed. -
Small.
- A handful of files: MMKV contains process locks, encode/decode helpers and mmap logics and nothing more. It's really tidy.
- About 7K in binary size: MMKV adds about 7K on application size, and much less when zipped.
Getting Started
Installation Via CMake
-
Getting source code from git repository:
git clone https://github.com/Tencent/MMKV.git -
Edit your
CMakeLists.txt, add those lines:add_subdirectory(mmkv/POSIX/src mmkv) target_link_libraries(MyApp mmkv)
-
Add
#include "MMKV.h"to your source file and we are done.
For other installation options, see POSIX Setup.
Quick Tutorial
You can use MMKV as you go. All changes are saved immediately, no sync, no save calls needed.
Setup MMKV on App startup, say in your main(), add these lines:
#include "MMKV.h"
int main() {
std::string rootDir = getYourAppDocumentDir();
MMKV::initializeMMKV(rootDir);
//...
}
MMKV has a global instance, that can be used directly:
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 also supports Multi-Process Access. Full tutorials can be found here POSIX Tutorial.
License
MMKV is published under the BSD 3-Clause license. For details check out the LICENSE.TXT.
Change Log
Check out the CHANGELOG.md for details of change history.
Contributing
If you are interested in contributing, check out the CONTRIBUTING.md, also join our Tencent OpenSource Plan.
To give clarity of what is expected of our members, MMKV has adopted the code of conduct defined by the Contributor Covenant, which is widely used. And we think it articulates our values well. For more, check out the Code of Conduct.
FAQ & Feedback
Check out the FAQ first. Should there be any questions, don't hesitate to create issues.
47 Nov 3, 2022
3k Jan 3, 2023
620 Dec 3, 2022
1 Nov 27, 2021
231 Dec 29, 2022
15 Sep 23, 2022
1 Dec 11, 2021
27 May 12, 2022
3 Sep 29, 2022
67 Aug 7, 2022
3 Aug 21, 2022
94 Dec 31, 2022
9.6k Jan 8, 2023
252 Nov 4, 2022
3 Feb 10, 2022
12 Feb 26, 2021
3.3k Dec 29, 2022
119 Dec 21, 2022
937 Dec 20, 2022