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 類別
您可以在共用 KMP 模組的通用來源中,使用 DataStoreFactory
定義 DataStore
類別。將這些類別放入通用來源後,就能在所有目標平台之間共用這些類別。您可以使用 actual
和 expect
宣告建立平台專屬的實作。
建立 DataStore 執行個體
您需要定義如何在每個平台上將 DataStore 物件執行個體化。由於檔案系統 API 不同,因此這是特定平台來源集中的唯一 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"
}
)