第3章：Preferences DataStore与Proto DataStore的区别、数据存储方式与序列化

DataStore 是 Jetpack 提供的轻量级数据存储方案，替代 SharedPreferences。它分为 Preferences DataStore 和 Proto DataStore 两种实现。本章从核心原理出发，对比两者的差异、数据存储方式、序列化机制，并给出实现流程、代码示例、调试要点及常见错误。

3.1 两种 DataStore 的核心差异

3.2 数据存储方式

Preferences DataStore 底层使用 .preferences_pb 文件（Protocol Buffers 格式），但对外暴露简洁的键值 API。写入时先将整个文件反序列化，修改后重新写入磁盘，保证原子性。

Proto DataStore 直接操作 proto 定义的类对象，文件后缀默认为 .pb。序列化由 protobuf 编译器生成的高效二进制编码完成，支持向前/向后兼容。

3.3 序列化内部机制

Preferences DataStore 内部使用 SharedPreferencesMigration 兼容旧数据，但自 1.1.0 版本起完全基于 protobuf。它将所有键值对转换为 protobuf 的 MapField，原型定义大致如下：

// PreferencesDataStore 内部 proto 定义（简化）
message Preferences {
  map<string, Value> values = 1;
}

message Value {
  oneof value {
    int64 integer = 1;
    float float_ = 2;
    bool boolean = 3;
    string string = 4;
    bytes bytes = 5;
    double double = 6;
  }
}

Proto DataStore 则需要开发者自行编写 .proto 文件，例如：

syntax = "proto3";

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

message UserSettings {
  bool notifications_enabled = 1;
  string display_name = 2;
  int32 theme_mode = 3; // 0:light, 1:dark
  repeated string favorite_tags = 4;
}

生成代码后，DataStore 框架自动调用 encode() 和 decode() 方法完成读写。

3.4 实现流程对比

3.5 内联 SVG：DataStore 两种实现原理对比图

3.6 代码示例：Preferences DataStore 完整读写

// 1. 创建委托属性（顶层扩展）
val Context.settingsDataStore by preferencesDataStore(name = "user_settings")

// 2. 定义键
private val KEY_THEME = stringPreferencesKey("theme")
private val KEY_NOTIFICATIONS = booleanPreferencesKey("notifications")

// 3. 写入
suspend fun saveTheme(context: Context, theme: String) {
    context.settingsDataStore.edit { preferences ->
        preferences[KEY_THEME] = theme
    }
}

// 4. 读取（Flow）
val themeFlow: Flow<String> = context.settingsDataStore.data
    .map { preferences ->
        preferences[KEY_THEME] ?: "light"
    }

3.7 代码示例：Proto DataStore 完整读写

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

    override suspend fun readFrom(input: InputStream): UserSettings {
        return UserSettings.parseFrom(input)
    }

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

// 2. 创建委托属性
val Context.userDataStore by dataStore(
    fileName = "user.pb",
    serializer = UserSettingsSerializer
)

// 3. 写入
suspend fun updateDisplayName(context: Context, name: String) {
    context.userDataStore.updateData { currentSettings ->
        currentSettings.toBuilder().setDisplayName(name).build()
    }
}

// 4. 读取
val displayNameFlow: Flow<String> = context.userDataStore.data
    .map { settings ->
        settings.displayName
    }

3.8 调试方法

• 查看存储文件：使用 Device File Explorer 或 adb 拉取文件：adb pull /data/data/包名/datastore/
• Proto DataStore 调试：将 .pb 文件导出后，用 protoc --decode_raw 查看二进制内容。
• Flow 测试：在 ViewModel 中 dataStore.data.first() 获取当前快照；使用 flow.collect 观察变化。

3.9 性能与稳定性优化