MMKV-Kotlin 开源项目常见问题解决方案

MMKV-Kotlin 开源项目常见问题解决方案

mmkv-kotlin The Kotlin Multiplatform wrapper for MMKV. 项目地址: https://gitcode.com/gh_mirrors/mm/mmkv-kotlin

MMKV-Kotlin 是 MMKV 的 Kotlin 多平台端口，目前支持 Android、iOS 和 macOS 平台。该项目主要用于数据的持久化存储，使用 Kotlin 语言开发。

1. 项目基础介绍和主要编程语言

MMKV-Kotlin 是一个基于 MMKV 的跨平台解决方案，用于在移动应用中存储键值对数据。MMKV 是由携程开发的一个轻量级、高效的键值存储库，支持 Android 和 iOS 平台。MMKV-Kotlin 使用 Kotlin 语言开发，支持 Kotlin Multiplatform，可以在不同平台间共享代码。

2. 新手在使用这个项目时需要特别注意的3个问题及解决步骤

问题一：如何在项目中引入 MMKV-Kotlin

问题描述： 新手用户不知道如何在项目中引入 MMKV-Kotlin。

解决步骤：

1. 打开项目的 build.gradle.kts 文件。
2. 在 Kotlin Multiplatform Common 依赖中加入以下代码：

   dependencies {
       implementation("com.ctrip.flight.mmkv:mmkv-kotlin:1.2.15")
   }
   

3. 如果是纯 Android 平台，则在 Android 依赖中加入以下代码：

   dependencies {
       implementation("com.ctrip.flight.mmkv:mmkv-kotlin-android:1.2.15")
   }
   

4. 如果是 Kotlin/Native on macOS，则根据芯片类型选择以下代码：

   dependencies {
       // Intel Chip
       implementation("com.ctrip.flight.mmkv:mmkv-kotlin-macosx64:1.2.15")
       // M1&M2 Chip
       implementation("com.ctrip.flight.mmkv:mmkv-kotlin-macosarm64:1.2.15")
   }
   

问题二：如何在 Android 和 iOS 平台上初始化 MMKV

问题描述： 新手用户不清楚如何在 Android 和 iOS 平台上初始化 MMKV。

解决步骤：

1. 对于 Android 平台，在相应的 source set 中引入以下代码：

   import com.ctrip.flight.mmkv.initialize
   
   fun initializeMMKV(context: Context) {
       val rootDir = initialize(context)
       Log.d("MMKV Path", rootDir)
   }
   

2. 对于 iOS 平台，在相应的 source set 中引入以下代码：

   import com.ctrip.flight.mmkv.initialize
   
   fun initializeMMKV(rootDir: String) {
       initialize(rootDir)
       println("MMKV Path: $rootDir")
   }
   

问题三：如何在 macOS 平台上手动添加 MMKV 依赖

问题描述： 在 macOS 平台上，用户需要手动添加 MMKV 依赖。

解决步骤：

1. 在 macOS 平台的 Kotlin/Native 可执行程序项目或直接为 iOS 应用程序项目提供框架的项目中，手动添加 MMKV 和 MMKVCore 的依赖。
2. 在 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"
                   )
               }
           }
       }
   }
   

3. 在 Podfile 中添加 MMKV 的 pod 依赖。

   pod(name: "MMKV", version: "2.0.1")
   

mmkv-kotlin The Kotlin Multiplatform wrapper for MMKV. 项目地址: https://gitcode.com/gh_mirrors/mm/mmkv-kotlin