https://github.com/DylanCaiCoding/MMKV-KTX

The best MMKV utils to ensure type safety. (最好用的 MMKV 工具，可以确保类型安全)
https://github.com/DylanCaiCoding/MMKV-KTX

key-value mmkv

Last synced: 14 days ago
JSON representation

The best MMKV utils to ensure type safety. (最好用的 MMKV 工具，可以确保类型安全)

• Host: GitHub
• URL: https://github.com/DylanCaiCoding/MMKV-KTX
• Owner: DylanCaiCoding
• License: apache-2.0
• Created: 2021-09-24T10:37:57.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-31T13:23:52.000Z (10 months ago)
• Last Synced: 2024-08-01T17:36:22.600Z (3 months ago)
• Topics: key-value, mmkv
• Language: Kotlin
• Homepage:
• Size: 344 KB
• Stars: 158
• Watchers: 1
• Forks: 19
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MMKV-KTX

English | [中文](README_ZH.md)

[![](https://www.jitpack.io/v/DylanCaiCoding/MMKV-KTX.svg)](https://www.jitpack.io/#DylanCaiCoding/MMKV-KTX)

[![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://github.com/DylanCaiCoding/MMKV-KTX/blob/master/LICENSE)

Combined with the features of Kotlin property delegation, it makes [MMKV](https://github.com/Tencent/MMKV) more flexible and easy to use.

## Features

- Automatic initialization of MMKV;

- Use the property name as the key name, eliminating the need to declare a large number of key name constants;

- Can ensure type safety and avoid exceptions caused by inconsistent types or key values;

## Usage

:pencil: **[>> Usage Document <<](https://dylancaicoding.github.io/MMKV-KTX)**

## Get started

Add the following to the `build.gradle` file in the root directory:

```groovy

allprojects {

    repositories {

        //...

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

    }

}

```

Add the dependency in the module's `build.gradle` file:

```groovy

dependencies {

    implementation 'com.github.DylanCaiCoding:MMKV-KTX:1.2.16'

}

```

By having a class inherit from the `MMKVOwner` class, you can use the `by mmkvXXXX()` function to delegate properties to `MMKV`. For example:

```kotlin

object SettingsRepository : MMKVOwner(mmapID = "settings") {

  var isNightMode by mmkvBool()

  var language by mmkvString(default = "zh")

}

```

If you already have a parent class that cannot be inherited from, implement `IMMKVOwner by MMKVOwner(mmapID)`, such as:

```kotlin

object SettingsRepository : BaseRepository(), IMMKVOwner by MMKVOwner(mmapID = "settings") {

  // ...

}

```

Make sure that each `mmapID` is unique to ensure type safety 100%!!!

Setting or getting the value of a property will call the corresponding `encode()` or `decode()` function with the property name as the key name. For example:

```kotlin

if (SettingsRepository.isNightMode) {

  // do some thing

}

SettingsRepository.isNightMode = true

```

Support the following types:

| Function | Default value |

| --------------------| ------ |

| `mmkvInt()` | 0 |

| `mmkvLong()` | 0L |

| `mmkvBool()` | false |

| `mmkvFloat()` | 0f |

| `mmkvDouble()` | 0.0 |

| `mmkvString()` | / |

| `mmkvStringSet()` | / |

| `mmkvBytes()` | / |

| `mmkvParcelable()` | / |

Support using the `mmkvXXXX().asLiveData()` function to delegate the property to `LiveData`, such as:

```kotlin

object SettingRepository : MMKVOwner(mmapID = "settings") {

  val isNightMode by mmkvBool().asLiveData()

}

SettingRepository.isNightMode.observe(this) {

  checkBox.isChecked = it

}

SettingRepository.isNightMode.value = true

```

The `kv` object can be used to delete values or clear the cache, for example:

```kotlin

kv.removeValueForKey(::language.name) // Recommend removing the key after the default value is modified to shorten the assignment operation

kv.clearAll()

```

For more advanced usage, please refer to the [Usage Document](https://dylancaicoding.github.io/MMKV-KTX).

## Update log

[Releases](https://github.com/DylanCaiCoding/MMKV-KTX/releases)

## Other libraries created by the author

| Library | Brief Introduction |

| ------------------------------------------------------------ | ------------------------------------------------------------ |

| [Longan](https://github.com/DylanCaiCoding/Longan) | Perhaps the most user-friendly Kotlin tool library |

| [LoadingStateView](https://github.com/DylanCaiCoding/LoadingStateView) | Deep decoupling of the default page of the title bar or loading, loading failure, no data, etc. |

| [ViewBindingKTX](https://github.com/DylanCaiCoding/ViewBindingKTX) | Most comprehensive ViewBinding tool |

| [Tracker](https://github.com/DylanCaiCoding/Tracker) | Lightweight burrowing framework based on the chain of responsibility burrowing idea of Buzzvideo |

## License

```

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.

```