DataStore 库以异步、一致的方式存储数据 克服了 SharedPreferences 的一些缺点。这个 页面重点介绍如何在 Kotlin Multiplatform (KMP) 项目中创建 DataStore。 如需详细了解 DataStore,请参阅 DataStore 的主要文档和官方示例。
设置依赖项
DataStore 在 1.1.0 及更高版本中支持 KMP。
如需在 KMP 项目中设置 DataStore,请添加制品的依赖项
在您的模块的 build.gradle.kts
文件中添加以下代码:
androidx.datastore:datastore
- DataStore 库androidx.datastore:datastore-preferences
- Preferences DataStore 库
定义 DataStore 类
您可以使用通用函数内的 DataStoreFactory
定义 DataStore
类。
共享 KMP 模块的源文件将这些类放在共同来源中
可以在所有目标平台之间共享。您可以使用
要创建的 actual
和 expect
声明
平台专用实现。
创建 DataStore 实例
您需要定义如何在每个平台上实例化 DataStore 对象。 这是特定平台中唯一需要的 API 部分 源代码集的差异。
常见
// shared/src/androidMain/kotlin/createDataStore.kt
/**
* Gets the singleton DataStore instance, creating it if necessary.
*/
fun createDataStore(producePath: () -> String): DataStore<Preferences> =
PreferenceDataStoreFactory.createWithPath(
produceFile = { producePath().toPath() }
)
internal const val dataStoreFileName = "dice.preferences_pb"
Android
如需创建 DataStore
实例,您需要 Context
以及
文件路径。
// shared/src/androidMain/kotlin/createDataStore.android.kt
fun createDataStore(context: Context): DataStore<Preferences> = createDataStore(
producePath = { context.filesDir.resolve(dataStoreFileName).absolutePath }
)
iOS
要创建 DataStore 实例,您需要一个数据库工厂以及 数据库路径。
// shared/src/iosMain/kotlin/createDataStore.kt
fun createDataStore(): DataStore<Preferences> = createDataStore(
producePath = {
val documentDirectory: NSURL? = NSFileManager.defaultManager.URLForDirectory(
directory = NSDocumentDirectory,
inDomain = NSUserDomainMask,
appropriateForURL = null,
create = false,
error = null,
)
requireNotNull(documentDirectory).path + "/$dataStoreFileName"
}
)