MMKV-KTX

English | 中文

It's easier to use the MMKV without initializing the MMKV and defining the Key value.

Add it in your root build.gradle at the end of repositories:

allprojects {
    repositories {
        // ...
        maven { url 'https://www.jitpack.io' }
    }
}

Add dependencies in your module build.gradle :

dependencies {
    implementation 'com.github.DylanCaiCoding:MMKV-KTX:1.2.11'
}

Create a class to implement the MMKVOwner interface and delegate properties to MMKV with the by mmkvXXXX() method, for example:

object DataRepository : MMKVOwner {
  var isFirstLaunch by mmkvBool(default = true)
  var user by mmkvParcelable<User>()
}

Setting or getting the value of the property calls the corresponding encode or decode method, and the key value is the property name.

The following types are supported：

You can get the kv object in the implementation class of MMKVOwner to delete values or clear all, for example:

kv.removeValueForKey(::user.name)
kv.clearAll()

If different modules/logics need isolated storage, you can override the kv to create your own MMKV instance separately:

object DataRepository : MMKVOwner {
  override val kv: MMKV = MMKV.mmkvWithID("MyID")
}

See the unit test code for the full usage.

Releases

Copyright (C) 2021. Dylan Cai

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.