Android Academy · 课时

Proto DataStore

Q: 「Proto DataStore」这节课中我会学到什么？

存储带类型的结构化数据 你通过在浏览器中直接运行的动手代码来练习 Android Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

存储带类型的结构化数据

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

Proto DataStore

Proto DataStore 存储强类型的结构化对象，而不是松散的键值对。您定义一个模式，DataStore 则在每个文件中存储一个类型化对象。

当您的设置构成一个完整统一的模型时，它非常适合。

为何使用类型化数据

偏好设置 DataStore 没有类型约束：键的拼写错误或读取错误的类型，只有在运行时才会失败。Proto DataStore 为整个设置对象提供编译时类型安全。

不再有容易拼错的字符串键
默认值在模式中定义
字段便于重构

选择序列化格式

经典方法使用协议缓冲区（proto）定义模式。您也可以使用 kotlinx.serialization 或任何自定义格式进行序列化。模式描述字段及其类型。

定义 Proto 模式

您需要编写一个 .proto 文件来描述设置消息。protobuf 编译器会根据它生成 Kotlin/Java 类。

syntax = "proto3";

option java_package = "com.example.app";
option java_multiple_files = true;

message UserSettings {
  bool dark_mode = 1;
  int32 font_size = 2;
  string username = 3;
}

实现序列化器

DataStore 需要一个 Serializer，用于将您的类型读写到流中；此外还需要一个在文件为空时使用的 defaultValue。

object UserSettingsSerializer : Serializer<UserSettings> {
    override val defaultValue: UserSettings = UserSettings.getDefaultInstance()

    override suspend fun readFrom(input: InputStream): UserSettings =
        UserSettings.parseFrom(input)

    override suspend fun writeTo(t: UserSettings, output: OutputStream) =
        t.writeTo(output)
}

创建 Proto DataStore

请使用 dataStore 委托（而不是 preferencesDataStore），并传入文件名和您的序列化器。

val Context.settingsStore: DataStore<UserSettings> by dataStore(
    fileName = "user_settings.pb",
    serializer = UserSettingsSerializer
)

读取类型化数据

读取通过 settingsStore.data 进行，但此时数据流的类型就是您的模型。不需要键，也不需要类型转换；直接访问字段即可。

val darkMode: Flow<Boolean> = context.settingsStore.data
    .map { settings -> settings.darkMode }

使用 updateData 写入

Proto DataStore 使用updateData挂起函数替代 edit。您会收到当前对象，并返回一个新对象。使用 protobuf 时，请使用生成的构建器。

suspend fun setDarkMode(enabled: Boolean) {
    context.settingsStore.updateData { current ->
        current.toBuilder()
            .setDarkMode(enabled)
            .build()
    }
}

不可变更新

请注意，您从不修改现有对象，而是构建并返回一个新对象。正是这种不可变性，使更新能够在观察者之间保持事务性和一致性。

处理数据损坏

如果存储的文件变得无法读取，DataStore 会抛出 CorruptionException。您可以提供一个 corruptionHandler，在应用崩溃前返回安全的默认值。

val Context.settingsStore by dataStore(
    fileName = "user_settings.pb",
    serializer = UserSettingsSerializer,
    corruptionHandler = ReplaceFileCorruptionHandler {
        UserSettings.getDefaultInstance()
    }
)

偏好设置与 Proto

请根据您的需求进行选择：

偏好设置：少量互不相关的标志位、设置快捷、无需模式
Proto：结构化的设置模型、类型安全、定义明确的默认值

两者都基于相同的异步、事务性、以 Flow 为基础的架构。

快速检查

请检验您对 Proto DataStore 的理解。

回顾

您已经学会使用 Proto DataStore 存储类型化数据：

定义模式，通常使用协议缓冲区
使用 defaultValue 实现 Serializer
通过 dataStore 委托创建存储区
直接读取字段；使用 updateData 写入
使用返回默认值的处理器处理数据损坏

您已经完成 DataStore 课程。

常见问题解答

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

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

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

存储带类型的结构化数据你通过在浏览器中直接运行的动手代码来练习 Android Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Android Academy 需要有经验吗？

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

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

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

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

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

此课程中的所有课时

← 返回 Android Academy