0Pricing
Android Academy · 课时

Preferences DataStore

以响应式方式存储键值设置

Preferences DataStore 是 CoddyKit 上的免费 Android Academy 课时。 这是第 2 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Android Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Android Academy 课程共包含 4 节课。

偏好设置 DataStore

偏好设置 DataStore 存储简单的键值对，类似于 SharedPreferences，但使用现代异步 API。它不会对整个对象强制执行模式或类型安全。

您可以通过类型化的键访问值。

创建 DataStore

您可以在 Kotlin 文件的顶层使用 preferencesDataStore 属性委托，为每个文件创建一个 DataStore 实例。name 会成为磁盘上的文件名。

import androidx.datastore.preferences.preferencesDataStore
import androidx.datastore.preferences.core.Preferences

val Context.dataStore: DataStore<Preferences> by
    preferencesDataStore(name = "settings")

为何使用顶层委托

该委托可确保在您的进程中，对于该文件名恰好只有一个 DataStore 实例。为同一个文件创建两个实例会抛出错误，因为它们会争用同一份数据。

将其声明为顶层的 Context 扩展，可以使其保持单例。

偏好设置键

每个值都需要一个类型化的键。键既为条目命名，也固定了其类型。辅助函数可以为每种受支持的类型创建键。

import androidx.datastore.preferences.core.stringPreferencesKey
import androidx.datastore.preferences.core.booleanPreferencesKey
import androidx.datastore.preferences.core.intPreferencesKey

val USERNAME = stringPreferencesKey("username")
val DARK_MODE = booleanPreferencesKey("dark_mode")
val LAUNCH_COUNT = intPreferencesKey("launch_count")

支持的键类型

偏好设置 DataStore 支持以下基本键类型：

  • stringPreferencesKey
  • booleanPreferencesKey
  • intPreferencesKey、longPreferencesKey、floatPreferencesKey、doublePreferencesKey
  • stringSetPreferencesKey

在一处定义键

一种常见做法是将所有键集中放入一个 object 中，以便查找和复用，同时避免字符串名称出现拼写错误。

object PrefKeys {
    val USERNAME = stringPreferencesKey("username")
    val DARK_MODE = booleanPreferencesKey("dark_mode")
    val FONT_SIZE = intPreferencesKey("font_size")
}

字符串键与变量名

请注意，字符串参数（例如 "dark_mode"）才是写入磁盘的内容。如果之后重命名它，旧值将无法再访问。Kotlin 的 val 名称仅供您的代码使用。

每个关注点使用一个 DataStore

您可以为不同的关注点创建多个 DataStore，每个实例使用自己的文件名，例如一个“设置”存储区和一个“用户会话”存储区。请将相关的键放在一起。

val Context.settingsStore by preferencesDataStore(name = "settings")
val Context.sessionStore by preferencesDataStore(name = "session")

从界面层访问

虽然该委托依附于 Context，但请不要在可组合函数中直接读取它。请将 DataStore 注入存储库，再向 ViewModel 暴露数据流。这样可以保持界面的可测试性。

简单的存储库结构

将 DataStore 封装在存储库类中，可以提供简洁的 API，并集中定义键和映射逻辑。

class SettingsRepository(private val dataStore: DataStore<Preferences>) {
    val darkMode: Flow<Boolean> = dataStore.data
        .map { it[PrefKeys.DARK_MODE] ?: false }
}

默认值

某个键可能尚不存在，因此读取时会返回 null。映射偏好设置值时，请始终使用 Elvis 运算符 ?: 提供默认值。

val fontSize: Flow<Int> = dataStore.data
    .map { prefs -> prefs[PrefKeys.FONT_SIZE] ?: 14 }

快速检查

请检验您对偏好设置键的理解。

回顾

您已经完成了偏好设置 DataStore 的设置：

  • 通过顶层 preferencesDataStore 委托创建一个实例
  • 使用 stringPreferencesKey、booleanPreferencesKey 等定义类型化的键
  • 将键集中放入一个 object，并在存储库中封装访问逻辑
  • 始终为缺失的键提供默认值

接下来：实际读取和写入这些设置。

常见问题解答

「Preferences DataStore」课时是免费的吗？

是的 — 「Preferences DataStore」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Android Academy 课程的其余内容，请升级到 CoddyKit PRO。 Android Academy 课程共包含 4 节课。

「Preferences DataStore」这节课中我会学到什么？

以响应式方式存储键值设置 你通过在浏览器中直接运行的动手代码来练习 Android Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Android Academy 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Android Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 2 节课，共 4 节。

「Preferences DataStore」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Android Academy 课中编写并运行代码吗？

能。每节 Android Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. DataStore 与 SharedPreferences
  2. Preferences DataStore
  3. 读取和写入设置
  4. Proto DataStore
← 返回 Android Academy