MMKV Versions Save

An efficient, small mobile key-value storage framework developed by WeChat. Works on Android, iOS, macOS, Windows, and POSIX.

v1.3.5

1 week ago

v1.3.5 / 2024-04-24

HarmonyOS NEXT

  • This is the first official support of HarmonyOS NEXT.
  • Most things actually work!
  • Checkout the wiki for more.

Flutter

  • Migrate to federated plugins to avoid the iOS rename headache. From now on, no more renaming from mmkv to mmkvflutter is needed.
  • Bump iOS Deployment Target to iOS 12.
  • Bump Android minSdkVersion to 23.

iOS & macOS

  • Avoid using so-called privacy APIs (lstat(), fstat(), NSUserDefaults).
  • Bump iOS Deployment Target to iOS 12.

Android

  • Bump minSdkVersion to 23.
  • Drop armv7 & x86 support.

POSIX

  • Use the embedded libz when libz can not be found.
  • Fix compile error when building with gcc.

Windows

  • Support x64 architecture.

v1.3.4

1 month ago

v1.3.4 / 2024-03-15

Changes for All platforms

  • Make trim() more robust in multi-process mode.

iOS & macOS

  • Support visionOS.

POSIX

  • Fix a compile error on ::unlink().

v1.3.3

3 months ago

v1.3.3 / 2024-01-25

Changes for All platforms

  • Add removeStorage() static method to safely delete underlying files of an MMKV instance.
  • Add protection from a potential crash of a multi-process MMKV loading due to the MMKV file not being valid.
  • Add back the lazy load feature. It was first introduced in v1.2.16. But it was rollbacked in v1.3.0 of potential ANR & file corruption. Now it's clear that the bug was caused by something else, it's time to bring it back.
  • Optimize loading speed by using shared inter-process lock unless there's a need to truncate the file size, which is rare.
  • Make these two lately added features more robust: customizing the initial file size & optimizing write speed when there's only one key inside MMKV.

Android

  • Fix a bug that null is returned when the value is in fact an empty ByteArray.
  • Fix AGP >= 8 package namespace error.
  • Fix the FastNative naming conflict.
  • Upgrade to SDK 34.
  • Upgrade androidx.annotation to v1.7.1.

iOS & macOS

  • On the Xcode 15 build, an App will crash on iOS 14 and below. Previously we have recommended some workarounds (check the v1.3.2 release note for details). Now you can use Xcode 15.1 to fix this issue.
  • Fix a bug that the multi-process mode won't configure correctly. It was introduced in v1.3.2.
  • Fix a macro naming conflict.
  • Avoid using a so-called privacy API when creating temp files.

POSIX

  • Fix a compile error on memcpy().

Golang

  • Fix a compile error when MMKV_DISABLE_CRYPT is on.

v1.3.2

5 months ago

v1.3.2 / 2023-11-20

Among most of the features added in this version, the credit goes to @kaitian521.

Changes for All platforms

  • Add the feature of customizing the initial file size of an MMKV instance.
  • Optimize write speed when there's only one key inside MMKV, the new key is the same as the old one, and MMKV is in SINGLE_PROCESS_MODE.
  • Optimize write speed by overriding from the beginning of the file instead of append in the back, when there's zero key inside MMKV, and MMKV is in SINGLE_PROCESS_MODE.
  • Add the feature of clearAll() with keeping file disk space unchanged, reducing the need to expand file size on later insert & update operations. This feature is off by default, you will have to call it with relative params or newly added methods.
  • Add the feature of comparing values before setting/encoding on the same key.
  • Fix a potential bug that the MMKV file will be invalid state after a successful expansion but a failure zeroFill(), will lead to a crash.
  • Fix a potential crash due to other module/static lib turn-off RTTI, which will cause MMKV to fail to catch std::exception.
  • Fix several potential crashes due to the MMKV file not being valid.

Android

  • Use the -O2 optimization level by default, which will reduce native lib size and improve read/write speed a little bit.
  • Experimantal use @fastNative annotation on enableCompareBeforeCompare() to speed up JNI call.

iOS & macOS

  • Optimize auto-clean logic to reduce lock waiting time.
  • Turn-off mlock() protection in background on iOS 13+. We have verified it on WeChat that the protection is no longer needed from at least iOS 13. Maybe iOS 12 or older is also not needed, but we don't have the chance to verify that because WeChat no longer supports iOS 12.

Known Issue

  • On Xcode 15 build, the App will crash on iOS 14 and below. The bug is introduced by Apple's new linker. The official solutions provided by Apple are either:
    • Drop the support of iOS 14.
    • Add -Wl,-weak_reference_mismatches,weak or -Wl,-ld_classic options to the OTHER_LDFLAGS build setting of Xcode 15. Note that these options are not recognized by older versions of Xcode.
    • Use older versions of Xcode, or wait for Xcode 15.2.

v1.3.1

8 months ago

v1.3.1 / 2023-8-11

This is a hotfix version. It's highly recommended that v1.2.16 & v1.3.0 users upgrade as soon as possible.

Changes for All platforms

  • Fix a critical bug that might cause multi-process MMKV corrupt. This bug was introduced in v1.2.16.
  • Add the ability to filter expired keys on count() & allKeys() methods when auto key expiration is turn on.
  • Reduce the msync() call on newly created MMKV instances.

v1.3.0

10 months ago

v1.3.0 / 2023-06-14

Changes for All platforms

  • Add auto key expiration feature. Note that this is a breaking change, once upgrade to auto expiration, the MMKV file is not valid for older versions of MMKV (v1.2.16 and below) to correctly operate.
  • Rollback the lazy load optimization due to reported ANR issues. It was introduced in v1.2.16.

iOS & macOS

  • Fix a potential memory leak on setting a new value for an existing key.
  • Upgrade min support target to iOS 11 / macOS 10.13 / tvOS 13 / watchOS 4.

Win32

  • Fix a bug that might fail to truncate the file size to a smaller size in some cases.

Flutter

  • The version of MMKV for Flutter is now the same as the MMKV native library.

v1.2.16

1 year ago

v1.2.16 / 2023-04-20

Changes for All platforms

  • Optimization: The actual file content is lazy loaded now, saving time on MMKV instance creation, and avoiding lock waiting when a lot of instances are created at the same time.
  • Fix a bug when restoring a loaded MMKV instance the meta file might mistakenly report corrupted.

Android

  • Optimization: Remove unnecessary binder call on main process instantiation.

Flutter

  • Fix a crash on decoding an empty list.
  • Remove deprecated dependence.
  • Make the script more robust to fix the iOS Flutter plugin name.

Win32

  • Fix a string format bug on the MinGW64 environment.

golang

  • Fix a build error on 32-bit OS.

v1.2.15

1 year ago

v1.2.15 / 2023-01-12

Changes for All platforms

  • Log handler now handles all logs from the very beginning, especially the logs in initialization.
  • Log handler register method is now deprecated. It's integrated with initialize().
  • Fix a bug that lock()/unlock()/try_lock() is not thread-safe.

Flutter

  • Reduce the privacy info needed to obtain android sdkInt, avoid unnecessary risk on Android App Review.

iOS & macOS

  • Fix a compile error on macOS.
  • Fix a bug that some ObjC exceptions are not being caught.
  • Add assert on nil MMKV base path, protect from mis-using MMKV in global variable initialization.
  • Starting from v1.2.15, one must call +[MMKV initializeMMKV:] manually before calling any MMKV methods.

golang

  • Fix a compile error on GCC.

Win32

  • Support CMake project on Windows.

v1.2.14

1 year ago

v1.2.14 / 2022-08-10

Changes for All platforms

  • Fix a bug that MMKV.getXXX() may return invalid results in multi-process mode.

Android

  • Return [] instead of null on empty StringSet from MMKV.decodeStringSet() methods.
  • Upgrade Android Compile & Target SDK to 32.

iOS

  • Protect from the crash in -[MMKV getObject:forKey:] method when the key-value doesn't exist.

v1.2.13

2 years ago

v1.2.13 / 2022-03-30

Android

  • Fix crash on using Ashmem while MMKV_DISABLE_CRYPT macro is defined.

iOS

  • Add ability to retrieve key existece while getting value, aka -[MMKV getXXX:forKey:hasValue:] methods.

POSIX

  • Add ability to retrieve key existece while getting value, aka MMKV::getXXX(key, defaultValue, hasValue) methods.

Win32

  • Add ability to retrieve key existece while getting value, aka MMKV::getXXX(key, defaultValue, hasValue) methods.