avatar🐀
霂枯木霂枯木的小站

To witness the sunrise and the sea of blossoms.

行可兼知,而知不可兼行

datastore

介绍 ​

SharePreference的替代方案,基与协程和flow,异步、事务性。包括Preferences DataStore(键值对)和Proto DataStore(类)两种写法,Proto DataStore较复杂,使用少。

存储位置 ​

/data/data/包名/files/datastore/user_settings.preferences_pb

保存数据 ​

kotlin
val Context.dataStore: DataStore<Preferences> by preferencesDataStore(
    name = "settings"
)
kotlin
object SettingsKeys {
    val DARK_MODE = booleanPreferencesKey("dark_mode")
    val USER_NAME = stringPreferencesKey("user_name")
    val FONT_SIZE = intPreferencesKey("font_size")
}
kotlin
suspend fun setDarkMode(
    context: Context,
    enabled: Boolean
){
    context.dataStore.edit {
        prefs->
        prefs[SettingsKeys.DARK_MODE] = enabled
    }
}

读取数据 ​

kotlin
val darkMode: Flow<Boolean> = context.dataStore.data
            .map { preferences -> preferences[SettingsKeys.DARK_MODE] ?: false }
kotlin
suspend fun getUserName(context: Context): String {
    return context.dataStore.data.first()[SettingsKeys.USER_NAME] ?: ""
}

删除数据 ​

kotlin
suspend fun removeUsername(context: Context) {
    context.dataStore.edit { preferences ->
        preferences.remove(SettingsKeys.USER_NAME)
    }
}
kotlin
suspend fun clearAll(context: Context) {
    context.dataStore.edit { it.clear() }
}
SharePreference
API Level对照表
由 Valaxy v1.2.0 驱动|主题-Yunv1.2.0