Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ctripcorp/mmkv-kotlin
A Kotlin Multiplatform porting for MMKV.
https://github.com/ctripcorp/mmkv-kotlin
android ios kotlin kotlin-multiplatform kotlin-multiplatform-mobile kotlin-native
Last synced: 8 days ago
JSON representation
A Kotlin Multiplatform porting for MMKV.
- Host: GitHub
- URL: https://github.com/ctripcorp/mmkv-kotlin
- Owner: ctripcorp
- License: apache-2.0
- Created: 2022-04-15T09:30:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T03:15:51.000Z (2 months ago)
- Last Synced: 2024-10-14T04:21:59.462Z (25 days ago)
- Topics: android, ios, kotlin, kotlin-multiplatform, kotlin-multiplatform-mobile, kotlin-native
- Language: Kotlin
- Homepage:
- Size: 206 KB
- Stars: 131
- Watchers: 7
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# MMKV for Kotlin Multiplatform
中文版本请参看[这里](README_CN.md)
MMKV-Kotlin is a porting of [MMKV](https://github.com/Tencent/MMKV) to Kotlin Multiplatform. Currently, Android/iOS/macOS are supported.
## Tutorial
### Installation Via Maven in Gradle
Kotlin Multiplatform Common (kts):
```kotlin
dependencies {
implementation("com.ctrip.flight.mmkv:mmkv-kotlin:1.2.14")
}
```
Current version is based on `Kotlin 2.0.20` and `MMKV 1.3.9`.
Pure Android platform (kts):
```kotlin
dependencies {
implementation("com.ctrip.flight.mmkv:mmkv-kotlin-android:1.2.14")
}
```
Kotlin/Native on macOS：
```kotlin
dependencies {
// Intel Chip
implementation("com.ctrip.flight.mmkv:mmkv-kotlin-macosx64:1.2.14")
// M1&M2 Chip
implementation("com.ctrip.flight.mmkv:mmkv-kotlin-macosarm64:1.2.14")
}
```
Note, if your project is a Kotlin/Native executable program project of macOS, or it supplies a framework to an iOS application project directly, then you need to manually add the dependency of MMKV, and may need to add `linkerOpts` for MMKV and MMKVCore：
```kotlin
kotlin {
macosX64 {
binaries {
// ......
all {
val moduleName = "mmkv_operator"
val mmkvPath = "${buildDir.absolutePath}/cocoapods/synthetic/OSX/$moduleName/build/Release/MMKV"
val mmkvCorePath = "${buildDir.absolutePath}/cocoapods/synthetic/OSX/$moduleName//build/Release/MMKVCore"
linkerOpts += listOf(
"-F$mmkvPath",
"-rpath", mmkvPath,
"-framework", "MMKV",
"-F$mmkvCorePath",
"-rpath", mmkvCorePath,
"-framework", "MMKVCore"
)
}
}
}
cocoapods {
// ......
pod(name = "MMKV") {
version = "1.3.9"
moduleName = "MMKV"
}
}
// ......
}
```
### Initialization and Configure Root Path
You can initialize MMKV when your app or the process initialization. [MMKV-Android](https://github.com/Tencent/MMKV/tree/master/Android/MMKV) initialization API depends on [Context](https://developer.android.com/reference/android/content/Context). So, Android's initialization API is different with iOS.
Android:
```kotlin
import com.ctrip.flight.mmkv.initialize
// In Android source set
fun initializeMMKV(context: Context) {
val rootDir = initialize(context)
Log.d("MMKV Path", rootDir)
}
```
iOS:
```kotlin
import com.ctrip.flight.mmkv.initialize
// In iOS source set
fun initializeMMKV(rootDir: String) {
initialize(rootDir)
println("MMKV Path: $rootDir")
}
```
You also could call [MMKV-Android](https://github.com/Tencent/MMKV/tree/master/Android/MMKV) (Java) or [MMKV-iOS](https://github.com/Tencent/MMKV/tree/master/iOS) (Objective-C) initialization API in your Android or iOS app project.
### CRUD Operations
- MMKV has a **global instance**, you can use it directly:
```kotlin
import com.ctrip.flight.mmkv.defaultMMKV
fun demo() {
val kv = defaultMMKV()
kv.set("Boolean", true)
println("Boolean: ${kv.takeBoolean("Boolean")}")
kv.set("Int", Int.MIN_VALUE)
println("Int: ${kv.takeInt("Int")}")
kv.set("Long", Long.MAX_VALUE)
println("Long: ${kv.takeLong("Long")}")
kv.set("Float", -3.14f)
println("Float: ${kv.takeFloat("Float")}")
kv.set("Double", Double.MIN_VALUE)
println("Double: ${kv.takeDouble("Double")}")
kv.set("String", "Hello from mmkv")
println("String: ${kv.takeString("String")}")
val bytes = byteArrayOf(
'm'.code.toByte(),
'm'.code.toByte(),
'k'.code.toByte(),
'v'.code.toByte(),
)
kv.set("ByteArray", bytes)
println("ByteArray: ${kv.takeByteArray("ByteArray")?.toString()}")
}
```
- **Deleting & Judging (Whether the key is existed):**
```kotlin
kv.removeValueForKey("Boolean")
println("Boolean: ${kv.takeBoolean("Boolean")}")
kv.removeValuesForKeys(listOf("Int", "Long"))
println("allKeys: ${kv.allKeys()}")
val hasBoolean = kv.containsKey("Boolean")
```
- If a different modules/logics need **isolated storage**, you can also create your own MMKV instance separately:
```kotlin
import com.ctrip.flight.mmkv.mmkvWithID
...
val kvWithMyId = mmkvWithID("MyID")
kvWithMyId.set("Boolean", true)
```
- If **multi-process accessing** is needed, you can set `MMKVMode.MULTI_PROCESS` when MMKV initialization:
```kotlin
import com.ctrip.flight.mmkv.mmkvWithID
import com.ctrip.flight.mmkv.MMKVModel
...
val kvMultiProcess = mmkvWithID("InterProcessKV", MMKVModel.MULTI_PROCESS)
kvMultiProcess.set("Boolean", true)
```
## Supported Types
* Supported Kotlin types in Kotlin Multiplatform common source set：
* `Boolean, Int, Long, Float, Double, String, UInt, ULong, ByteArray, Set`
* The following types are additionally supported in the Android source set:
* `Any class that implements Parcelable`
* The following types are additionally supported in the Apple source set:
* `NSDate and any class that implements NSCoding protocol`
## Note
- MMKV-Kotlin currently does not support migrating old data from SharedPreferences and NSUserDefaults.
## License
Distributed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
See [LICENSE](LICENSE.txt) for more information.